README
¶
AgentMail CLI
The official CLI for the AgentMail API.
Installation
npm install -g agentmail-cli
Setup
export AGENTMAIL_API_KEY=am_us_xxx
Usage
agentmail [resource] <command> [flags...]
# List inboxes
agentmail inboxes list
# Create an inbox
agentmail inboxes create --display-name "My Inbox"
# Send a message
agentmail inboxes:messages send \
--inbox-id inb_xxx \
--to [email protected] \
--subject "Hello" \
--text "Hi there"
# List threads
agentmail inboxes:threads list --inbox-id inb_xxx
Use --help on any command for details.
Global flags
| Flag | Description |
|---|---|
--api-key |
API key (or set AGENTMAIL_API_KEY) |
--format |
Output format: json, yaml, pretty, raw, explore |
--debug |
Enable debug logging |
--help |
Show help |
--version |
Show version |
Documentation
Directories
Click to show internal directories.
Click to hide internal directories.