The official CLI lets coding agents read conversations, search your help center, and prepare support work from the terminal. The bundled agent skill has them hold anything customer-visible for your approval.
Open source · Chatwoot Cloud and self-hosted
agent Summarize urgent conversations. Read only. Do not change anything.
● Loading the Chatwoot CLI skill and checking the queue.
$ chatwoot convs --assignee all -s open -o json
{
"data": { "payload": [
{ "id": 8421, "priority": "urgent",
"status": "open", "inbox_id": 7 },
{ "id": 8398, "priority": "high",
"status": "open", "inbox_id": 3 }
] }
}
Queue read
2 conversations need attention
Changes made
None
Ready with a summary.
One interface, real support work
The CLI returns structured data your agent can reason over. When the next step would reply, assign, label, or resolve, the official skill has your agent show you the exact command first.
Queue briefing
Summarize the open conversations assigned to me. Group them by urgency, and do not change anything in Chatwoot.
$ chatwoot convs --assignee me -s open -o jsonStructured output → agent summary
Open queue: 12 conversations
Urgent: 2 · High: 3 · Standard: 7
#8421 — refund blocked after duplicate charge
#8398 — enterprise SSO setup waiting 18h
No changes made.Triage
Find every open urgent conversation across all inboxes. Return the IDs and the latest customer messages. Read only.
$ chatwoot convs --assignee all -s open -o json | jq '.data.payload[] | select(.priority == "urgent")'Filtered JSON
{
"id": 8421,
"priority": "urgent",
"status": "open",
"inbox_id": 7
}Knowledge lookup
Search our help center for articles about changing a billing email. Give me the best match and cite its public link.
$ chatwoot hc articles --query "billing email" -o jsonHelp center search result
{
"title": "Update your billing details",
"slug": "update-billing-details",
"category": "Account settings",
"link": "https://support.example.com/..."
}Privileged action
Read conversation 8421 and draft a concise reply. Show me the exact reply command, but do not run it until I approve.
$ chatwoot conv 8421 reply "I found the duplicate charge and asked our billing team to reverse it. I’ll update you here within one business day."Approval checkpoint
Proposed customer-visible reply prepared.
Command not run.
Waiting for explicit approval for conversation #8421.Chatwoot for coding agents
A coding agent is useful when it can get reliable context and show its work. Chatwoot CLI gives it both. Instead of clicking through the dashboard or scraping terminal tables, the agent can request support desk conversations, CRM contacts, inboxes, labels, teams, and help center articles in a predictable format.
Alongside the CLI, Chatwoot also offers Captain, the AI copilot inside the product, and Agent Bots, which let you plug custom bots into your inboxes. The CLI is for the coding agent already working with you in a terminal: Codex, Claude, Cursor, Grok, or another tool that can run shell commands.
Ask for the open queue, a single conversation, or every message that mentions a refund. The agent can summarize what it finds, group related issues, and point you to the conversations worth opening in Chatwoot.
Search your Chatwoot Help Center before drafting a response. The CLI can list portals, search articles by query or category, and fetch the full article your agent should use as context.
Text output is meant for people. Agents can request JSON for parsing, CSV for an export, or quiet mode when a pipeline only needs resource IDs. Exit codes and errors behave like a normal command-line tool.
The common support jobs have first-class commands. When the CLI does not cover an endpoint yet, the raw API command can make an authenticated request against the configured Chatwoot account. Non-GET calls still require approval.
The AI copilot inside Chatwoot. It answers customers directly from your help content.
Plug your own bot into any inbox through webhooks and the Agent Bot API.
Coding agents in your terminal, reading the queue and preparing work you approve.
How it works
The official agent skill teaches your coding agent the CLI grammar, structured output contract, and the rule that shared-state writes wait for explicit confirmation.
The installer detects your operating system and architecture, downloads the matching release binary, and verifies its SHA256 checksum.
curl -fsSL https://chwt.app/install-cli | shEnter your Chatwoot base URL, API key, and account ID. The CLI validates them before saving; the API key goes to your OS keyring.
chatwoot auth loginInstall the official bundled skill so your coding agent knows the command grammar, output formats, and write-approval rules.
npx skills add chatwoot/cliLet the agent read and summarize freely. For replies, assignments, labels, priorities, statuses, or mutating API calls, review the exact command and confirm it first.
Built for agents. Accountable to humans.
An agent can inspect the queue and prepare a plan on its own. The official skill instructs it to stop and ask you before changing shared support data or sending a message.
Read freely
Confirm before writes
CHATWOOT_API_KEY is available for CI and headless environments.chatwoot api command provides an authenticated escape hatch under the configured account.Quick start
Install the release, sign in to your Chatwoot account, then add the official skill so your agent knows the commands and safety rules.
1 — Install
$ curl -fsSL https://chwt.app/install-cli | sh
2 — Connect
$ chatwoot auth login
3 — Teach your agent
$ npx skills add chatwoot/cli
✓ Credentials validated
✓ API key saved to the OS keyring
✓ Agent skill ready
New to Chatwoot?
Chatwoot is the open-source customer support platform behind the CLI: omnichannel inbox, help center, and Captain AI. If your team already works in a coding agent, it can triage conversations, look up published answers, and draft replies for your approval from day one, on Chatwoot Cloud or self-hosted.
…and any other agent that can run shell commands.
Questions, answered
The practical details before you give an agent access to a real support account.
Chatwoot CLI is the official open-source command-line interface for Chatwoot. It lets people, scripts, and coding agents read support data and run common conversation workflows from a terminal.
They cover three different surfaces. Captain is Chatwoot's AI copilot inside the product, answering customers from your help content. Agent Bots connect a custom bot to your inboxes through the Agent Bot API. The Chatwoot CLI is for coding agents in your terminal, which read support data and prepare work you approve.
Any agent that can run shell commands can use the CLI. That includes Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Grok, and Windsurf. The bundled Chatwoot skill is designed for agent environments that support installable skills or project instructions.
Yes. During login you provide the Chatwoot base URL, API key, and account ID. That lets the same CLI connect to Chatwoot Cloud or a self-hosted Chatwoot installation.
The CLI supports replies, private notes, assignments, labels, priorities, and status changes. The official agent skill treats these as privileged writes: the agent should show the exact command and wait for explicit approval before running it.
Interactive login stores the API key in your operating system keyring. Non-secret settings live in the Chatwoot CLI config file. CI and headless environments can provide CHATWOOT_API_KEY instead.
Yes. Use JSON output when code needs the full response, CSV for tabular exports, or quiet mode for one ID per line. The raw API command is available when a workflow does not yet have a first-class CLI command.
The official interface for coding agents