> ## 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. # Commands > Full reference for all Paubox CLI commands and global options. ## paubox send Send a single HIPAA-compliant email. ```bash theme={null} paubox send --to --subject [options] ``` ### Flags | Flag | Required | Description | | :-------------------- | :-------------------------- | :------------------------------------------------------------------------------------------------ | | `--to ` | Yes | Recipient email address. Repeat for multiple recipients: `--to a@example.com --to b@example.com` | | `--subject ` | Yes | Email subject line | | `--html ` | One of `--html` or `--text` | HTML message body | | `--text ` | One of `--html` or `--text` | Plain-text message body | | `--from ` | No | Sender address. Defaults to `defaultFrom` from config if set. Must be on a verified Paubox domain | | `--attachment ` | No | Path to a file to attach. Repeat for multiple attachments | ### Example ```bash theme={null} paubox send \ --to patient@example.com \ --from provider@yourclinic.com \ --subject "Your appointment summary" \ --html "

See attached for your visit notes.

" \ --attachment ./visit-notes.pdf ``` ### Output ``` ✓ Email sent. Tracking ID: abc123-def456 ``` Add `--json` to get machine-readable output instead of the human-readable success line. Useful for capturing the tracking ID in scripts and CI pipelines. The underlying API call is documented in the [Email API · Messages](/email-api/messages) reference. *** ## paubox status Check the delivery status of a sent message. ```bash theme={null} paubox status ``` ### Example ```bash theme={null} paubox status abc123-def456 ``` ### Output ``` Recipient Status Delivered At Opened Opened At patient@example.com delivered 2026-05-24 09:14 UTC Yes 2026-05-24 09:17 UTC ``` Add `--json` to get machine-readable output. Useful for parsing status in scripts and CI pipelines. The underlying API call is documented in the [Email API · Message receipt](/email-api/message-receipt) reference. *** ## paubox config Manage CLI configuration stored in `~/.config/paubox/config.json`. ```bash theme={null} paubox config ``` ### Subcommands | Subcommand | Description | | :-------------------------------- | :-------------------------------------- | | `paubox config set ` | Set a configuration value | | `paubox config get ` | Print the current value for a key | | `paubox config list` | Print all configuration keys and values | | `paubox config reset` | Remove all configuration values | ### Supported keys | Key | Description | | :------------ | :----------------------------------------------------------------------- | | `defaultFrom` | Default sender address used when `--from` is not passed to `paubox send` | Additional keys may be added in future releases. ### Examples ```bash theme={null} # Set a default sender paubox config set defaultFrom provider@yourclinic.com # Confirm it was saved paubox config get defaultFrom # provider@yourclinic.com # List all config paubox config list # defaultFrom=provider@yourclinic.com # Remove all config paubox config reset ``` `paubox config` stores general settings only. API credentials are managed separately with `paubox auth` and stored in the OS keychain, not in `config.json`. *** ## paubox forms Fetch and submit Paubox Forms from the terminal. These commands hit the public Forms endpoints and do not require `paubox auth login`. ```bash theme={null} paubox forms [options] ``` ### Subcommands | Subcommand | Description | | :--------------------------------------- | :----------------------------------------------------- | | `paubox forms get ` | Fetch a form's metadata | | `paubox forms submit [options]` | Submit a response (and optional attachments) to a form | ### paubox forms get Fetch a form's metadata, including its title, description, and submission count. ```bash theme={null} paubox forms get ``` #### Flags | Flag | Required | Description | | :--------- | :------- | :------------------------------------------------------------------------------- | | `` | Yes | UUID of the form to fetch | | `--json` | No | Return the raw API response object as JSON instead of the human-readable summary | #### Example ```bash theme={null} paubox forms get 550e8400-e29b-41d4-a716-446655440000 ``` #### Output ``` Title: Patient intake Description: Initial visit questionnaire Active: Yes Submission count: 142 Created at: 2026-01-08 14:22 UTC Updated at: 2026-05-19 09:41 UTC ``` Add `--json` to get the raw API response object. Useful when you need the full Form payload, including `form_json`, `form_html`, and `form_css`, for rendering or validation. The underlying API call is documented in the [Forms · Get form metadata](/forms/get-form) reference. ### paubox forms submit Submit a response to a form, optionally with attachments. ```bash theme={null} paubox forms submit [options] ``` #### Flags | Flag | Required | Description | | :--------------------- | :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | | `` | Yes | UUID of the form to submit a response to | | `--data =` | One of `--data` or `--data-file` | Form field as a `key=value` pair. Repeat for multiple fields. Values may contain `=` | | `--data-file ` | One of `--data` or `--data-file` | Path to a JSON file whose top-level string values are used as `form_data`. Merged with `--data`; `--data` takes precedence on key conflicts | | `--attach ` | No | File to include as an attachment. Repeat for multiple attachments. Total request size must not exceed 250 MB | | `--json` | No | Print machine-readable JSON output instead of the human-readable success line | #### Examples Submit with `--data` fields only: ```bash theme={null} paubox forms submit 550e8400-e29b-41d4-a716-446655440000 \ --data "first_name=Jane" \ --data "last_name=Doe" \ --data "email=jane@example.com" ``` Submit from a JSON file: ```bash theme={null} paubox forms submit 550e8400-e29b-41d4-a716-446655440000 --data-file ./fields.json ``` Override individual fields from a JSON file: ```bash theme={null} paubox forms submit 550e8400-e29b-41d4-a716-446655440000 \ --data-file ./base.json \ --data "field=override" ``` Submit with `--data` fields and an attachment: ```bash theme={null} paubox forms submit 550e8400-e29b-41d4-a716-446655440000 \ --data "name=Jane" \ --attach /path/to/signed-consent.pdf ``` #### Output ``` ✓ Form submitted successfully. ``` With `--json`: ```json theme={null} { "status": "ok", "formId": "550e8400-e29b-41d4-a716-446655440000" } ``` Use `--json` when triggering submissions from CI pipelines or other automation that needs to confirm success programmatically. The underlying API call is documented in the [Forms · Submit form response](/forms/submit-form) reference. *** ## Global options These flags work with any command. | Flag | Description | | :---------------- | :------------------------------------------------------------------------------------------- | | `--json` | Output results as JSON instead of human-readable text. Useful for scripting and CI pipelines | | `-q`, `--quiet` | Suppress all non-essential output. Errors are still printed | | `-v`, `--version` | Print the installed CLI version and exit | | `--help` | Print usage information for a command and exit | ### Examples ```bash theme={null} # Check version paubox --version # Get help for a specific command paubox send --help # Quiet mode — only print errors paubox send --to a@example.com --subject "Hi" --text "Hello" --quiet ``` ### Exit codes The CLI exits with `0` on success and a non-zero code on failure. Use this in scripts and CI pipelines to detect errors: ```bash theme={null} paubox send --to patient@example.com --subject "Hi" --text "Hello" || echo "Send failed" ```