@inbounter/cli
v0.1.0
Published
Official CLI for Inbounter
Downloads
21
Readme
Inbounter CLI
What is Inbounter?
Inbounter is infrastructure that gives AI agents their own inboxes — email, SMS, and more — with built-in security and smart routing.
- :mailbox_with_mail: Inboxes — Provision dedicated email & SMS inboxes for AI agents
- :shield: Shield Mode — Block spam, phishing, and unwanted messages automatically
- :twisted_rightwards_arrows: Smart Routing — Route inbound messages with filters, AI extraction, and webhooks
- :incoming_envelope: Outbound — Send emails and SMS directly from agent inboxes
- :link: Webhooks — Real-time event notifications for contacts, messages, and more
- :credit_card: Credits — Usage-based billing with auto-replenish
Installation
npm install -g @inbounter/cliRequires Node.js 18 or later.
Authentication
Browser-based login (recommended):
inbounter auth loginThis opens your browser to authenticate and automatically saves credentials to your local config.
Manual login:
inbounter loginYou will be prompted to enter your API key, workspace ID, and API URL interactively.
Verify your credentials:
inbounter auth whoamiCommands
Authentication
| Command | Description |
|---|---|
| inbounter auth login | Authenticate via browser (recommended) |
| inbounter auth logout | Remove stored credentials |
| inbounter auth whoami | Show current credentials |
| inbounter auth upgrade | Link your agent account to an email and password |
| inbounter login | Configure API credentials manually |
| inbounter whoami | Show current configuration and identity |
Config
| Command | Description |
|---|---|
| inbounter config set <key> <value> | Set a config value (apiKey, workspaceId, apiUrl, defaultInbox) |
| inbounter config get <key> | Get a config value |
| inbounter config list | Show all configuration |
Inboxes
| Command | Description |
|---|---|
| inbounter inboxes list | List all inboxes |
| inbounter inboxes get [inbox] | Get inbox details (by email, ID, or default) |
| inbounter inboxes create | Create a new inbox |
| inbounter inboxes update [inbox] | Update an inbox |
| inbounter inboxes delete [inbox] | Delete an inbox |
| inbounter inboxes stats [inbox] | Get inbox statistics |
# Create an inbox with shield mode enabled
inbounter inboxes create --name "support-agent" --type EMAIL --shield
# Create an SMS inbox
inbounter inboxes create --name "notifications" --type SMS
# Get stats for an inbox
inbounter inboxes stats [email protected]Messages
| Command | Description |
|---|---|
| inbounter messages list | List messages (all inboxes or filtered) |
| inbounter messages get <messageId> | Get a specific message |
| inbounter messages search <query> | Search messages across inboxes |
# List messages for a specific inbox
inbounter messages list --inbox [email protected]
# Search messages semantically
inbounter messages search "billing question" --mode semantic
# Keyword search with a limit
inbounter messages search "password reset" --mode keyword --limit 10Threads
| Command | Description |
|---|---|
| inbounter threads list | List threads (all inboxes or filtered) |
| inbounter threads get <threadId> | Get a specific thread with messages |
# List threads for an inbox
inbounter threads list --inbox [email protected]Sending
| Command | Description |
|---|---|
| inbounter send | Send a single email |
| inbounter send:batch | Send a batch of emails from a JSON file |
| inbounter reply <threadId> | Reply to a thread |
# Send an email
inbounter send --to [email protected] --subject "Hello" --markdown "Hi there!"
# Send with CC and BCC
inbounter send --to [email protected] --subject "Update" --text "Hello" --cc "[email protected]" --bcc "[email protected]"
# Send a batch of emails
inbounter send:batch --file ./emails.json
# Reply to a thread
inbounter reply thread_abc123 --markdown "Thanks for reaching out!"Email Providers
| Command | Description |
|---|---|
| inbounter connect gmail | Connect a Gmail account via OAuth |
| inbounter connect outlook | Connect an Outlook account via OAuth |
# Connect your Gmail account
inbounter connect gmail
# Connect your Outlook account
inbounter connect outlookShield Mode
| Command | Description |
|---|---|
| inbounter shield rules | Get shield rules for an inbox |
| inbounter shield update | Update shield rules |
| inbounter shield toggle | Enable or disable shield mode |
| inbounter shield stats | Get shield statistics |
# View shield rules
inbounter shield rules --inbox [email protected]
# Enable shield mode
inbounter shield toggle --enable
# Disable shield mode
inbounter shield toggle --disable
# Update rules from a JSON file
inbounter shield update --rules @rules.jsonWebhooks
| Command | Description |
|---|---|
| inbounter webhooks list | List all webhooks |
| inbounter webhooks create | Create a webhook |
| inbounter webhooks test <webhookId> | Send a test event to a webhook |
# Create a webhook for new messages
inbounter webhooks create --url "https://example.com/webhook" --events "message.received,message.sent"
# Test a webhook
inbounter webhooks test whk_abc123Routes
| Command | Description |
|---|---|
| inbounter routes list | List routes for an inbox |
| inbounter routes create | Create a route |
| inbounter routes add-destination <routeId> | Add a destination to a route |
# List routes
inbounter routes list --inbox [email protected]
# Create a route
inbounter routes create --id "urgent" --name "Urgent Messages" --default
# Add a webhook destination to a route
inbounter routes add-destination urgent --type WEBHOOK --name "Slack Alert" --config '{"url":"https://hooks.slack.com/..."}'Credits
| Command | Description |
|---|---|
| inbounter credits | Get workspace credit balance |
MCP
| Command | Description |
|---|---|
| inbounter mcp config | Print MCP remote server config for your AI agent |
| inbounter mcp stdio | Print MCP stdio config for Claude Desktop / Cursor |
| inbounter mcp test | Test MCP connection to remote server |
# Get MCP config for Claude Desktop
inbounter mcp stdio
# Get MCP remote server config
inbounter mcp config
# Test MCP connection
inbounter mcp testGlobal Options
These flags can be passed to any command to override your saved configuration:
| Flag | Description |
|---|---|
| --api-key <key> | API key (overrides stored config) |
| --workspace-id <id> | Workspace ID (overrides stored config) |
| --api-url <url> | API URL (overrides stored config) |
# Use a specific API key for a single command
inbounter inboxes list --api-key "sk_..."
# Point to a different API server
inbounter messages list --api-url "http://localhost:3000"Documentation
Full API reference and guides at inbounter.com/docs
Contributing
We love PRs!
- Fork the repo and create your branch:
git checkout -b feat/awesome - Add tests and docs
- Open a PR against
main
