CLI

pulsesend is a single binary with no dependencies. It talks to the same API as your code, with the same keys.

Install

On macOS and Linux:

curl -fsSL https://pulse-send.jiordiviera.me/install.sh | sh

The script picks the build for your system (Linux x86_64 or ARM64, macOS Intel or Apple Silicon), checks its SHA-256 checksum, and installs it in ~/.local/bin. Two variables change that:

# A specific version, in another folder
curl -fsSL https://pulse-send.jiordiviera.me/install.sh | PULSESEND_VERSION=0.1.0 PULSESEND_INSTALL_DIR=/usr/local/bin sh

On Windows, download pulsesend-0.1.0-x86_64-pc-windows-gnu.zip, unzip it, and put pulsesend.exe in a folder on your PATH. Check the install:

pulsesend --version

Log in

Create a key in the dashboard under API keys, then:

pulsesend login

The CLI asks for the key without showing it, checks it against the API, and saves it in ~/.config/pulsesend/config.json, readable only by you. pulsesend whoami shows which key is in use and whether it works; pulsesend logout removes it. In CI or scripts, skip login and set the key in the environment instead:

export PULSESEND_API_KEY=ps_live_…

--api-key on any command takes precedence over both.

Use a ps_test_ key while you try things out: emails are recorded but never delivered, and they cost no credits.

Send an email

pulsesend send \
  --from "Acme <hello@acme.com>" \
  --to customer@example.com \
  --subject "Your code is 482910" \
  --text "Your verification code is 482910. It expires in 10 minutes."

The body can come from a file, or from standard input with -:

pulsesend send --from hello@acme.com --to customer@example.com \
  --subject "Your receipt" --html-file receipt.html

render-receipt | pulsesend send --from hello@acme.com --to customer@example.com \
  --subject "Your receipt" --html-file -

Option
`--to`, `--cc`, `--bcc`	Repeat the option or separate addresses with commas
`--html`, `--html-file`, `--text`, `--text-file`	At least one body; files accept `-` for stdin
`--reply-to`	Reply-to address
`--tag`	Repeatable, up to 10
`--header "Name: value"`	Repeatable, up to 20
`--idempotency-key`	Makes retries safe, see Idempotency

The same limits as the API apply, and the sender must be on a verified domain with a live key.

Inspect emails

pulsesend emails list            # the latest 20, newest first
pulsesend emails list --limit 50
pulsesend emails get em_01j9z…

When there are more emails, the list ends with the command for the next page.

JSON output

Add --json to any command to get the raw API response, for scripts and jq:

pulsesend emails list --json | jq -r '.data[] | select(.status == "bounced") | .id'

Errors

Errors print the API’s message, its error code with a link to the docs, and the request id to give support. The command then exits with code 1.

error: Invalid or revoked API key. (401)
  code:    invalid_api_key
  type:    authentication_error
  request: req_01m5b1kzmt4kjqewgxm1x8eq9c
  docs:    https://docs.pulse-send.jiordiviera.me/errors#invalid_api_key

Environment variables

Variable
`PULSESEND_API_KEY`	API key, instead of `pulsesend login`
`PULSESEND_BASE_URL`	API URL, defaults to `https://pulse-send.jiordiviera.me`
`HTTPS_PROXY`, `HTTP_PROXY`	Proxy for outgoing requests

Get started

Sending

Account

Install

Log in

Send an email

Inspect emails

JSON output

Errors

Environment variables

​Install

​Log in

​Send an email

​Inspect emails

​JSON output

​Errors

​Environment variables

Install

Log in

Send an email

Inspect emails

JSON output

Errors

Environment variables