Pingram CLI

Official command-line interface for Pingram. Manage domains, send messages, inspect logs, create extra accounts, and more from your terminal.

Install

Requires Node.js 18+.

npm install -g pingram-cli

Other install options:

# cURL (macOS / Linux)
curl -fsSL https://raw.githubusercontent.com/pingram-io/cli/main/install.sh | bash

# Homebrew
brew install pingram-io/cli/pingram

# PowerShell (Windows)
irm https://raw.githubusercontent.com/pingram-io/cli/main/install.ps1 | iex

Full docs: CLI reference.

Quick start

pingram login
pingram domains list

Get your API key and region (us, eu, or ca) from the API Keys page in the Pingram dashboard. For accounts create, log in with a personal access token from Security (pingram_pat_…), not an account API key.

Authentication

Credentials are resolved in this order:

1. --api-key global flag
2. PINGRAM_API_KEY environment variable
3. Credentials saved by pingram login (API key or personal access token in OS secure storage when available, otherwise a local config file)

Region defaults from login and can be overridden with --region or PINGRAM_REGION.

pingram login
pingram login --key pingram_sk_xxx --region us
pingram login --key pingram_pat_xxx --region us
pingram whoami
pingram logout

pingram login validates your key before saving. pingram whoami reads local config only (no API call).

pingram accounts create requires a personal access token. An account API key returns 403.

Run pingram <group> <command> --help for full flags on any command.

Global flags

• --api-key <key> — override stored credentials
• --region <us|eu|ca> — API region
• --json — force JSON output (default when stdout is not a TTY)

Commands

| Group | Commands | | ---------- | ------------------------------------------------------------------------------------------------ | | accounts | list, create --name [--member-emails] [--plan] | | domains | list, add <sender>, start-verification <sender>, delete <sender> | | email | send --type --to --subject --html | | sms | send --type --to [--message] | | logs | list, tail, get <trackingIds>, retention, query, query-result <queryId> | | usage | get, history --start-date --end-date | | numbers | search --country-code, list, order <phoneNumber>, release <phoneNumber>, list-released | | members | list, remove <userId> | | webhooks | list, create --webhook --events, update <endpointId> --webhook --events, delete <endpointId> |

Full command reference with all flags and examples: pingram.io/docs/reference/cli

Examples

pingram domains list
pingram domains add example.com
pingram accounts list
pingram accounts create --name "Client account" \
  --plan '{"tier":"budget_50","sourceBillingAccountId":"..."}'
pingram usage get
pingram usage history --start-date 2025-01-01 --end-date 2025-06-01
pingram logs tail
pingram logs get <tracking-id>
pingram numbers search --country-code US
pingram webhooks list
pingram webhooks create --webhook https://example.com/webhook --events EMAIL_DELIVERED
pingram email send \
  --type welcome \
  --to [email protected] \
  --subject "Hello" \
  --html "$(cat ./email.html)"
pingram sms send --type otp --to +15551234567 --message "Your code is 123456"