Generate documentation for all commands
Generate comprehensive documentation for all Mutiro CLI commands.
This command generates documentation in various formats.
The markdown format is recommended as it can be easily rendered by the web service or converted to other formats.
Supported formats:
- markdown: Generate Markdown files (default)
- man: Generate man pages
- rest: Generate reStructuredText
- yaml: Generate YAML for Hugo sites
Examples:
Generate markdown docs in default location
mutiro docs
Generate docs for web service
mutiro docs --output ../../services/web/data/filesystem/docs/cli
Generate man pages
mutiro docs --format man --output ./man
Generate docs in custom directory
mutiro docs --output /path/to/docs
mutiro docs [flags]
Generate markdown docs in default location
Generate docs for web service
Generate man pages
Generate docs in custom directory
| Flag | Type | Description |
|---|---|---|
| -f, --format | string | Documentation format (markdown, man, rest, yaml) (default "markdown") |
| -h, --help | bool | help for docs |
| -o, --output | string | Output directory for documentation (default "./docs/cli") |
| Flag | Type | Description |
|---|---|---|
| --config | string | config file (default is ./.mutiro.yaml in current directory) |
| --debug | bool | debug mode |
| -v, --verbose | bool | verbose output |