Documentation
README
CLI Development
Build CLIs that stay actionable in both success and failure paths.
Core Principles
- Avoid dead ends.
- Print next steps when a reasonable next action exists.
- On terminal completion, state that no further action is required.
- Make failures diagnosable.
- Print known state, failed operation, and likely cause.
- Include recovery commands and focused help text.
- Include usage text for argument or syntax errors.
- Keep output minimal and context-efficient.
- Use short defaults.
- Show detail only when requested by flags or when needed to recover from failure.
- Scope help to subcommands.
- Keep root help high-level.
- Put detailed flags, examples, and edge cases in subcommand help.
Command Contract
This is the opening of the README. Read the full README on GitHub.