cli-ux-patterns

Apply CLI best practices for error messages, color, progress, and output formatting.

Updated Feb 9, 2026
One-click install
npx skills add https://github.com/eliascoelho911/QAUserSearch --skill cli-ux-patterns-eliascoelho911
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cli-ux-patterns
Source: https://github.com/eliascoelho911/QAUserSearch/tree/main/.agents/skills/cli-ux-patterns
Command: npx skills add https://github.com/eliascoelho911/QAUserSearch --skill cli-ux-patterns-eliascoelho911

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about cli-ux-patterns

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

FAQPage Schema
What are the best practices for writing clear CLI error messages?

Clear CLI error messages require actionable guidelines that help users understand the failure and how to resolve it. This Skill provides patterns for error message formatting, ensuring your command-line interface communicates failures with specific, user-friendly guidance.

How do I format CLI output for both human and machine readability?

Formatting CLI output for human and machine readability involves using progressive disclosure and separating standard output from standard error. This Skill offers output formatting patterns to balance human-readable displays with machine-parseable data streams.

When should I use progress bars and spinners in a command-line application?

Progress bars and spinners should be used in command-line applications during long-running operations to provide clear progress indication. This Skill suggests specific patterns for when and how to implement these indicators to improve user experience.

Does this CLI UX guidance include accessibility considerations for color blindness?

Yes, CLI UX guidance includes accessibility considerations for color blindness and screen readers. This Skill provides semantic color usage patterns to ensure your command-line interface remains readable and accessible to all users.

When should I prompt for user input versus failing with an error in a CLI?

Prompting for user input versus failing with an error in a CLI depends on whether the operation is destructive or requires explicit confirmation. This Skill outlines interactive prompt patterns and confirmation patterns to determine the correct user interaction flow.