CLI Reference¶

Synopsis¶

agents-md-wizard [OPTIONS] > output-file

The TUI renders on stderr. Markdown output is written to stdout. This means piping with > writes only the markdown to the file, with no TUI noise.

Options¶

`--config <path>`¶

Load guidelines from a single YAML file instead of the built-in guidelines.

agents-md-wizard --config my-guidelines.yaml > AGENTS.md

`--dir <path>`¶

Load guidelines from all .yaml / .yml files in a directory. Files are read in alphabetical order and merged.

agents-md-wizard --dir guidelines/ > AGENTS.md

`--config=<path>` / `--dir=<path>`¶

Both options also accept =-joined values:

agents-md-wizard --config=guidelines/code-style.yaml > AGENTS.md

`--help`, `-h`¶

Print usage information and exit.

agents-md-wizard --help

Default behaviour¶

With no options, agents-md-wizard loads the 70+ built-in guidelines that ship with the package, across ten topic sections.

Exit codes¶

Code	Meaning
`0`	Completed normally (including user quitting with `Q` without generating)
`1`	Error loading or validating the config file, or no guidelines found

Crash log¶

If the process crashes unexpectedly, a log is written to /tmp/agents-md-wizard.log. Include this file when reporting issues.