ChatbotX CLI

Customer Conversation & CRM CLI for Autonomous AI Agents

Manage omnichannel messaging (WhatsApp, Messenger, Instagram, Telegram, Zalo), query CRM contacts, and trigger automated flows from the terminal. JSON stdout, POSIX exit codes, zero LLM tokens.

Please make sure there is always a human in the loop.

Get Started in Seconds

Install via Skills CLI, ClawHub, or npm, then authenticate with your Workspace Token.

Skills CLI
Recommended for AI Agents
# Install via Skills CLI (recommended)
$ npx skills add ChatbotXIO/ChatbotX --skill chatbotx-cli
✓ chatbotx-cli installed

# Or install from ClawHub
$ clawhub install chatbotx-cli
✓ chatbotx-cli installed from ClawHub
npx skills add ChatbotXIO/ChatbotX --skill chatbotx-cli

Built for Automation

Every command prints structured JSON to stdout with POSIX exit codes. Pipe, parse, and automate with zero friction.

AI Agent Ready

Every command prints structured JSON to stdout with POSIX exit codes (exit 0/1). Optimized for LLM tool-calling, shell scripts, and autonomous agents.

Omnichannel Reach

Send and receive messages across WhatsApp, Messenger, Instagram, Telegram, and Zalo from a single CLI. One tool, every channel.

Full Workspace API Coverage

Look up contacts by id:, email:, or phone:. Manage custom fields, tags, notes, block/unblock, all from the terminal.

Broadcasts & Sequences

Create bulk broadcasts, track delivery status, and trigger drip sequences. Automate campaign management from CI/CD or cron jobs.

Live Chat & Assignment

List conversations, read message history, assign agents, and hand off between bot and human, all scriptable via terminal commands.

Zero Token Cost

Direct API calls, no LLM, no hallucination. Pipe output through jq, integrate with cron jobs, and run in CI/CD pipelines with predictable results.

How It Works

Three steps from install to full CRM automation from your terminal.

1

Discover & Connect

Authenticate with your Workspace Token, verify workspace info, and list connected inboxes.

$ chatbotx workspaces get
{"id":"ws_01","name":"My Workspace"}

$ chatbotx inboxes list
[{"id":"inbox_01","channel":"whatsapp"}, ...]
2

Query & Resolve CRM

Look up contacts by email or phone, inspect custom fields, and review tag history.

$ chatbotx contacts get email:[email protected]
{"id":"c_9941","name":"Alex","email":"[email protected]"}

$ chatbotx contacts tags list phone:+84708123123
[{"id":105,"name":"VIP"}, {"id":42,"name":"Active"}]
3

Execute Actions

Tag contacts, send messages, trigger flows, create broadcasts, and pipe through jq.

# Tag a contact
$ chatbotx contacts tag add email:[email protected] --tagIds 105

# Send a message
$ chatbotx contacts message send phone:+84708123123 \
  --text "Order #1089 confirmed!"

# Trigger a visual flow
$ chatbotx contacts flow add email:[email protected] --flowId 88

# Create a broadcast
$ chatbotx broadcasts create --name "Flash Sale" \
  --flowId 12 --channel "whatsapp"

# Pipe through jq
$ chatbotx contacts list --perPage 100 --json \
  | jq '.data[] | select(.status=="active") | .email'
Command Reference · ChatbotX CLI

Command Reference

Full workspace API coverage organized by domain. Every command supports --json output flag.

Workspace & Team

  • workspaces get: Workspace info & configuration
  • members list: List team members & roles
  • inboxes list: Connected channel inboxes
  • teams list: List agent teams
  • tags list: Workspace tag definitions
  • custom-fields list: Custom field schemas
  • bot-fields list: Bot variable definitions

Contacts & CRM

  • contacts list: Search & paginate contacts
  • contacts get: Resolve by id: email: phone:
  • contacts upsert: Create or update contact
  • contacts tag add: Attach tags to contact
  • contacts tag remove: Remove tags from contact
  • contacts custom-fields list: Get field values
  • contacts custom-fields set: Update field values
  • contacts block / unblock: Toggle contact block

Conversations & Messages

  • conversations list: Filter by status & channel
  • conversations get: Full conversation details
  • conversations assign: Assign to agent or team
  • contacts message send: Send text or template
  • contacts message list: Message history

Broadcasts & Sequences

  • broadcasts list: List broadcast campaigns
  • broadcasts create: Create new broadcast
  • broadcasts stop: Halt active broadcast
  • sequences list: List drip sequences
  • sequences create: Create new sequence

Flows & Automation

  • flows list: List visual flows
  • flows create: Create flow draft
  • flows publish: Publish flow to live
  • contacts flow add: Trigger flow for contact
  • keywords list: Keyword matching rules
  • webhooks list: Registered webhooks
  • triggers list: Automation triggers

AI Agents & Analytics

  • ai-agents list: List workspace AI agents
  • ai-files list: Knowledge base documents
  • ai-mcp-servers list: Connected MCP servers
  • analytics flow-stats: Flow execution metrics
  • analytics broadcast-stats: Delivery metrics
  • error-logs list: System error logs

Ready to automate customer operations from the terminal?

Install ChatbotX CLI, authenticate with your Workspace Token, and start managing conversations, contacts, and campaigns from the command line.

Looking for natural language tool-calling? Try ChatbotX MCP Server.

ChatbotX CLI
Frequently Asked
Questions

Underline decorative

What is the difference between ChatbotX CLI and MCP?

How do I authenticate in CI/CD or Docker?

What contact lookup formats are supported?

Does the CLI work with ChatbotX Self-Hosted?

Subscribe to the Newsletter

For occasional updates, news and events