Skip to content
murkmurk

Completions & man pages

murk ships shell completions and man pages generated directly from its command model, so they never drift from the binary.

Shell completions

Section titled “Shell completions”

The quickest path is to let murk install completions for your shell (name the shell: bash, zsh, fish, elvish, or powershell):

Terminal window
murk completion install zsh

To print a completion script to stdout instead (for a custom location or a system package), use generate:

Terminal window
murk completion generate zsh > ~/.zfunc/_murk

Both are documented in the CLI reference. Pre-generated scripts for every supported shell (bash, zsh, fish, elvish, PowerShell) are committed under docs/completions/ for packagers who want to ship them without running murk.

Man pages

Section titled “Man pages”

Man pages for the root command and every subcommand are committed under docs/man/ in roff format (murk.1, murk-init.1, murk-agent-plan.1, …). Install them where your MANPATH can find them, or read one directly:

Terminal window
man ./docs/man/murk.1

How they stay in sync

Section titled “How they stay in sync”

The completions, man pages, the CLI reference, and the environment variables reference are all produced by murk’s dev-only doc generator:

Terminal window
cargo run --features doc-gen --bin gen-docs

CI runs the same generator with --check and fails if any committed artifact is stale, so a change to the CLI surface can’t merge without regenerating them.