Inhaltsverzeichnis
CLI/TUI Checklist
Version: 2.1
Scope: Command-line UX, scripting compatibility, and deterministic output.
MUST
- [ ] Exit codes follow conventions (0 success; non-zero failure); errors never return 0
- [ ] stdout is machine-readable when requested; stderr is used for diagnostics
- [ ] Non-interactive mode exists; no blocking prompts unless explicitly requested
- [ ] Config precedence is defined (CLI args > env > config file > defaults)
- [ ] Timeouts are bounded for network/IO; retries are controlled and documented
- [ ] Output is stable (ordering, formatting) to support automation
- [ ] Large inputs are streamed where feasible; avoid unbounded memory growth
SHOULD
- [ ]
--helpand--versionare comprehensive - [ ] Provide
--jsonor similar structured output where appropriate - [ ] Disable color when output is not a TTY (or provide
--no-color)
NICE
- [ ] Completion scripts (bash/zsh/pwsh) if frequently used
- [ ] „dry-run“ mode for destructive operations
Version: 2.1 (Split)
Author: Wolfgang van der Stille
Back to Infrastructure Checklists | Review Checklists
Zuletzt geändert: on 2026/01/08 at 01:50 AM