You're viewing v1 docs. The current version is v2.

Every doxa command, with accurate usage and examples.

doxa new#

Scaffold a new documentation project from the Mintlify-style starter template (a docs.json plus example MDX pages).

doxa new my-docs

Options:

  • --name <name> — site name written into docs.json
  • --theme <theme> — starter theme (mint, maple, palm, …)
  • --docs-dir <dir> — output folder (default: docs)
  • --force — overwrite existing files

doxa dev#

Start a local preview of your docs. Inside the monorepo it uses the full Next.js renderer for full fidelity; otherwise it falls back to a lightweight preview.

doxa dev

Options:

  • --port <n> — port to serve on (default: 3000)
  • --lite — force the lightweight preview

doxa agent#

Run the OpenCode-powered AI agent against your local docs. It reads docs.json, edits your .mdx files directly, and keeps navigation consistent. This is a one-shot task runner, not an interactive chat.

doxa agent "Document the authentication flow"

Options:

  • --model <m> — free (default), claude, opus, gpt, or a full provider/model id. claude/opus need ANTHROPIC_API_KEY; gpt needs OPENAI_API_KEY.
  • --retries <n> — retry transient OpenCode stalls/errors (default: 3)
# Higher-quality generation with Claude doxa agent --model claude "Rewrite the quickstart"

doxa models#

List the model aliases (free, claude, opus, …), show which credential each needs, and print the models OpenCode can currently see.

doxa models

doxa broken-links#

Scan every .md/.mdx page and report broken internal links — references to pages that don't exist in docs.json or the docs tree.

doxa broken-links

Example output:

✓ No broken internal links across 5 pages.

doxa openapi-check#

Validate an OpenAPI/Swagger specification (JSON or YAML).

doxa openapi-check ./openapi.yaml

Reports parse errors and confirms the spec is well-formed.

doxa llms#

Generate llms.txt and llms-full.txt for your docs, following the llmstxt.org standard. llms.txt is a curated index of every page grouped by navigation; llms-full.txt concatenates every page's content into one file for LLM ingestion.

doxa llms

Options:

  • --site-url <url> — base URL for absolute links (otherwise links are root-relative)
doxa llms --site-url https://docs.acme.com

The published docs site also serves these live at /llms.txt and /llms-full.txt, so this command is for generating static copies to commit or preview locally.

doxa create#

Create a GitHub repository pre-populated with a starter docs site, then point your dashboard project at it.

doxa create my-org/my-docs

Options:

  • --private — create a private repo
  • --token <token> — GitHub token (otherwise uses $GITHUB_TOKEN or gh auth)
  • --docs-dir <dir> — docs folder in the repo (default: docs)
  • --name <name> — site name

Other commands#

doxa version # print the installed CLI version doxa update # how to update the CLI
Run doxa with no arguments at any time to see the full command list.