Document a CLI tool's commands
Document every CLI command with a one-line description, flags with types and defaults, usage examples, required permissions, and common error messages.
Preview
Copy prompt
Write comprehensive help documentation for [CLI Tool Name] covering all of its commands. For each command: write a one-sentence description of its purpose, list all available flags and options with their types, default values, and whether they are required, provide 2–3 realistic usage examples that show the command being used in real scenarios, note any required environment variables or prerequisite setup steps, and document the most common error messages with their meaning and resolution steps.
More
Documentation
Prompts
