CLI Tool
The AgentInbox CLI provides a command-line interface for creating inboxes, waiting for emails, and managing your account.
Install from GitHub
The CLI source is available at
agentinbox-in/agentinbox-cli. Install from GitHub until the npm package is published.Installation
Install the CLI globally via npm, or use npx to run it without installing.
bash
npm install -g github:agentinbox-in/agentinbox-clibash
npx github:agentinbox-in/agentinbox-cli <command>Authentication
Set your API key via an environment variable or configure it once with the CLI.
bash
export AGENTINBOX_API_KEY="at_live_..."Commands
The CLI supports all major API operations through intuitive commands.
Inboxes
Inbox commands
# Create an inboxagentinbox inbox create --ttl 3600 # List inboxesagentinbox inbox list # Get an inboxagentinbox inbox get 00000000-0000-4000-8000-000000000001 # Delete an inboxagentinbox inbox delete 00000000-0000-4000-8000-000000000001Messages
Message commands
# List messages in an inboxagentinbox message list 00000000-0000-4000-8000-000000000001 # Get a messageagentinbox message get 00000000-0000-4000-8000-000000000002 # Extract data from a messageagentinbox message extract 00000000-0000-4000-8000-000000000002Waits
Wait commands
# Wait for an OTPagentinbox wait otp 00000000-0000-4000-8000-000000000001 --timeout 120 # Check wait statusagentinbox wait check 00000000-0000-4000-8000-000000000003Sessions
Session commands
# Create a sessionagentinbox session create "signup-flow" # Get session detailsagentinbox session get 00000000-0000-4000-8000-000000000004 --include timeline # Complete a sessionagentinbox session complete 00000000-0000-4000-8000-000000000004Output Formats
Use the global --json flag for machine-readable output.
bash
agentinbox --json inbox list | jq '.data[0].emailAddress'bash
agentinbox inbox create --ttl 3600Format Options
Put global flags before the command, for example
agentinbox --json inbox list.