Skip to content

Latest commit

 

History

History

Design Documentation

See DESIGN.md at the repository root for the design philosophy overview and navigation.

The docs in this directory are prescriptive implementation guides.

New commands and providers must comply with all rules documented here.

Document Domain
output.md Output codecs, status messages, JSON field selection, mutation summaries
exit-codes.md Exit code taxonomy and implementation
safety.md Confirmation prompts, --yes, dry-run, idempotency
errors.md DetailedError structure, converters, in-band JSON errors
pipe-awareness.md TTY detection, --no-color, pipe behavior
agent-mode.md Agent mode detection, behavior changes, opt-out
provider-checklist.md Provider UX compliance (architecture patterns in patterns.md)
help-text.md Command descriptions, examples format
naming.md Resource kinds, file naming, config keys, flags
environment-variables.md Canonical environment variable reference