CLI Commands

​

Everyday Commands

brew-cli emails generate --prompt "Welcome email for new signups"   # AI-generate a design
brew-cli emails get zavwOzhfWqE9HvALKd9bw --include html,versions              # read a design
brew-cli emails send zavwOzhfWqE9HvALKd9bw --test --to you@company.com --subject "Preview"
brew-cli contacts upsert --email jane@example.com --first-name Jane
brew-cli contacts search --filter email:contains:@acme.com --limit 20
brew-cli audiences list
brew-cli analytics overview --since 2026-08-01T00:00:00Z
brew-cli sends get VDDDYjldT4wLfJaaqQCoN --include events
brew-cli domains list --sendable-only --json
brew-cli usage                                                      # plan, credits, send quota

​

The Surface

​

Conventions Every Command Shares

• Two output modes. Human-readable in a terminal; exact API JSON when you pass --json or pipe the output. Data goes to stdout, progress to stderr, so pipes stay clean.
• Structured inputs. Simple values are flags. Full request bodies go through --input '<json>' (or --input - to read stdin), and file uploads through --file <path>. Flags win over --input on conflicts, even an explicit empty one, so "" clears a description or sender name. The id in the command line always wins over ids inside a body.
• Unknown input keys fail. --input refuses a top-level key the command wouldn’t send. It exits 2 with a usage error that names the key, suggests a close match (firstname → firstName), and lists the accepted keys. Inputs whose keys are your own data, such as a bare trigger payload or flat contact fields, aren’t checked.
• Safe by default. Irreversible commands (production sends, deletes, trigger fires) ask for confirmation in a terminal and refuse with exit code 4 anywhere else until you pass --yes. Test sends (emails send --test) skip the gate.
• Bounded and interruptible. --timeout <duration> caps a whole command, response body included, and --max-retries <n> controls retries on SDK-backed requests. Raw transport commands make one attempt. Ctrl-C stops a request wherever it is and exits 130. Errors include an idempotencyKey and retryCommand when the request can be replayed. Follow the returned command; image-upload recovery replays only finalization.
• Retry-safe writes. Pass --idempotency-key where the command supports it to make retries replay instead of duplicate.
• Pagination handled. Paginated commands expose --limit, --cursor, and --all where supported. --all follows the cursor and combines the pages.
• Typed errors. Failures print the API’s error envelope with its stable code and the requestId for support.

​

The Escape Hatch

brew-cli api GET '/v1/sends/jpUlHPAzKZIQUxEphr4wP?include=events'

​

Discovery

• brew-cli docs: pointers to this documentation, the OpenAPI spec, and the agent guide.
• brew-cli docs api: the live machine-readable API catalog (GET /v1/help).
• brew-cli docs --agent: a JSON manifest of every command, flag, and safety class, built for AI agents.

​

Need Help?