Skip to main content
The Chatbase CLI is the official command-line client for the Chatbase API v2. Use it to manage agents, knowledge sources, conversations, helpdesk tickets, and WhatsApp templates from your terminal or CI pipelines.
Requires Node.js 20+. Interactive login uses your Chatbase account in the browser (chatbase auth login --browser). API keys (Standard plan or higher) work for paste-login and CI — create them in Workspace settings → API keys.

​
Install

Or run without installing:
Check the version:

​
Quick start

1

Authenticate in the browser

This opens a browser window and shows a short code. Approve the code at chatbase.co/activate. The CLI stores the credential for later commands.Prefer pasting an API key instead? Run chatbase auth login and paste a key from Workspace settings → API keys. See CLI Auth for all login options.
2

List your agents

3

Send a message

​
Authenticate in CI

In non-interactive environments, set an API key in the environment instead of running auth login:
Optionally pin a default agent:
Never commit API keys. Prefer secrets managers or CI secret stores.

​
Global output flags

Most commands support:

​
Privacy

The CLI sends no telemetry. Requests include a chatbase-cli/<version> User-Agent so Chatbase can distinguish CLI traffic. The only network calls are the API calls you invoke.

​
Commands

Auth

Log in, log out, and inspect credentials.

Agents

Create, update, train, clone, and delete agents.

Sources

Manage knowledge sources (text, Q&A, links, files).

Chat

Send messages and stream responses.

Conversations

List, inspect, and export conversations.

Tickets

Manage helpdesk tickets and lookups.

WhatsApp

List templates and send template messages.

Config

Set default agent and timeout.

API

Call any API v2 endpoint directly.

Health

Check that the API is reachable.

​
Uninstall

For every flag on a command, run chatbase <command> --help.