Skip to content

neo docs

Print CLI reference documentation as markdown.

Offline, and generated from this binary’s own command tree, so it can never drift from --help. With no arguments it prints the overview; neo docs repo prints one command group; neo docs environment prints a topic. --all prints the whole reference as one document — the form to pipe into a file or a model.

neo docs [OPTIONS] [PATH]...
Option Value Required Default Env Values Description
<PATH> no Command path (repo create) or topic name (environment)
--all no Print the entire reference instead of one page
--out <DIR> no Write one markdown file per page into DIR instead of stdout. Pages carry YAML front matter for static-site generators
--force no Overwrite pages already present in DIR. Without it, --out refuses outright when ANY page it would write is already there — including pages an earlier neo docs --out wrote, which it cannot tell apart from a file that was yours