Courier CLI

A native binary covering the full . Runs on macOS, Linux, and Windows with no runtime dependencies.

Install

npm
Direct download

npm install -g @trycourier/cli

A postinstall step downloads the binary for your platform. Node.js isn’t needed afterwards.

Download the binary for your platform from GitHub Releases, extract it, and add it to your PATH.

Then set your key from :

export COURIER_API_KEY="YOUR_COURIER_API_KEY"
courier --version

Command structure

courier [resource] <command> [flags...]

Add --help to any command for its flags. Send a notification:

courier send message \
  --message.to '{"user_id": "user_123"}' \
  --message.template "nt_01kx4h2jdafq8bk9aftxak4b40" \
  --message.data '{"commenter": "Sara", "file": "Homepage Redesign"}'

Resources

A colon joins a resource to its sub-resource, so a user’s push tokens live under users:tokens. Run courier --help for the full list.

Resource	Commands
`send`	`message`
`messages`	`list`, `retrieve`, `history`, `content`, `cancel`, `resend`
`profiles`	`create`, `retrieve`, `update`, `replace`, `delete`
`profiles:lists`	`retrieve`, `subscribe`, `delete`
`users:tokens`	`list`, `retrieve`, `add-single`, `add-multiple`, `update`, `delete`
`users:preferences`	`retrieve`, `retrieve-topic`, `update-or-create-topic`, `bulk-update`, `bulk-replace`, `delete-topic`
`users:tenants`	`list`, `add-single`, `add-multiple`, `remove-single`, `remove-all`
`lists`	`list`, `retrieve`, `update`, `delete`, `restore`
`lists:subscriptions`	`list`, `add`, `subscribe`, `subscribe-user`, `unsubscribe-user`
`audiences`	`list`, `retrieve`, `update`, `delete`, `list-members`
`notifications`	`list`, `create`, `retrieve`, `retrieve-content`, `put-content`, `put-element`, `put-locale`, `replace`, `publish`, `list-versions`, `get-metrics`, `archive`
`brands`	`list`, `create`, `retrieve`, `update`, `delete`
`tenants`	`list`, `retrieve`, `update`, `delete`, `list-users`
`tenants:templates`	`list`, `retrieve`, `replace`, `publish`, `delete`
`journeys`	`list`, `create`, `retrieve`, `replace`, `publish`, `invoke`, `cancel`, `list-versions`, `archive`
`journeys:runs`	`list`, `retrieve`, `list-steps`
`journeys:templates`	`list`, `create`, `retrieve`, `retrieve-content`, `put-content`, `put-locale`, `replace`, `publish`, `list-versions`, `archive`
`broadcasts`	`list`, `create`, `retrieve`, `update`, `put-content`, `retrieve-content`, `send`, `schedule`, `cancel`, `duplicate`, `archive`
`bulk`	`create-job`, `add-users`, `run-job`, `retrieve-job`, `list-users`
`digests:schedules`	`list-instances`, `release`
`providers`	`list`, `create`, `retrieve`, `update`, `delete`
`routing-strategies`	`list`, `create`, `retrieve`, `replace`, `list-notifications`, `archive`
`workspace-preferences`	`list`, `create`, `retrieve`, `replace`, `publish`, `archive`
`auth`	`issue-token`

Output

--format sets the shape: auto (default), json, yaml, pretty, raw, explore, or jsonl for streaming. auto is human-readable in terminals and JSON in pipes. --transform filters output with GJSON syntax:

courier messages list --format json --transform "results.#.id"
courier messages list --format json --transform "results.#(status=UNDELIVERABLE)"

Other global flags:

--api-key overrides COURIER_API_KEY for one command.
--base-url points at a custom API URL.
--debug prints the HTTP request and response.

Recipes

carries one command block per task: sending, debugging a delivery, profiles and push tokens, templates, journeys, broadcasts, bulk jobs, pagination, and CI.

Get started

Tools

Install

Command structure

Resources

Output

Recipes

​Install

​Command structure

​Resources

​Output

​Recipes

Install

Command structure

Resources

Output

Recipes