Run doxloop <command> --help for this same information from the CLI itself. Every command accepts these global options:
| Option | Effect |
|---|---|
--cwd <directory> | Resolve paths and find the project as if started in this directory |
-h, --help | Show help for the command (or general help with no command) |
-v, --version | Show the installed Doxloop version |
Unknown options are rejected with an error naming the command.
init
Create a local documentation project and install the authoring and format skills.
doxloop init <directory> [options]| Option | Effect |
|---|---|
--title <title> | Documentation site title (defaults to a title-cased version of the directory name) |
--source <name=path> | Add a local product source; repeatable |
--reference <url> | Add a documentation design reference; repeatable |
--generator <name> | doxbrix, docusaurus, mkdocs, sphinx, hugo, vitepress, markdoc, nextra, starlight, jekyll, or static (default doxbrix) |
doxloop init my-docs --source product=../my-product --title "My Docs"create
Start an authoring agent that researches configured sources and writes documentation. See Create documentation.
doxloop create [request] [options]Create a new documentation project and start authoring in one command:
doxloop create --source <product-directory> --output <documentation-directory> [request]For example:
doxloop create \
--source . \
--output ../your-product-docs \
"Create documentation for developers adopting this product. Include a quickstart and the main workflows."| Option | Effect |
|---|---|
--source <directory> | Read-only product source for a new documentation project; requires --output |
--output <directory> | New, separate documentation project directory; requires --source |
--agent <name> | codex, claude, or gemini; defaults to the first found on PATH |
--model <name> | Model passed to the selected agent CLI |
--reasoning <level> | Codex only: minimal, low, medium, high, or xhigh |
--reference <url> | Use a documentation design reference; repeatable |
--screenshots | Require application guide screenshots for relevant visible UI workflows |
--no-screenshots | Prevent application screenshot capture for this run |
--print | Print the prepared prompt instead of starting an agent |
Screenshot capture requires the Codex or Claude desktop app and is not supported through the agent CLI workflows. Use --screenshots --print, then submit the prepared prompt in a supported desktop app. See Add guide screenshots.
update
Update documentation after product changes, using the recorded synchronization baseline. See Update documentation.
doxloop update [request] [options]For example:
doxloop update "Document webhook retries and remove the legacy import workflow."Accepts the same options as create.
review
Run a read-only documentation quality review. See Review documentation.
doxloop review [request] [options]Accepts --agent, --model, --reasoning, --reference, and --print. Review is read-only and does not accept screenshot controls.
agent
Install or inspect the project-local Doxloop authoring and format skills.
doxloop agent <setup|status|update> [options]| Action | Effect |
|---|---|
setup | Install missing skills; fails if an installed skill has local changes |
status | List each skill's install path and status: missing, current, or modified |
update | Replace installed skills with the packaged version, even if modified |
| Option | Effect |
|---|---|
--agent <name> | Limit to codex, claude, or gemini |
generator
Install and inspect generator packages.
doxloop generator <action> [generator]| Action | Effect |
|---|---|
list | List every official generator and whether it's installed |
add <generator> | Install that generator's package as a dev dependency |
remove <generator> | Remove an unused generator package (fails if it's the project's current generator) |
info <generator> | Show package, skill, build command, and output directory |
doctor | Verify the current project's selected generator is ready |
See Choose a generator.
capture
Render configured design-reference pages with a managed headless browser and save screenshots and measured styles. See Use a design reference.
doxloop capture [url ...]With no URLs, captures the configured reference pages. URLs must belong to a configured reference's origin.
status
Summarize the project and its validation state.
doxloop status [options]| Option | Effect |
|---|---|
| `--format <text\ | json>` |
Exit code 1 if validation errors remain, otherwise 0.
test
Validate documentation structure, navigation, links, metadata, and code fences.
doxloop test [options]| Option | Effect |
|---|---|
| `--format <text\ | json>` |
Exit code 1 if any error remains; warnings don't affect the exit code.
preview
Run the local documentation preview with live reload.
doxloop preview [options]| Option | Effect |
|---|---|
--host <host> | Listening host (default 127.0.0.1) |
--port <port> | Listening port, 1–65535 (default 4321) |
--open | Open the preview in a browser |
login
Sign in with the Doxbrix device flow, or verify a supplied personal access token. See Publish documentation.
doxloop login [options]| Option | Effect |
|---|---|
--token <token> | Token to verify and store; prefer the device flow or an environment variable |
--api-url <url> | HTTPS API base URL; HTTP is allowed only for localhost |
logout
Remove the locally stored Doxbrix token.
doxloop logoutwhoami
Show the Doxbrix account for the active token.
doxloop whoami [options]| Option | Effect |
|---|---|
--api-url <url> | HTTPS API base URL; HTTP is allowed only for localhost |
deploy
Validate and publish documentation through the public Doxbrix HTTP API. See Publish documentation.
doxloop deploy [options]| Option | Effect |
|---|---|
--dry-run | Validate and summarize without uploading |
--name <name> | Hosted project name (defaults to the project title) |
--slug <slug> | Hosted project slug (defaults to a slugified title) |
--api-url <url> | Override the Doxbrix API base URL |