create-cli

Design CLI arguments, flags, subcommands, help text, and exit codes.

1|Updated Oct 9, 2018
One-click install
npx skills add https://github.com/Apostolos-Delis/Dotfiles --skill create-cli-apostolos-delis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-cli
Source: https://github.com/Apostolos-Delis/Dotfiles/tree/main/.agents/skills/create-cli
Command: npx skills add https://github.com/Apostolos-Delis/Dotfiles --skill create-cli-apostolos-delis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps users design the user interface and behavior of command-line interfaces (CLIs), ensuring they are intuitive, consistent, and easy to use for both humans and scripts.

Core Features & Use Cases

  • CLI Specification: Define arguments, flags, subcommands, and help text.
  • UX Design: Craft clear output formats, error messages, and exit codes.
  • Use Case: Before implementing a new command-line tool, use this Skill to generate a detailed specification for its arguments, flags, and expected behavior, ensuring a user-friendly design.

Quick Start

Use the create-cli skill to design a command-line interface for a new tool that manages user profiles.

Frequently Asked Questions about create-cli

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

FAQPage Schema
How do I design command-line interface parameters and UX for a new tool?

Designing command-line interface parameters and UX involves defining arguments, flags, subcommands, and help text to ensure the CLI is intuitive. You can generate a detailed specification covering arguments, flags, output formats, error messages, and exit codes before implementation begins.

What's the best way to structure CLI arguments and flags for consistency?

Structuring CLI arguments and flags for consistency requires adhering to established CLI guidelines and best practices. By defining standard subcommands, help text, and expected behaviors upfront, you ensure a user-friendly design that improves discoverability for both humans and scripts.

How do I specify CLI output formats, error messages, and exit codes?

Specifying CLI output formats, error messages, and exit codes is part of crafting the user experience. A well-defined CLI specification documents these elements to provide clear feedback and consistent behavior across different command-line operations.

Can I refactor an existing command-line tool to improve discoverability?

Refactoring an existing command-line tool to improve discoverability is supported by generating a revised CLI specification. This process redesigns the CLI surface, updating arguments, subcommands, and help text to enhance overall consistency and user experience.

When do I need a CLI specification before implementation?

A CLI specification is needed before implementing a new command-line tool to ensure a user-friendly design. Generating this specification upfront defines the expected behavior, arguments, and flags, preventing inconsistent UX patterns during the development phase.