robotomaildocs
HomeAgent skillGet started

CLI

Install and use the Robotomail command-line interface.

Installation

Install the CLI globally via npm:

shell
npm install -g @robotomail/cli

Or use npx to run without installing:

shell
npx @robotomail/cli --help

Authentication

Log in with your API key. The key is stored locally in ~/.config/robotomail/config.json.

shell
robotomail login

Or pass the key directly via environment variable:

shell
export ROBOTOMAIL_API_KEY="rm_your_key_here"

Commands

Account

shell
robotomail account        # Show account info
robotomail account upgrade  # Open upgrade checkout

Mailboxes

shell
robotomail mailbox list                  # List mailboxes
robotomail mailbox create <address>     # Create a mailbox
robotomail mailbox delete <id>          # Delete a mailbox

Messages

shell
robotomail send <mailbox-id> \
  --to [email protected] \
  --subject "Hello" \
  --body "Message body"

robotomail inbox <mailbox-id>           # List recent messages
robotomail read <mailbox-id> <msg-id>   # Read a message

Domains

shell
robotomail domain list                   # List domains
robotomail domain add <domain>          # Register a domain
robotomail domain verify <id>           # Trigger verification
robotomail domain delete <id>           # Remove a domain

Webhooks

shell
robotomail webhook list                  # List webhooks
robotomail webhook create <url>         # Create a webhook
robotomail webhook delete <id>          # Remove a webhook

API Keys

shell
robotomail key list                      # List API keys
robotomail key create                   # Create new key
robotomail key revoke <id>              # Revoke a key

Output format

By default, the CLI outputs human-readable tables. Use --json for machine-readable JSON output:

shell
robotomail mailbox list --json