# CLI Design

> Use when designing, building, or reviewing a command-line interface (CLI) tool. Provides a checklist of standard CLI conventions. Do not use for non-CLI applications.

- Skill: `metyatech/cli-design` (Agent Skill, multi-file: 12 files)
- Install (CLI): `npx skillmds@latest add metyatech/cli-design`
- Raw SKILL.md: https://api.skillmd.com/api/skills/metyatech/cli-design/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: metyatech (https://skillmd.com/u/metyatech)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/metyatech/cli-design

---


# CLI design checklist

## Help and version

- A CLI MUST provide `--help` and `-h` flags with clear usage,
  options, and examples. Examples MUST include all required
  parameters.
- A CLI MUST provide `--version` and `-V` flags. The agent MUST
  reserve `-v` for `--verbose`.

## Input and output

- A CLI MUST support stdin/stdout piping and MUST allow output
  redirection (e.g., `--output` for file creation).
- A CLI emitting structured data MUST offer machine-readable
  output (e.g., `--json`).

## Safety and control

- A CLI that modifies or deletes data MUST provide `--dry-run`
  and an explicit bypass flag (`--yes` or `--force`).
- A CLI MUST provide controllable logging (`--quiet`, `--verbose`,
  or `--trace`).
- A CLI MUST use deterministic exit codes: 0 for success,
  non-zero for failure. The agent MUST NOT introduce silent
  fallbacks.
- A CLI MUST implement strictly non-interactive modes for CI/CD
  environments.

## Configuration

- A CLI that consumes JSON configuration MUST define and update a
  JSON Schema and MUST validate configuration on load.
- A CLI MUST support configuration via environment variables for
  sensitive or environment-specific data.

## Interactive prompts

- An interactive prompt MUST provide required context before
  asking. For yes/no prompts, Enter MUST mean "Yes" and "n" MUST
  mean "No".