Skip to main content

Bundles/cli-quality

CLI Quality Audit

cli-quality · v1.1.0 · paid

Evaluates command-line interface quality — command structure, help text, exit codes, error handling, I/O conventions, and distribution readiness.

Command Structure

command-structure · weight 0.3

Help flag produces usage information for every command
ab-000639
critical
Version flag outputs version string
ab-000640
high
Consistent subcommand pattern
ab-000641
high
POSIX-style flag conventions
ab-000642
medium
No hidden or undocumented commands
ab-000643
low
Required vs optional arguments are clear
ab-000644
medium

Input/Output Behavior

io-behavior · weight 0.25

Stdout/stderr separation
ab-000645
critical
Machine-readable output format
ab-000646
high
Stdin/pipe input support
ab-000647
medium
NO_COLOR and TTY detection
ab-000648
medium
Progress indication for long operations
ab-000649
low
Verbosity levels
ab-000650
low

Error Handling & Exit Codes

error-handling · weight 0.25

Correct exit codes
ab-000651
critical
Error messages explain the problem and suggest a fix
ab-000652
high
Missing argument handling
ab-000653
high
Invalid input handling
ab-000654
medium
Signal handling (SIGINT/SIGTERM)
ab-000655
medium
File-not-found produces specific error
ab-000656
low

Configuration & Distribution

config-distribution · weight 0.2

Bin field or entry point is correctly configured
ab-000657
critical
Shebang line is present and correct
ab-000658
high
Configuration file support
ab-000659
medium
Environment variables for sensitive configuration
ab-000660
low
Shell completion support
ab-000661
info
Can be installed and run globally
ab-000662
high