Generators

Every generator takes a CLI definition and returns a string. None of them write to disk for you.

generateMarkdown

(cliDefinition: Cli) => string

Markdown documentation for the whole CLI: description, options, arguments, and every subcommand that is not hidden. The top heading comes from meta.markdownTitle, or cliName when that is not set.

generateBashAutocompleteScript

(cliDefinition: Cli) => string

Source the result from ~/.bashrc or ~/.bash_profile.

generateZshAutocompleteScript

(cliDefinition: Cli) => string

Source the result from ~/.zshrc.

generateFishAutocompleteScript

(cliDefinition: Cli) => string

Source the result from ~/.config/fish/config.fish.

generatePowerShellAutocompleteScript

(cliDefinition: Cli) => string

Dot-source the result from the file that $profile points at. The script expects the CLI to be reachable as a .ps1 file.

See Markdown docs and completion scripts for a script that writes all of them.