Quickstart

Install the CLI

Install the Paubox CLI globally with npm:

npm install -g paubox-cli

Verify the install:

paubox --version

For Homebrew (macOS) and Windows (winget) install options, see Installation.

Authenticate

Run auth login and enter your Paubox API credentials when prompted:

paubox auth login

? Paubox API username: your_endpoint_username
? Paubox API key: ********************************
✓ Credentials verified and saved.

Your API key and username are stored securely in your OS keychain. To get credentials, see Authentication.

Send an email

Send your first encrypted email:

paubox send \
  --to patient@example.com \
  --from provider@yourclinic.com \
  --subject "Your appointment summary" \
  --html "<p>Thank you for visiting us today.</p>"

On success, the CLI prints a tracking ID:

✓ Email sent. Tracking ID: abc123-def456

Check delivery status

Pass the tracking ID to paubox status:

paubox status abc123-def456

Recipient              Status      Delivered At          Opened  Opened At
patient@example.com    delivered   2026-05-24 09:14 UTC  Yes     2026-05-24 09:17 UTC

Next steps

Installation: install on other platforms or verify system requirements
Commands: full reference for every command and global option

Paubox CLI

Installation

⌘I

Get started

Email API

Migrate to Paubox

Marketing API

MCP Server

SDKs

CLI

Forms API

Next steps

​Next steps

Next steps