Skills
.Work. You
Rest

CLI Help Text Patterns

Community

Master CLI help text conventions.

Software Engineering#developer tools#documentation#cli#usability#command-line#help text
AuthorHermeticOrmus
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides clear, consistent, and user-friendly help text for command-line interfaces, improving usability and reducing user error.

Core Features & Use Cases

  • Standardized Syntax: Explains POSIX usage line conventions (optional, required, repeatable, mutually exclusive).
  • Option Naming: Details GNU long option rules and common POSIX short option meanings.
  • Formatting Best Practices: Guides on aligning descriptions, documenting defaults, and marking required options.
  • Examples & Environment Variables: Emphasizes the importance of clear examples and documents environment variable usage.
  • Exit Codes: Defines standard exit codes for predictable behavior.
  • Use Case: A developer writing a new CLI tool can use this Skill to ensure their help messages are intuitive and follow established conventions, making the tool easier for others to adopt.

Quick Start

Consult the CLI Help Text Patterns skill for guidance on documenting command-line options and usage.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: CLI Help Text Patterns
Download link: https://github.com/HermeticOrmus/LibreCopy-Claude-Code/archive/main.zip#cli-help-text-patterns

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.