What problem does it solve?
This Skill helps improve the user experience of command-line interfaces by providing best practices for error messages, color usage, progress indication, and output formatting.
Core Features & Use Cases
- Error Message Patterns: Offers guidelines for clear and actionable error messages.
- Color Usage Patterns: Provides semantic color usage to enhance readability and convey status.
- Progress Indication Patterns: Suggests when and how to use progress bars and spinners.
- Interactive Prompt Patterns: Outlines when to prompt for input versus failing with an error.
- Output Formatting Patterns: Offers advice on human-readable versus machine-readable output.
- Verbosity Patterns: Discusses progressive disclosure and quiet mode for different user preferences.
- Confirmation Patterns: Explains when to confirm destructive operations.
- Stdout vs Stderr: Defines best practices for using standard output and standard error.
- Accessibility Considerations: Ensures screen reader friendly and color blindness considerations.
- The 12-Factor CLI Principles: Follows the principles for building great command-line applications.
- References: Provides links to external resources for further reading.
Quick Start
To apply these patterns, review your CLI application and implement the recommended practices for error handling, color usage, and user interaction.