Docsalot CLI (Standalone Scaffold)

This folder is the standalone CLI project kept in the same monorepo as backend/dashboard code.

OpenAPI-first workflow

1. Update openapi/docsalot-cli-v1.yaml
2. Regenerate types:
   • npm run generate:api
3. Implement/update command handlers against generated types

Phase 1 auth commands

# Save dashboard-issued API token
docsalot auth login --token docsa_xxx

# CI-safe token input
echo "$DOCSALOT_API_TOKEN" | docsalot auth login --from-stdin

# Validate saved token
docsalot auth whoami

# Remove local credentials
docsalot auth logout

Run as native docsalot command

Use one of these install paths so you can run docsalot ... directly.

Local developer link (recommended)

cd tools/docsalot-cli
npm install
npm run generate:api
npm run link:global
docsalot --help
docsalot auth whoami --json

Global install from local folder

npm install -g ./tools/docsalot-cli
docsalot --version

First npm publish (manual, no CI)

Prerequisites

# Require Node.js 20+ for CLI build/release workflow
node -v
npm -v

NPM account setup (one-time)

# Create account at https://www.npmjs.com/signup (if needed),
# then authenticate in terminal:
npm login

# Verify the logged-in user
npm whoami

Package preflight

cd tools/docsalot-cli
npm install
npm run generate:api
npm run typecheck
npm run build
npm run publish:dry-run

Publish

cd tools/docsalot-cli
npm publish --access public

Install and verify from npm registry

npm install -g [email protected]
docsalot --version
docsalot --help
docsalot auth whoami --json

Expected:

1. docsalot --version prints 0.1.0
2. docsalot --help prints command usage
3. docsalot auth whoami --json returns auth error when no token is saved

Tarball flow (release-style validation)

cd tools/docsalot-cli
npm install
npm run generate:api
npm run pack:local
npm install -g ./docsalot-0.1.0.tgz
docsalot --version

Local source-only execution (without install)

cd tools/docsalot-cli
npm install
npm run generate:api
npm run typecheck
npm run build
node dist/index.js --help