Skip to main content

Design Cli Output

Skill Verified Active

Design terminal output for a CLI tool with chalk colors, Unicode glyphs, multiple verbosity levels (human, verbose, quiet, JSON), and consistent voice rules. Covers color palette selection, status indicator design, reporter function architecture, ceremony/narrative output variants, and cross-terminal compatibility. Use when building a new CLI reporter module, adding warm narrative output to an existing tool, standardizing output across multiple commands, or designing machine-readable JSON alongside human-readable text.

Purpose

To guide the creation of well-designed, consistent, and accessible terminal output for command-line tools, enhancing user experience and machine readability.

Features

  • Design color palettes with fallbacks
  • Select Unicode or ASCII status indicators
  • Implement four verbosity levels (default, verbose, quiet, JSON)
  • Define and enforce consistent voice rules
  • Structure output into reusable reporter functions
  • Test output across various terminal environments

Use Cases

  • Building new CLI reporter modules
  • Adding narrative output to existing tools
  • Standardizing output across multiple commands
  • Designing parallel human-readable and JSON output

Non-Goals

  • Designing the CLI commands themselves
  • Implementing the core business logic of the CLI tool
  • Handling error recovery beyond output formatting considerations

Workflow

  1. Define Color Palette
  2. Choose Status Indicators
  3. Design Verbosity Levels
  4. Establish Voice Rules
  5. Implement Reporter Functions
  6. Test Output Across Environments

Practices

  • CLI Output Design
  • Terminal UX
  • Code Style

Prerequisites

  • Node.js (for chalk dependency)
  • Access to a terminal environment for testing

Installation

/plugin install agent-almanac@pjt222-agent-almanac

Quality Score

Verified
98 /100
Analyzed about 21 hours ago

Trust Signals

Last commit1 day ago
Stars14
LicenseMIT
Status
View Source

© 2025 SkillRepo · Find the right skill, skip the noise.