writing-cli-help-and-usage

What problem does it solve?

This Skill helps you generate clear, concise, and user-friendly help text, usage strings, and command documentation for command-line tools, ensuring users can easily understand and operate your software.

Core Features & Use Cases

• Generate --help Output: Produce structured help messages that adhere to common CLI conventions.
• Define Usage Strings: Clearly articulate required arguments, optional arguments, and flags.
• Document Arguments & Flags: Provide descriptions, types, constraints, and default values.
• Create Realistic Examples: Illustrate common command-line scenarios.
• Use Case: You've just finished developing a new command-line tool and need to write its --help output. Use this Skill to generate the documentation based on the command's arguments, flags, and intended functionality.

Quick Start

Use the writing-cli-help-and-usage skill to generate help text for a command named 'deploy' with arguments APP_PATH and options --kubernetes, --lambda, and --vm.