Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

The Paubox CLI is a command-line tool for the Paubox Email API and Paubox Forms. Use it to send encrypted email, check delivery status, fetch and submit forms, and manage configuration directly from your terminal, shell scripts, or CI pipelines — no HTTP client required. 
npm install -g paubox-cli

​
What you can do

  • Send encrypted, HIPAA-compliant email with a single command
  • Check delivery and open status for any sent message
  • Retrieve and submit Paubox Forms responses from the terminal
  • Store API credentials securely in the OS keychain
  • Use --json output for scripting and automation
  • Set a default sender address so you don’t repeat --from on every send

​
Requirements

  • Node.js ≥ 20.12.0 — download at nodejs.org
  • Linux only: libsecret-1-dev is required for OS keychain support. Without it, credentials fall back to ~/.config/paubox/config.json with 0600 permissions.

​
Get started

Quickstart

Install, authenticate, and send your first email in under five minutes.

Installation

Full install guide for macOS, Windows, and Linux.

Authentication

Store and manage API credentials with the CLI.

Commands

Full reference for every command and flag.