Installation
Homebrew
Script for macOS, Linux, Windows via WSL
-s -- <version> <path> to bash in the command above. The default installation path is ~/.local/bin.
Script for Windows PowerShell
Verify
Authentication
The CLI requires a Loops API key. Get one from Settings > API in Loops. There are two ways to authenticate the CLI.Keyring storage
Store a key locally withloops auth login:
loops auth use <name>— set a stored key as the defaultloops auth list— list stored keys and see which is the default--team <name>on any command — use a specific stored key for that command
Environment variable
SetLOOPS_API_KEY to use a key directly — useful for CI or when keyring storage isn’t available.
Precedence
When multiple keys are available, the CLI resolves them in this order:LOOPS_API_KEYenvironment variable--teamflag- The current default (set via
loops auth use)
Global flags
These flags can be used with any command.| Flag | Short | Description |
|---|---|---|
--debug | Print API request details before sending | |
--output | -o | Output format: text (default) or json |
--team | -t | Team key name to use |
--help | -h | Show help for any command |
Commands
auth
Log in, switch teams, and manage stored API keys.
contacts
Create, update, find, and delete contacts.
events
Send events to trigger automations.
lists
View your mailing lists.
transactional
Send and manage transactional emails.
contact-properties
Create and list contact properties.
completion
Set up shell autocompletion.