cli-guidelines

Provide structured CLI design guidelines covering help, errors, output, and configuration.

9|Updated Jan 31, 2017
One-click install
npx skills add https://github.com/ssiumha/dots --skill cli-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cli-guidelines
Source: https://github.com/ssiumha/dots/tree/main/prompts/skills/cli-guidelines
Command: npx skills add https://github.com/ssiumha/dots --skill cli-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

CLI Guidelines provide pragmatic, human-centered rules for building maintainable, discoverable, and robust command-line interfaces.

Core Features & Use Cases

  • Design philosophy (human-centered, UNIX conventions, discoverability)
  • Help, usage, and error messaging patterns
  • Interactivity, flags, subcommands, and robustness guidance
  • Real-world CLI patterns and anti-patterns

Quick Start

Request "CLI Guidelines" to align a CLI project with clig.dev-based practices; apply resources for philosophy, help docs, and robustness.

Frequently Asked Questions about cli-guidelines

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

FAQPage Schema
How do I design a CLI tool that follows UNIX conventions and best practices?

CLI design guidelines provide structured rules for building human-centered command-line interfaces. Apply philosophy covering UNIX conventions, discoverability, TTY-aware output, color handling, standard exit statuses, and human-friendly error messaging to create maintainable tools from concept to deployment.

What's the best way to structure flags, subcommands, and arguments in a CLI?

CLI guidelines cover argument and flag design patterns, subcommand organization, and interactivity practices. Reference these standards to enforce consistency across your tool, ensure compatibility with frameworks like argparse, Click, and clap, and improve discoverability for end users.

How do I handle errors and help documentation in command-line tools?

CLI guidelines specify error handling, help messaging, and usage documentation patterns. Structure human-friendly error output, implement discoverable help systems, and format JSON output for machine parsing, creating tools users can understand without external documentation.

Can I apply CLI guidelines to tools built with argparse, Click, or clap?

Yes. CLI guidelines provide framework-agnostic design principles applicable to argparse, Click, and clap implementations. Reference the standards to enforce technical requirements like TTY detection, color handling, exit statuses, and JSON output across any supported framework.

What robustness and configuration practices should I follow for CLI distribution?

CLI guidelines cover robustness, configuration management, and distribution patterns. Apply these practices to handle edge cases, manage configuration files, ensure compatibility across environments, and deploy reliable command-line tools ready for production use.

Why do CLI design inconsistencies matter, and how do I fix them?

Inconsistent CLIs confuse users and reduce discoverability. Guidelines solve this by providing pragmatic, human-centered rules for consistent help systems, error messaging, flag behavior, and subcommand design, making tools maintainable and easier to adopt.