Documentation

Reference

These pages list every command, setting and plugin ASH has. Most are generated from the code by a script under scripts/, and CI fails when a generated page no longer matches the code, so they are current for the branch the site is built from. Each generated page names its generator at the top.

Page	What it lists	Generated by
CLI	every command, subcommand and option, with types, defaults and environment variables	scripts/generate_cli_docs.py
Configuration	every config key, its type, default and allowed values, and where ASH looks for config files	scripts/generate_config_reference.py
Environment variables	every environment variable ASH reads, and where	scripts/generate_env_var_reference.py
Scanners	every scanner, the tool it runs, whether it is on by default, and its options	scripts/generate_scanner_reference.py
Reporters	every reporter, the file it writes, and its options	scripts/generate_reporter_docs.py
Converters	every converter and its options	scripts/generate_converter_reference.py
MCP tools	the MCP server's tools, resources and prompts, with their parameters	scripts/generate_mcp_tool_reference.py
Exit codes	what each exit code means and which wins when several apply	written by hand
Output files	the output directory layout and the results file	written by hand
Coverage by language	which scanners look at which languages and file types	written by hand
Python API	running a scan from Python	written by hand

To regenerate a page after changing the code, run its script with uv run python, for example uv run python scripts/generate_cli_docs.py. The documentation guide explains how the generated pages and the docs checks fit together.