Skip to main content
The Brew CLI (brew-cli) calls Public API v1 from your terminal. Use it to create designs, send and schedule emails, manage contacts and audiences, run automations, and read analytics.

Start Here

Install the CLI, then follow the CLI Quickstart to generate an email and test it in your inbox.
Create the API key at Settings → API. The authentication guide covers brand selection and CI setup.

Scripts and Agents

Output becomes JSON when piped or when you pass --json. Use --all to follow list cursors, --timeout to bound work, and --idempotency-key on supported writes. Destructive commands require confirmation; non-interactive callers use --yes for an authorized action. brew-cli docs --agent describes the installed commands and flags. brew-cli doctor checks reachability, authentication, and differences between that build and the live API. If it can’t check a configured key, it exits 1 with authValid: null. The reason is in reachabilityError when the API is unreachable. It’s in authCheckError when the API answers but the key check fails.

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.

Ask ChatGPT or Claude

Click here to open the Copy page menu at the top of this page, then send the page to ChatGPT, Claude, or your editor.