brief

Design Spec Notes

The source-of-truth design document for this repo is:

• design.md

This docs page exists to point readers at the canonical spec rather than duplicate all of it.

Key Constraints Captured in the Spec

• command names are get, post, put, deprecate, delete, category, tag, and config
• categories are a fixed enum
• config keys are a fixed set
• post and put support positional content or --stdin, but not both
• deprecate is the standard lifecycle path
• delete is exceptional and irreversible
• brief category requires the list subcommand
• filter flags for brief get are valid with <query>, --recent, and --recent-updates
• all JSON result data belongs on stdout; diagnostics belong on stderr

When To Read The Full Spec

Read design.md directly when you need:

• exact command/flag semantics
• JSON shape details
• schema details
• exit-code definitions
• repository layout requirements