# axx docs

> Generate reference documentation from the installed version

Source: https://axx.nimbusxr.us/references/cli/axx-docs/

Generate reference documentation from the installed version

```text
Usage:
  axx docs [command]

Available Commands:
  export      Write generated reference pages (steps, parameter types, error codes, schema) to a directory

Flags:
  -h, --help   help for docs

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
  -v, --verbose count   increase log verbosity (-v, -vv)

Use "axx docs [command] --help" for more information about a command.
```

## axx docs export

Write the reference documentation generated from this binary: one page per
step pack, parameter types, a grep-friendly step index, the error and exit
codes, and the JSON Schemas of axx.yaml and the fixture spec files. The documentation site and the agent skills are built from this output.
It covers the packs compiled into this Axx, whatever the project lists.

```text
Usage:
  axx docs export [flags]

Flags:
      --frontmatter   emit YAML front matter (for the docs site) (default true)
  -h, --help          help for export
  -o, --out string    output directory

Global Flags:
      --compact         print only what matters (auto-enabled for coding agents)
  -c, --config string   path to axx.yaml (default: search upward from the working directory)
      --json            emit machine-readable JSON (stable envelope)
      --no-color        disable colored output
  -v, --verbose count   increase log verbosity (-v, -vv)
```