# axx docs

> Generate reference documentation from the installed version

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

Generate reference documentation from the installed version

```text
Usage:
  axx docs [command]

Available Commands:
  export      Write generated reference pages (packs, 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
pack (its settings, steps, parameter types and agent tools) and an overview of
them, parameter types, a grep-friendly step index, the error and exit codes,
and the JSON Schemas of axx.yaml and the fixture spec files. In a project, it
covers the project's packs, those axx-packs.yaml lists, custom packs included;
elsewhere, the packs compiled into this Axx (the documentation site is built
this way).

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

Flags:
  -D, --define stringArray   set a property for ${sys:name}, e.g. -D local.host=docker
      --frontmatter          emit YAML front matter (for the docs site) (default true)
  -h, --help                 help for export
  -o, --out string           output directory
      --profile string       apply profiles.<name> / axx.<name>.yaml, several comma-separated in order, like watch,ios (env: AXX_PROFILE)
      --set stringArray      set a key of axx.yaml for this run, over its files and profiles, e.g. --set run.workers=1 or --set packs.<pack>.<key>=value

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)
```