docsalot-cli
v0.1.16
Published
Standalone Docsalot CLI scaffold (OpenAPI-first)
Readme
Docsalot CLI
docsalot is the official CLI for docsalot.dev.
It lets you run Docsalot dashboard workflows from your terminal, including:
- authenticating with browser login or API token
- scaffolding local docs for new projects
- creating remote documentation projects on Docsalot
- listing your documentations
- pulling docs to local files
- pushing updates as new versions
- publishing versions
- previewing docs locally
We are actively developing this CLI, and it is currently used by at least 20 agents.
Prerequisites
- Node.js
20+ - npm
- A Docsalot account with access to a team/documentation
Install
npm install -g docsalot-cli
docsalot --versionGetting Started
- Log in from terminal (interactive browser wizard).
docsalot auth login
docsalot auth whoami --json- For CI or non-interactive environments, use token login:
docsalot auth login --token <YOUR_TOKEN>
echo "$DOCSALOT_API_TOKEN" | docsalot auth login --from-stdin- Initialize local docs scaffold (no remote project created yet).
docsalot docs init --name "My Documentation" --out init- Preview locally while editing.
docsalot docs preview --dir init --port 3000- Create remote documentation explicitly when you are ready to publish.
docsalot docs create --name "My Documentation" --subdomain my-documentation- Push local docs to the remote documentation.
docsalot docs push --documentation-id <documentation-id> --dir init --message "Initial import"- Publish the new version.
docsalot docs publish --documentation-id <documentation-id>Bundled CLI docs
The npm package now ships man-file style docs in the man/ directory so agent-friendly docs can be read offline and stay version-matched with the installed CLI.
Bundled agent skill
The npm package also ships a CLI skill at skills/docsalot-cli/.
Install it directly via Docsalot CLI:
docsalot skills installOr install manually with Vercel Skills CLI:
npx skills add ./skills/docsalot-cliSupported Commands
Auth
docsalot auth login
docsalot auth login --token <token>
docsalot auth login --from-stdin
docsalot auth login --no-open
docsalot auth logout
docsalot auth whoami
docsalot auth api-token set --token <token>
docsalot auth api-token set --from-stdin
docsalot auth api-token list
docsalot auth api-token remove [--id <token-id>]Docs
docsalot docs list
docsalot docs init [--name <name>] [--out <dir>]
docsalot docs create --name <name> [--subdomain <subdomain>] [--team-id <team-id>]
docsalot docs pull --documentation-id <documentation-id> [--out <dir>]
docsalot docs push --documentation-id <documentation-id> [--dir <dir>] [--message <msg>]
docsalot docs publish --documentation-id <documentation-id> [--version <n>]
docsalot docs preview [--dir <dir>] [--port <n>] [--host <host>]Skills
docsalot skills install [--path <skill-dir>]Global
docsalot --help
docsalot --version
docsalot <command> --jsonNotes
docs initis local-only and copies the bundledinit-template/template directory as-is into your output directory.docs createis remote-only and returns thedocumentation-idrequired bypush/publish.docs publishwithout--versionpublishes the latest version.- Keep your API token private. Treat it like a password.
Community and Feedback
- Join our Discord: https://discord.gg/Dp6EpTv4BU
- Email feedback and feature requests: [email protected]
- Feedback from agents is more than welcome.
