Docsalot home pagelight logo
  1. CLI
  2. Agent-First Onboarding

Start here if you use Claude Code, Codex, or another coding agent.

In the ideal Docsalot workflow, you do not learn the entire CLI first. You install the CLI, install the Docsalot skill, and then ask your agent what you want done.

​
Quick start

​
1. Install the CLI

npm install -g docsalot-cli
docsalot --version

​
2. Install the Docsalot skill for your coding agent

docsalot skills install

That is the whole onboarding path. After this, your agent can drive the workflow for you.

​
What this setup does

  • Makes the docsalot CLI available on the machine.
  • Installs the Docsalot skill for the detected coding agent.
  • Lets the agent choose the right Docsalot commands for create, pull, preview, push, publish, and migration flows.
  • Keeps manual CLI knowledge optional instead of mandatory.

If the agent needs you to authenticate, confirm a browser login, or choose a documentation ID, it will ask at the right time.

​
Start with these prompts

Use prompts like these with Claude Code or Codex:

use docsalot cli to create a new set of documentation and run a preview

use docsalot cli to push this documentation to remote and publish

use docsalot cli to migrate my existing documentation located at path-to-docs, to docsalot framework and run a preview locally

use docsalot cli to look at my source code changes and create docs for me

use docsalot cli to point this documentation to docs.yourdomain.com, show me the DNS record I need to add, and verify it when DNS is ready

​
Other useful agent requests

  • use docsalot cli to pull the current documentation for this project and run a preview locally
  • use docsalot cli to reorganize my docs navigation and update layout.json
  • use docsalot cli to add API reference pages from this OpenAPI spec and run a preview
  • use docsalot cli to update the docs based on the changes in this PR
  • use docsalot cli to set up GitHub auto-publish for this docs folder
  • use docsalot cli to publish the latest approved version of these docs
  • use docsalot cli to add docs.yourdomain.com as a custom domain for this documentation

​
When you should open the manual pages

Use the manual workflow pages only when:

  • you want to understand the exact commands being run
  • you are scripting CI or automation yourself
  • your coding agent asks you to run a specific command manually
  • you are troubleshooting auth, push, publish, or preview issues

​
Manual pages