cli-help-text

Generate usage strings, option descriptions, and man pages for CLI tools.

Updated Feb 28, 2026
One-click install
npx skills add https://github.com/r3d3y3s79/joseph-skills --skill cli-help-text
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cli-help-text
Source: https://github.com/r3d3y3s79/joseph-skills/tree/main/free/developer/cli-help-text
Command: npx skills add https://github.com/r3d3y3s79/joseph-skills --skill cli-help-text

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you generate clear, consistent, and user-friendly help text for command-line tools, making your software more accessible and easier to use.

Core Features & Use Cases

  • Usage Strings: Define clear syntax for commands, arguments, and options.
  • Option Descriptions: Provide concise explanations for flags and parameters.
  • Man Pages: Structure comprehensive documentation for CLI tools.
  • Use Case: You're building a new command-line application and need to write the --help output. This Skill will guide you in structuring the usage, options, and examples for maximum clarity.

Quick Start

Use the cli-help-text skill to write help text for a file encryption CLI tool.

Frequently Asked Questions about cli-help-text

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate help text for a command-line interface tool?

Generate command-line interface help text by structuring usage strings, option descriptions, and examples for CLI tools. This ensures clear documentation for arguments, flags, and environment variables across various command structures.

What is the best way to structure man pages for command-line applications?

The best way to structure man pages is to comprehensively document usage strings, option descriptions, arguments, and environment variables. This ensures your command-line tool documentation is clear, consistent, and accessible to end users.

Can I generate documentation for git-style subcommands and CLI structures?

Yes, you can generate documentation for git-style subcommands and CLI structures. The skill supports various command-line interface patterns, ensuring clear documentation for single commands, nested subcommands, arguments, and options.

Does this support generating help text for git-style subcommands?

Yes, this supports generating help text for git-style subcommands. It handles various CLI structures including single commands and git-style interfaces, ensuring clear documentation for nested subcommands, arguments, and options.

What should usage strings include for command-line arguments and options?

Usage strings should include clear syntax for commands, arguments, and options. Providing concise explanations for flags and parameters ensures users understand how to interact with the command-line tool effectively.

How do I document environment variables in CLI help text?

Document environment variables in CLI help text by including them alongside usage strings and option descriptions. This provides comprehensive command-line documentation that clarifies configuration behavior for end users.