You can create a complete documentation project without a separate setup command.
Before you begin
You need:
- a product that contains source code;
- Doxloop installed, which requires Node.js 20.12 or later;
- Codex, Claude Code, or Gemini CLI installed and signed in.
cd /path/to/your-productChoose an empty sibling directory for the documentation:
doxloop create \
--source . \
--output ../your-product-docs \
"Create documentation for developers adopting this product. Include a quickstart and the main workflows."Doxloop uses your instruction to guide the audience and scope. It confirms the product and documentation locations, creates the documentation project, finds an available coding agent, and starts authoring.
The authoring agent researches your product and proposes the readers and pages supported by the source. If it needs a decision, answer its combined question once. If the proposal is already correct, confirm it and let the agent continue.
The agent writes the agreed pages and checks the result.
Move into the new documentation project and start the preview:
cd ../your-product-docs
doxloop preview --openhttp://127.0.0.1:4321. Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to stop it.Example first run
The first run begins in the product directory:
$ cd acme-api
$ doxloop create --source . --output ../acme-api-docs "Create documentation for developers integrating Acme API. Include authentication and webhooks."
Welcome to Doxloop
Product source:
/projects/acme-api
Read-only — product files will not be changed or deployed.
Documentation project:
/projects/acme-api-docs
Only this project can be previewed or deployed.
…the authoring agent researches, plans, writes, and checks the docs…
Documentation created successfully.
Pages created: 8
Documentation project: /projects/acme-api-docs
Product source files included in deployment: 0The page count depends on your product and the documentation plan you confirm.