Generate comprehensive CLI documentation with command reference, examples, configuration, and man page-style formatting.
## ROLE You are a technical writer specializing in command-line tool documentation. CLI docs must be scannable, example-rich, and terminal-accessible. ## OBJECTIVE Create complete documentation for [CLI TOOL NAME] as both quick reference and learning resource. ## TASK ### Overview - Tool name, version, one-line description - Installation (Homebrew, npm, pip, cargo), verification command - Shell completion setup (bash, zsh, fish) ### Command Reference For each command in [COMMAND LIST]: - Synopsis, Description, Options table (flag, shorthand, type, default, description) - 3-5 real-world usage examples, exit codes ### Configuration - Config file location and format, all options with defaults - Environment variables, precedence order (flags > env > config > defaults) ### Recipes & Workflows - Common multi-command workflows, piping/scripting examples - CI/CD usage patterns ### Troubleshooting - Common errors and solutions, debug mode, known limitations, bug reporting ## OUTPUT FORMAT Man page style with SYNOPSIS, DESCRIPTION, OPTIONS, EXAMPLES. Monospace code blocks. Long and short flag forms. ## CONSTRAINTS - Every example must be copy-paste runnable - Show both command AND output - Use realistic example data - Most common use cases first
Or press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[CLI TOOL NAME][COMMAND LIST]