Skip to main content
The Brew CLI (brew-cli) is the command-line surface of Brew. Every operation in the Public API v1 has a typed command: create brands, generate and edit email designs with AI, send and schedule, build automations, manage contacts and audiences, verify domains, and read analytics, all from your terminal. Like the MCP server, it is a thin layer over the same API your dashboard uses: the same validation, permissions, credit metering, and rate limits apply everywhere. Anything you can do in the app, you can script.

​
Why It Matters

  • Everything, scriptable: generate a welcome email, send it to a segment, wire an automation, and pull open rates without leaving your terminal. Every Public API operation is covered, and new platform capabilities arrive as CLI updates.
  • Built for agents: JSON output turns on automatically when output is piped, exit codes are semantic, destructive commands never hang waiting for input, and brew-cli docs --agent prints a machine-readable manifest of every command. See Use from AI Agents.
  • Scripts and CI: stable flags, idempotency keys for safe retries, cursor draining with --all, and a raw brew-cli api escape hatch for anything new before a dedicated command ships.

​
Sixty Seconds In

​
What’s Next

  • Installation: Homebrew, prebuilt binaries, or npm.
  • Authentication: API keys, brand scoping, and environments.
  • Commands: what is included and the conventions every command shares.
  • Common Flows: worked sequences for launching, automating, and reporting.
  • Use from AI Agents: the output and exit-code contract agents can rely on.

​
Need Help?

Our team is ready to support you at every step of your journey with Brew. Choose the option that works best for you:

Search Documentation

Type in the “Ask any question” search bar at the top left to instantly find relevant documentation pages.

ChatGPT/Claude Integration

Click “Open in ChatGPT” at the top right of any page to explore it further with ChatGPT or Claude.