@ferrypost/cli

Command-line interface for the Ferry Post messaging API.

Send messages, manage conversations, configure webhooks, and more from your terminal.

Installation

npm install -g @ferrypost/cli

Authentication

Set your API key via environment variable:

export MESSAGING_API_KEY=msgk_live_your_api_key_here

Or save it to a config file:

ferrypost config set apiKey msgk_live_your_api_key_here

The config file is stored at ~/.messaging/config.json.

Usage

# Send a message
ferrypost messages send --conversation-id conv_123 --text "Hello from CLI"

# List conversations
ferrypost conversations list

# Get a specific message
ferrypost messages get msg_456

# Search messages
ferrypost search messages --query "meeting tomorrow"

# List phone numbers
ferrypost phone-numbers list

# Check channel capabilities
ferrypost channels capabilities imessage

Commands

| Group | Commands | |---|---| | messages | send, get, list, edit, unsend, react, unreact | | conversations | list, get, create, update, messages, add-participant, remove-participant | | webhooks | list, get, create, update, delete, test, deliveries, retry-delivery | | scheduled-messages | list, get, create, update, cancel | | phone-numbers | list, get | | opt-outs | list, add | | channels | list, capabilities | | organization | get, members, invite, remove-member | | api-keys | list, create, revoke | | media | upload, get | | search | messages | | analytics | get | | telegram | list, get, start-auth, verify-code, submit-2fa, disconnect, health | | config | set, get, clear | | health | check |

Custom API URL

export MESSAGING_API_URL=https://ferrypost.com

Or in the config file:

ferrypost config set baseUrl https://ferrypost.com

Output

All commands output JSON. Pipe through jq for formatted output:

ferrypost conversations list | jq '.[0]'

Documentation

Full API documentation is available at docs.ferrypost.com.

License

MIT