Skip to main content
A terminal client for Chatwoot. Most things you’d do in the agent dashboard (read conversations, reply, assign, resolve) work as commands you can script or pipe into other tools. You can also search help center articles from the terminal. It’s handy with coding agents: tools like Claude Code or Cursor can call chatwoot directly to look up conversations, post replies, search help center content when asked, or automate repetitive triage, without needing a custom integration.
  • Commands — the full command reference: conversations, contacts, inboxes, agents, help centers.
  • Scripting & output — JSON / CSV / quiet mode, shell completions, automation recipes.

​
Install

Installs to ~/.local/bin/chatwoot. Override with CHATWOOT_VERSION or CHATWOOT_INSTALL_DIR:
Windows: download chatwoot_<version>_Windows_x86_64.zip from the releases page and extract chatwoot.exe. From source (Go 1.25+):

​
Log in

You’ll be asked for:
  • Base URL — your Chatwoot instance, e.g. https://app.chatwoot.com
  • API Key — from your agent profile → API access token
  • Account ID — the number in your dashboard URL
Credentials are validated before saving. The API key is stored in your OS keyring; non-secret config lives at ~/.chatwoot/config.yaml. For CI or headless use, set CHATWOOT_API_KEY to override the saved token.

​
Shell completions

The install script offers to set this up interactively. To do it manually:
Restart your shell (or source your rc file). Tab-completion works for commands, subcommands, and flags. Run chatwoot completion --help for details.

​
Help

Issues and feedback: github.com/chatwoot/cli.

​
Uninstalling

If you set up shell completions, also remove them:
On Windows, delete the extracted chatwoot.exe and the %USERPROFILE%\.chatwoot folder. If CHATWOOT_API_KEY is set in your environment, unset it in your shell rc — auth logout can’t remove env-provided credentials.