chatbase 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +1524 -6
  3. package/bin/run.js +4 -0
  4. package/dist/base/agent-command.js +40 -0
  5. package/dist/base/agent-ref.js +16 -0
  6. package/dist/base/assert-file.js +21 -0
  7. package/dist/base/base-command.js +203 -0
  8. package/dist/base/body-input.js +77 -0
  9. package/dist/base/list-command.js +16 -0
  10. package/dist/base/sources.js +33 -0
  11. package/dist/client/chat-helpers.js +173 -0
  12. package/dist/client/client.js +175 -0
  13. package/dist/client/files.js +64 -0
  14. package/dist/client/paginate.js +40 -0
  15. package/dist/client/pairing.js +76 -0
  16. package/dist/client/retry.js +40 -0
  17. package/dist/client/signals.js +43 -0
  18. package/dist/client/stream.js +79 -0
  19. package/dist/commands/agents/auto-retrain.js +46 -0
  20. package/dist/commands/agents/clone.js +28 -0
  21. package/dist/commands/agents/create.js +43 -0
  22. package/dist/commands/agents/delete.js +41 -0
  23. package/dist/commands/agents/get.js +52 -0
  24. package/dist/commands/agents/list.js +48 -0
  25. package/dist/commands/agents/styles.js +44 -0
  26. package/dist/commands/agents/train.js +31 -0
  27. package/dist/commands/agents/update.js +47 -0
  28. package/dist/commands/api.js +69 -0
  29. package/dist/commands/auth/login.js +125 -0
  30. package/dist/commands/auth/logout.js +38 -0
  31. package/dist/commands/auth/status.js +86 -0
  32. package/dist/commands/chat/index.js +210 -0
  33. package/dist/commands/chat/retry.js +49 -0
  34. package/dist/commands/config/get.js +40 -0
  35. package/dist/commands/config/list.js +34 -0
  36. package/dist/commands/config/set.js +106 -0
  37. package/dist/commands/conversations/export.js +75 -0
  38. package/dist/commands/conversations/get.js +69 -0
  39. package/dist/commands/conversations/list.js +75 -0
  40. package/dist/commands/health.js +22 -0
  41. package/dist/commands/helpdesk/statuses.js +31 -0
  42. package/dist/commands/helpdesk/teams.js +25 -0
  43. package/dist/commands/messages/feedback.js +64 -0
  44. package/dist/commands/messages/list.js +55 -0
  45. package/dist/commands/sources/create.js +134 -0
  46. package/dist/commands/sources/delete.js +28 -0
  47. package/dist/commands/sources/get.js +35 -0
  48. package/dist/commands/sources/list.js +47 -0
  49. package/dist/commands/sources/restore.js +22 -0
  50. package/dist/commands/sources/summary.js +33 -0
  51. package/dist/commands/sources/update.js +76 -0
  52. package/dist/commands/tickets/create.js +58 -0
  53. package/dist/commands/tickets/get.js +44 -0
  54. package/dist/commands/tickets/list.js +96 -0
  55. package/dist/commands/tickets/messages.js +87 -0
  56. package/dist/commands/tickets/reply.js +66 -0
  57. package/dist/commands/tickets/search.js +53 -0
  58. package/dist/commands/tickets/update.js +38 -0
  59. package/dist/config/paths.js +22 -0
  60. package/dist/config/resolve.js +37 -0
  61. package/dist/config/store.js +38 -0
  62. package/dist/errors/errors.js +81 -0
  63. package/dist/hooks/chat-message-hint.js +21 -0
  64. package/dist/output/color.js +30 -0
  65. package/dist/output/mode.js +7 -0
  66. package/dist/output/render.js +0 -0
  67. package/dist/output/spinner.js +37 -0
  68. package/dist/repl/chat-repl.js +129 -0
  69. package/dist/version.js +3 -0
  70. package/oclif.manifest.json +3948 -0
  71. package/package.json +92 -4
  72. package/spec/openapi.json +11843 -0
package/README.md CHANGED
@@ -1,11 +1,1529 @@
1
1
  # chatbase
2
2
 
3
- The official command-line interface for [Chatbase](https://www.chatbase.co) — under active development.
3
+ The official CLI for the [Chatbase API v2](https://www.chatbase.co/docs/api-v2/overview).
4
4
 
5
- This package name is reserved by Chatbase. The CLI will ship here soon:
5
+ ## Install
6
6
 
7
- - Full access to the [Chatbase API v2](https://www.chatbase.co/docs/api-v2/overview) from your terminal
8
- - Interactive agent chat, knowledge-source syncing, CI-friendly JSON output
9
- - MCP server mode for Claude and other AI assistants
7
+ ```sh
8
+ npm install -g chatbase # or: npx chatbase <command>
9
+ ```
10
10
 
11
- Until then, see the [API documentation](https://www.chatbase.co/docs/api-v2/overview).
11
+ Requires Node 20+.
12
+
13
+ ### Uninstall
14
+
15
+ ```sh
16
+ npm uninstall -g chatbase
17
+ rm -rf ~/.config/chatbase ~/.local/state/chatbase ~/.cache/chatbase
18
+ rm -rf ~/Library/Caches/chatbase # macOS: update-check cache
19
+ ```
20
+
21
+ ## Authenticate
22
+
23
+ ```sh
24
+ chatbase auth login # interactive (paste your API key)
25
+ chatbase auth login --with-token < key.txt
26
+ export CHATBASE_API_KEY=... # CI
27
+ ```
28
+
29
+ Keys live in chatbase.co → Workspace Settings → API Keys (Standard plan or higher).
30
+
31
+ ## Privacy
32
+
33
+ The CLI sends no telemetry. Requests carry a `chatbase-cli/<version>` User-Agent so
34
+ Chatbase can distinguish CLI traffic server-side. The only network calls are the API
35
+ calls you invoke.
36
+
37
+ <!-- commands -->
38
+ * [`chatbase agents auto-retrain [AGENTID]`](#chatbase-agents-auto-retrain-agentid)
39
+ * [`chatbase agents clone AGENTID`](#chatbase-agents-clone-agentid)
40
+ * [`chatbase agents create`](#chatbase-agents-create)
41
+ * [`chatbase agents delete AGENTID`](#chatbase-agents-delete-agentid)
42
+ * [`chatbase agents get [AGENTID]`](#chatbase-agents-get-agentid)
43
+ * [`chatbase agents list`](#chatbase-agents-list)
44
+ * [`chatbase agents styles [AGENTID]`](#chatbase-agents-styles-agentid)
45
+ * [`chatbase agents train [AGENTID]`](#chatbase-agents-train-agentid)
46
+ * [`chatbase agents update [AGENTID]`](#chatbase-agents-update-agentid)
47
+ * [`chatbase api METHOD PATH`](#chatbase-api-method-path)
48
+ * [`chatbase auth login`](#chatbase-auth-login)
49
+ * [`chatbase auth logout`](#chatbase-auth-logout)
50
+ * [`chatbase auth status`](#chatbase-auth-status)
51
+ * [`chatbase chat`](#chatbase-chat)
52
+ * [`chatbase chat retry`](#chatbase-chat-retry)
53
+ * [`chatbase config get KEY`](#chatbase-config-get-key)
54
+ * [`chatbase config list`](#chatbase-config-list)
55
+ * [`chatbase config set KEY [VALUE]`](#chatbase-config-set-key-value)
56
+ * [`chatbase conversations export`](#chatbase-conversations-export)
57
+ * [`chatbase conversations get [CONVERSATIONID]`](#chatbase-conversations-get-conversationid)
58
+ * [`chatbase conversations list`](#chatbase-conversations-list)
59
+ * [`chatbase health`](#chatbase-health)
60
+ * [`chatbase help [COMMAND]`](#chatbase-help-command)
61
+ * [`chatbase helpdesk statuses`](#chatbase-helpdesk-statuses)
62
+ * [`chatbase helpdesk teams`](#chatbase-helpdesk-teams)
63
+ * [`chatbase messages feedback [MESSAGEID]`](#chatbase-messages-feedback-messageid)
64
+ * [`chatbase messages list`](#chatbase-messages-list)
65
+ * [`chatbase sources create`](#chatbase-sources-create)
66
+ * [`chatbase sources delete SOURCEID`](#chatbase-sources-delete-sourceid)
67
+ * [`chatbase sources get SOURCEID`](#chatbase-sources-get-sourceid)
68
+ * [`chatbase sources list`](#chatbase-sources-list)
69
+ * [`chatbase sources restore SOURCEID`](#chatbase-sources-restore-sourceid)
70
+ * [`chatbase sources summary`](#chatbase-sources-summary)
71
+ * [`chatbase sources update SOURCEID`](#chatbase-sources-update-sourceid)
72
+ * [`chatbase tickets create`](#chatbase-tickets-create)
73
+ * [`chatbase tickets get TICKETNUMBER`](#chatbase-tickets-get-ticketnumber)
74
+ * [`chatbase tickets list`](#chatbase-tickets-list)
75
+ * [`chatbase tickets messages [TICKETNUMBER]`](#chatbase-tickets-messages-ticketnumber)
76
+ * [`chatbase tickets reply [TICKETNUMBER]`](#chatbase-tickets-reply-ticketnumber)
77
+ * [`chatbase tickets search QUERY`](#chatbase-tickets-search-query)
78
+ * [`chatbase tickets update TICKETNUMBER`](#chatbase-tickets-update-ticketnumber)
79
+
80
+ ## `chatbase agents auto-retrain [AGENTID]`
81
+
82
+ Enable or disable automatic retraining for an agent
83
+
84
+ ```
85
+ USAGE
86
+ $ chatbase agents auto-retrain [AGENTID] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
87
+ <value> | -a <value>] [--enabled] [--disabled]
88
+
89
+ ARGUMENTS
90
+ [AGENTID] Agent ID
91
+
92
+ FLAGS
93
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
94
+ -q, --quiet Suppress non-essential output
95
+ --agent-name=<value> Agent display name (looked up to an ID)
96
+ --disabled Disable automatic retraining
97
+ --enabled Enable automatic retraining
98
+ --no-color Disable colored output
99
+ --no-input Never prompt; fail instead
100
+ --verbose Verbose diagnostics
101
+
102
+ OUTPUT FLAGS
103
+ --json Output raw API JSON
104
+ --plain Tab-separated output for scripts
105
+
106
+ DESCRIPTION
107
+ Enable or disable automatic retraining for an agent
108
+
109
+ EXAMPLES
110
+ $ chatbase agents auto-retrain agt_123 --enabled
111
+
112
+ $ chatbase agents auto-retrain --enabled
113
+ ```
114
+
115
+ _See code: [src/commands/agents/auto-retrain.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/auto-retrain.ts)_
116
+
117
+ ## `chatbase agents clone AGENTID`
118
+
119
+ Clone an agent, including all its sources (excluding Notion)
120
+
121
+ ```
122
+ USAGE
123
+ $ chatbase agents clone AGENTID [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
124
+
125
+ ARGUMENTS
126
+ AGENTID Agent ID to clone
127
+
128
+ FLAGS
129
+ -q, --quiet Suppress non-essential output
130
+ --no-color Disable colored output
131
+ --no-input Never prompt; fail instead
132
+ --verbose Verbose diagnostics
133
+
134
+ OUTPUT FLAGS
135
+ --json Output raw API JSON
136
+ --plain Tab-separated output for scripts
137
+
138
+ DESCRIPTION
139
+ Clone an agent, including all its sources (excluding Notion)
140
+
141
+ EXAMPLES
142
+ $ chatbase agents clone agt_123
143
+ ```
144
+
145
+ _See code: [src/commands/agents/clone.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/clone.ts)_
146
+
147
+ ## `chatbase agents create`
148
+
149
+ Create a new agent
150
+
151
+ ```
152
+ USAGE
153
+ $ chatbase agents create [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [-f <value>...] [--name
154
+ <value>] [--instructions <value>] [--model <value>] [--data <value>]
155
+
156
+ FLAGS
157
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
158
+ -q, --quiet Suppress non-essential output
159
+ --data=<value> JSON body (@file, @-, or inline). Fields: name, instructions, model, visibility, temp
160
+ --instructions=<value> System instructions
161
+ --model=<value> Model ID
162
+ --name=<value> Agent name
163
+ --no-color Disable colored output
164
+ --no-input Never prompt; fail instead
165
+ --verbose Verbose diagnostics
166
+
167
+ OUTPUT FLAGS
168
+ --json Output raw API JSON
169
+ --plain Tab-separated output for scripts
170
+
171
+ DESCRIPTION
172
+ Create a new agent
173
+
174
+ EXAMPLES
175
+ $ chatbase agents create --name "Support Bot" --instructions "Be helpful"
176
+
177
+ $ chatbase agents create --data @agent.json
178
+ ```
179
+
180
+ _See code: [src/commands/agents/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/create.ts)_
181
+
182
+ ## `chatbase agents delete AGENTID`
183
+
184
+ Permanently delete an agent (cannot be undone)
185
+
186
+ ```
187
+ USAGE
188
+ $ chatbase agents delete AGENTID [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--confirm <value>]
189
+
190
+ ARGUMENTS
191
+ AGENTID Agent ID
192
+
193
+ FLAGS
194
+ -q, --quiet Suppress non-essential output
195
+ --confirm=<value> Confirm by repeating the agent ID (required in scripts and CI)
196
+ --no-color Disable colored output
197
+ --no-input Never prompt; fail instead
198
+ --verbose Verbose diagnostics
199
+
200
+ OUTPUT FLAGS
201
+ --json Output raw API JSON
202
+ --plain Tab-separated output for scripts
203
+
204
+ DESCRIPTION
205
+ Permanently delete an agent (cannot be undone)
206
+
207
+ EXAMPLES
208
+ $ chatbase agents delete agt_123 --confirm agt_123
209
+ ```
210
+
211
+ _See code: [src/commands/agents/delete.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/delete.ts)_
212
+
213
+ ## `chatbase agents get [AGENTID]`
214
+
215
+ Show one agent
216
+
217
+ ```
218
+ USAGE
219
+ $ chatbase agents get [AGENTID] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
220
+ <value> | -a <value>]
221
+
222
+ ARGUMENTS
223
+ [AGENTID] Agent ID
224
+
225
+ FLAGS
226
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
227
+ -q, --quiet Suppress non-essential output
228
+ --agent-name=<value> Agent display name (looked up to an ID)
229
+ --no-color Disable colored output
230
+ --no-input Never prompt; fail instead
231
+ --verbose Verbose diagnostics
232
+
233
+ OUTPUT FLAGS
234
+ --json Output raw API JSON
235
+ --plain Tab-separated output for scripts
236
+
237
+ DESCRIPTION
238
+ Show one agent
239
+
240
+ EXAMPLES
241
+ $ chatbase agents get agt_123
242
+
243
+ $ chatbase agents get
244
+ ```
245
+
246
+ _See code: [src/commands/agents/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/get.ts)_
247
+
248
+ ## `chatbase agents list`
249
+
250
+ List all agents in the workspace
251
+
252
+ ```
253
+ USAGE
254
+ $ chatbase agents list [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--limit <value>]
255
+ [--cursor <value>] [--all]
256
+
257
+ FLAGS
258
+ -q, --quiet Suppress non-essential output
259
+ --all Fetch every page
260
+ --cursor=<value> Pagination cursor from a previous page
261
+ --limit=<value> Maximum items per page
262
+ --no-color Disable colored output
263
+ --no-input Never prompt; fail instead
264
+ --verbose Verbose diagnostics
265
+
266
+ OUTPUT FLAGS
267
+ --json Output raw API JSON
268
+ --plain Tab-separated output for scripts
269
+
270
+ DESCRIPTION
271
+ List all agents in the workspace
272
+
273
+ EXAMPLES
274
+ $ chatbase agents list
275
+
276
+ $ chatbase agents list --json
277
+ ```
278
+
279
+ _See code: [src/commands/agents/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/list.ts)_
280
+
281
+ ## `chatbase agents styles [AGENTID]`
282
+
283
+ Update visual styles for an agent
284
+
285
+ ```
286
+ USAGE
287
+ $ chatbase agents styles [AGENTID] --data <value> [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
288
+ [--agent-name <value> | -a <value>] [-f <value>...]
289
+
290
+ ARGUMENTS
291
+ [AGENTID] Agent ID
292
+
293
+ FLAGS
294
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
295
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
296
+ -q, --quiet Suppress non-essential output
297
+ --agent-name=<value> Agent display name (looked up to an ID)
298
+ --data=<value> (required) JSON body (@file, @-, or inline). See API docs for style properties
299
+ --no-color Disable colored output
300
+ --no-input Never prompt; fail instead
301
+ --verbose Verbose diagnostics
302
+
303
+ OUTPUT FLAGS
304
+ --json Output raw API JSON
305
+ --plain Tab-separated output for scripts
306
+
307
+ DESCRIPTION
308
+ Update visual styles for an agent
309
+
310
+ EXAMPLES
311
+ $ chatbase agents styles agt_123 --data '{"chat":{"theme":"dark"}}'
312
+
313
+ $ chatbase agents styles --data @styles.json
314
+ ```
315
+
316
+ _See code: [src/commands/agents/styles.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/styles.ts)_
317
+
318
+ ## `chatbase agents train [AGENTID]`
319
+
320
+ Queue a training job for an agent
321
+
322
+ ```
323
+ USAGE
324
+ $ chatbase agents train [AGENTID] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
325
+ <value> | -a <value>]
326
+
327
+ ARGUMENTS
328
+ [AGENTID] Agent ID to train (defaults to the configured agent, like other commands)
329
+
330
+ FLAGS
331
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
332
+ -q, --quiet Suppress non-essential output
333
+ --agent-name=<value> Agent display name (looked up to an ID)
334
+ --no-color Disable colored output
335
+ --no-input Never prompt; fail instead
336
+ --verbose Verbose diagnostics
337
+
338
+ OUTPUT FLAGS
339
+ --json Output raw API JSON
340
+ --plain Tab-separated output for scripts
341
+
342
+ DESCRIPTION
343
+ Queue a training job for an agent
344
+
345
+ EXAMPLES
346
+ $ chatbase agents train agt_123
347
+
348
+ $ chatbase agents train
349
+ ```
350
+
351
+ _See code: [src/commands/agents/train.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/train.ts)_
352
+
353
+ ## `chatbase agents update [AGENTID]`
354
+
355
+ Update an existing agent
356
+
357
+ ```
358
+ USAGE
359
+ $ chatbase agents update [AGENTID] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
360
+ <value> | -a <value>] [-f <value>...] [--name <value>] [--instructions <value>] [--model <value>] [--data <value>]
361
+
362
+ ARGUMENTS
363
+ [AGENTID] Agent ID
364
+
365
+ FLAGS
366
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
367
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
368
+ -q, --quiet Suppress non-essential output
369
+ --agent-name=<value> Agent display name (looked up to an ID)
370
+ --data=<value> JSON body (@file, @-, or inline). Fields: name, instructions, model, visibility, temp
371
+ --instructions=<value> System instructions
372
+ --model=<value> Model ID
373
+ --name=<value> Agent name
374
+ --no-color Disable colored output
375
+ --no-input Never prompt; fail instead
376
+ --verbose Verbose diagnostics
377
+
378
+ OUTPUT FLAGS
379
+ --json Output raw API JSON
380
+ --plain Tab-separated output for scripts
381
+
382
+ DESCRIPTION
383
+ Update an existing agent
384
+
385
+ EXAMPLES
386
+ $ chatbase agents update agt_123 --name "New Name"
387
+
388
+ $ chatbase agents update --name "New Name"
389
+
390
+ $ chatbase agents update agt_123 --data @agent.json
391
+ ```
392
+
393
+ _See code: [src/commands/agents/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/agents/update.ts)_
394
+
395
+ ## `chatbase api METHOD PATH`
396
+
397
+ Call the Chatbase API directly — an escape hatch for endpoints without a dedicated command
398
+
399
+ ```
400
+ USAGE
401
+ $ chatbase api METHOD PATH [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [-f
402
+ <value>...] [--query <value>...] [--body <value>]
403
+
404
+ ARGUMENTS
405
+ METHOD (GET|POST|PUT|PATCH|DELETE) HTTP method
406
+ PATH API path relative to /api/v2, e.g. /agents
407
+
408
+ FLAGS
409
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
410
+ -q, --quiet Suppress non-essential output
411
+ --body=<value> JSON request body (@file, @-, or inline JSON)
412
+ --no-color Disable colored output
413
+ --no-input Never prompt; fail instead
414
+ --query=<value>... Query param k=v (repeatable)
415
+ --verbose Verbose diagnostics
416
+
417
+ OUTPUT FLAGS
418
+ --json Output raw API JSON
419
+ --plain Tab-separated output for scripts
420
+
421
+ DESCRIPTION
422
+ Call the Chatbase API directly — an escape hatch for endpoints without a dedicated command
423
+
424
+ EXAMPLES
425
+ $ chatbase api GET /agents
426
+
427
+ $ chatbase api GET /agents --field limit=5
428
+
429
+ $ chatbase api POST /agents --body '{"name":"Support Bot"}'
430
+
431
+ $ chatbase api PATCH /agents/agt_123 --body @patch.json
432
+ ```
433
+
434
+ _See code: [src/commands/api.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/api.ts)_
435
+
436
+ ## `chatbase auth login`
437
+
438
+ Authenticate with Chatbase — paste an API key or log in via browser
439
+
440
+ ```
441
+ USAGE
442
+ $ chatbase auth login [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--with-token] [--browser]
443
+
444
+ FLAGS
445
+ -q, --quiet Suppress non-essential output
446
+ --browser Log in via browser — approve a code at chatbase.co/activate
447
+ --no-color Disable colored output
448
+ --no-input Never prompt; fail instead
449
+ --verbose Verbose diagnostics
450
+ --with-token Read the API key from stdin
451
+
452
+ OUTPUT FLAGS
453
+ --json Output raw API JSON
454
+ --plain Tab-separated output for scripts
455
+
456
+ DESCRIPTION
457
+ Authenticate with Chatbase — paste an API key or log in via browser
458
+
459
+ EXAMPLES
460
+ $ chatbase auth login
461
+
462
+ $ chatbase auth login --browser
463
+
464
+ cat key.txt | chatbase auth login --with-token
465
+ ```
466
+
467
+ _See code: [src/commands/auth/login.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/auth/login.ts)_
468
+
469
+ ## `chatbase auth logout`
470
+
471
+ Remove the stored API key (revokes CLI-paired keys server-side)
472
+
473
+ ```
474
+ USAGE
475
+ $ chatbase auth logout [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
476
+
477
+ FLAGS
478
+ -q, --quiet Suppress non-essential output
479
+ --no-color Disable colored output
480
+ --no-input Never prompt; fail instead
481
+ --verbose Verbose diagnostics
482
+
483
+ OUTPUT FLAGS
484
+ --json Output raw API JSON
485
+ --plain Tab-separated output for scripts
486
+
487
+ DESCRIPTION
488
+ Remove the stored API key (revokes CLI-paired keys server-side)
489
+
490
+ EXAMPLES
491
+ $ chatbase auth logout
492
+ ```
493
+
494
+ _See code: [src/commands/auth/logout.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/auth/logout.ts)_
495
+
496
+ ## `chatbase auth status`
497
+
498
+ Show the active credential and where it comes from
499
+
500
+ ```
501
+ USAGE
502
+ $ chatbase auth status [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
503
+
504
+ FLAGS
505
+ -q, --quiet Suppress non-essential output
506
+ --no-color Disable colored output
507
+ --no-input Never prompt; fail instead
508
+ --verbose Verbose diagnostics
509
+
510
+ OUTPUT FLAGS
511
+ --json Output raw API JSON
512
+ --plain Tab-separated output for scripts
513
+
514
+ DESCRIPTION
515
+ Show the active credential and where it comes from
516
+
517
+ EXAMPLES
518
+ $ chatbase auth status
519
+ ```
520
+
521
+ _See code: [src/commands/auth/status.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/auth/status.ts)_
522
+
523
+ ## `chatbase chat`
524
+
525
+ Send a message to an agent and print its response
526
+
527
+ ```
528
+ USAGE
529
+ $ chatbase chat [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
530
+ <value>] [-m <value>] [--resume --conversation <value>] [--no-stream]
531
+
532
+ FLAGS
533
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
534
+ -m, --message=<value> Message to send (else read from piped stdin, else an interactive REPL)
535
+ -q, --quiet Suppress non-essential output
536
+ --agent-name=<value> Agent display name (looked up to an ID)
537
+ --conversation=<value> Continue an existing conversation
538
+ --no-color Disable colored output
539
+ --no-input Never prompt; fail instead
540
+ --no-stream Wait for the complete response instead of streaming tokens
541
+ --resume Replay the last few messages when continuing a conversation
542
+ --verbose Verbose diagnostics
543
+
544
+ OUTPUT FLAGS
545
+ --json Output raw API JSON
546
+ --plain Tab-separated output for scripts
547
+
548
+ DESCRIPTION
549
+ Send a message to an agent and print its response
550
+
551
+ EXAMPLES
552
+ $ chatbase chat -a agt_123 -m "How do I reset my password?"
553
+
554
+ echo "summarize our refund policy" | chatbase chat -a agt_123
555
+
556
+ $ chatbase chat -a agt_123 -m "and then?" --conversation conv_123
557
+
558
+ $ chatbase chat -a agt_123 -m "hi" --no-stream
559
+
560
+ $ chatbase chat -a agt_123 -m "hi" --json
561
+ ```
562
+
563
+ _See code: [src/commands/chat/index.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/chat/index.ts)_
564
+
565
+ ## `chatbase chat retry`
566
+
567
+ Retry generating an assistant response (discards that message and everything after it in the conversation)
568
+
569
+ ```
570
+ USAGE
571
+ $ chatbase chat retry --conversation <value> --message-id <value> [--json] [--plain] [-q] [--verbose]
572
+ [--no-input] [--no-color] [--agent-name <value> | -a <value>] [--no-stream]
573
+
574
+ FLAGS
575
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
576
+ -q, --quiet Suppress non-essential output
577
+ --agent-name=<value> Agent display name (looked up to an ID)
578
+ --conversation=<value> (required) The conversation ID to retry in
579
+ --message-id=<value> (required) The message ID to retry from
580
+ --no-color Disable colored output
581
+ --no-input Never prompt; fail instead
582
+ --no-stream Wait for the complete response instead of streaming tokens
583
+ --verbose Verbose diagnostics
584
+
585
+ OUTPUT FLAGS
586
+ --json Output raw API JSON
587
+ --plain Tab-separated output for scripts
588
+
589
+ DESCRIPTION
590
+ Retry generating an assistant response (discards that message and everything after it in the conversation)
591
+
592
+ EXAMPLES
593
+ $ chatbase chat retry --conversation c_123 -a agt_123 --message-id msg_456
594
+
595
+ $ chatbase chat retry --conversation c_123 -a agt_123 --message-id msg_456 --no-stream
596
+ ```
597
+
598
+ _See code: [src/commands/chat/retry.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/chat/retry.ts)_
599
+
600
+ ## `chatbase config get KEY`
601
+
602
+ Print a resolved CLI configuration value and where it comes from
603
+
604
+ ```
605
+ USAGE
606
+ $ chatbase config get KEY [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
607
+
608
+ ARGUMENTS
609
+ KEY agent | timeout
610
+
611
+ FLAGS
612
+ -q, --quiet Suppress non-essential output
613
+ --no-color Disable colored output
614
+ --no-input Never prompt; fail instead
615
+ --verbose Verbose diagnostics
616
+
617
+ OUTPUT FLAGS
618
+ --json Output raw API JSON
619
+ --plain Tab-separated output for scripts
620
+
621
+ DESCRIPTION
622
+ Print a resolved CLI configuration value and where it comes from
623
+
624
+ EXAMPLES
625
+ $ chatbase config get agent
626
+
627
+ $ chatbase config get timeout
628
+ ```
629
+
630
+ _See code: [src/commands/config/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/config/get.ts)_
631
+
632
+ ## `chatbase config list`
633
+
634
+ List every resolved CLI configuration value and its source
635
+
636
+ ```
637
+ USAGE
638
+ $ chatbase config list [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
639
+
640
+ FLAGS
641
+ -q, --quiet Suppress non-essential output
642
+ --no-color Disable colored output
643
+ --no-input Never prompt; fail instead
644
+ --verbose Verbose diagnostics
645
+
646
+ OUTPUT FLAGS
647
+ --json Output raw API JSON
648
+ --plain Tab-separated output for scripts
649
+
650
+ DESCRIPTION
651
+ List every resolved CLI configuration value and its source
652
+
653
+ EXAMPLES
654
+ $ chatbase config list
655
+ ```
656
+
657
+ _See code: [src/commands/config/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/config/list.ts)_
658
+
659
+ ## `chatbase config set KEY [VALUE]`
660
+
661
+ Set a CLI configuration value
662
+
663
+ ```
664
+ USAGE
665
+ $ chatbase config set KEY [VALUE] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
666
+
667
+ ARGUMENTS
668
+ KEY agent | timeout
669
+ [VALUE] New value (omit for agent to pick interactively)
670
+
671
+ FLAGS
672
+ -q, --quiet Suppress non-essential output
673
+ --no-color Disable colored output
674
+ --no-input Never prompt; fail instead
675
+ --verbose Verbose diagnostics
676
+
677
+ OUTPUT FLAGS
678
+ --json Output raw API JSON
679
+ --plain Tab-separated output for scripts
680
+
681
+ DESCRIPTION
682
+ Set a CLI configuration value
683
+
684
+ EXAMPLES
685
+ $ chatbase config set agent agt_123
686
+
687
+ $ chatbase config set agent
688
+
689
+ $ chatbase config set timeout 60000
690
+ ```
691
+
692
+ _See code: [src/commands/config/set.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/config/set.ts)_
693
+
694
+ ## `chatbase conversations export`
695
+
696
+ Export conversations from every source, with full message history
697
+
698
+ ```
699
+ USAGE
700
+ $ chatbase conversations export [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
701
+ <value>] [--cursor <value>] [--limit <value>] [--all] [-o <value>]
702
+
703
+ FLAGS
704
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
705
+ -o, --output=<value> Write export JSON to a file instead of stdout
706
+ -q, --quiet Suppress non-essential output
707
+ --agent-name=<value> Agent display name (looked up to an ID)
708
+ --all Fetch every page
709
+ --cursor=<value> Opaque cursor from a previous response
710
+ --limit=<value> Items per page (1-20, default 20)
711
+ --no-color Disable colored output
712
+ --no-input Never prompt; fail instead
713
+ --verbose Verbose diagnostics
714
+
715
+ OUTPUT FLAGS
716
+ --json Output raw API JSON
717
+ --plain Tab-separated output for scripts
718
+
719
+ DESCRIPTION
720
+ Export conversations from every source, with full message history
721
+
722
+ Export conversations with full message history, newest first.
723
+
724
+ This is the only endpoint that returns conversations from every source — the chat bubble and external integrations
725
+ (Slack, WhatsApp, Instagram, Messenger, and the like) as well as API-created ones. Prefer it over `conversations list`
726
+ whenever you need real traffic rather than just programmatically created conversations. Each item embeds its own
727
+ `messages` array, so no follow-up `conversations get` or `messages list` call is needed (and neither works for
728
+ bubble/integration conversations).
729
+
730
+ EXAMPLES
731
+ $ chatbase conversations export -a agt_123
732
+
733
+ $ chatbase conversations export -a agt_123 --all -o export.json
734
+ ```
735
+
736
+ _See code: [src/commands/conversations/export.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/conversations/export.ts)_
737
+
738
+ ## `chatbase conversations get [CONVERSATIONID]`
739
+
740
+ Show one conversation
741
+
742
+ ```
743
+ USAGE
744
+ $ chatbase conversations get [CONVERSATIONID] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
745
+ [--agent-name <value> | -a <value>] [--conversation <value>]
746
+
747
+ ARGUMENTS
748
+ [CONVERSATIONID] Conversation ID (alternative to --conversation)
749
+
750
+ FLAGS
751
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
752
+ -q, --quiet Suppress non-essential output
753
+ --agent-name=<value> Agent display name (looked up to an ID)
754
+ --conversation=<value> Conversation ID
755
+ --no-color Disable colored output
756
+ --no-input Never prompt; fail instead
757
+ --verbose Verbose diagnostics
758
+
759
+ OUTPUT FLAGS
760
+ --json Output raw API JSON
761
+ --plain Tab-separated output for scripts
762
+
763
+ DESCRIPTION
764
+ Show one conversation
765
+
766
+ EXAMPLES
767
+ $ chatbase conversations get conv_123 -a agt_123
768
+
769
+ $ chatbase conversations get --conversation conv_123 -a agt_123
770
+ ```
771
+
772
+ _See code: [src/commands/conversations/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/conversations/get.ts)_
773
+
774
+ ## `chatbase conversations list`
775
+
776
+ List an agent’s API-created conversations
777
+
778
+ ```
779
+ USAGE
780
+ $ chatbase conversations list [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
781
+ <value>] [--limit <value>] [--cursor <value>] [--all] [--user <value>]
782
+
783
+ FLAGS
784
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
785
+ -q, --quiet Suppress non-essential output
786
+ --agent-name=<value> Agent display name (looked up to an ID)
787
+ --all Fetch every page
788
+ --cursor=<value> Pagination cursor from a previous page
789
+ --limit=<value> Maximum items per page
790
+ --no-color Disable colored output
791
+ --no-input Never prompt; fail instead
792
+ --user=<value> List conversations for a specific user (uses GET /users/{userId}/conversations)
793
+ --verbose Verbose diagnostics
794
+
795
+ OUTPUT FLAGS
796
+ --json Output raw API JSON
797
+ --plain Tab-separated output for scripts
798
+
799
+ DESCRIPTION
800
+ List an agent’s API-created conversations
801
+
802
+ List conversations for an agent, newest first.
803
+
804
+ Scope: the API v2 list endpoint returns only conversations created programmatically through the API. Conversations
805
+ from the chat bubble and external integrations (Slack, WhatsApp, Instagram, Messenger, and the like) are not
806
+ accessible here and are not counted in `total`. Use `chatbase conversations export` to read conversations from every
807
+ source — it also embeds full message history, which `conversations get` and `messages list` cannot retrieve for those
808
+ conversations.
809
+
810
+ EXAMPLES
811
+ $ chatbase conversations list -a agt_123
812
+
813
+ $ chatbase conversations list -a agt_123 --user usr_456
814
+
815
+ $ chatbase conversations list -a agt_123 --all --json
816
+ ```
817
+
818
+ _See code: [src/commands/conversations/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/conversations/list.ts)_
819
+
820
+ ## `chatbase health`
821
+
822
+ Check that the Chatbase API is reachable
823
+
824
+ ```
825
+ USAGE
826
+ $ chatbase health [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
827
+
828
+ FLAGS
829
+ -q, --quiet Suppress non-essential output
830
+ --no-color Disable colored output
831
+ --no-input Never prompt; fail instead
832
+ --verbose Verbose diagnostics
833
+
834
+ OUTPUT FLAGS
835
+ --json Output raw API JSON
836
+ --plain Tab-separated output for scripts
837
+
838
+ DESCRIPTION
839
+ Check that the Chatbase API is reachable
840
+
841
+ EXAMPLES
842
+ $ chatbase health
843
+
844
+ $ chatbase health --json
845
+ ```
846
+
847
+ _See code: [src/commands/health.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/health.ts)_
848
+
849
+ ## `chatbase help [COMMAND]`
850
+
851
+ Display help for chatbase.
852
+
853
+ ```
854
+ USAGE
855
+ $ chatbase help [COMMAND...] [-n]
856
+
857
+ ARGUMENTS
858
+ [COMMAND...] Command to show help for.
859
+
860
+ FLAGS
861
+ -n, --nested-commands Include all nested commands in the output.
862
+
863
+ DESCRIPTION
864
+ Display help for chatbase.
865
+ ```
866
+
867
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.58/src/commands/help.ts)_
868
+
869
+ ## `chatbase helpdesk statuses`
870
+
871
+ List ticket statuses for an agent
872
+
873
+ ```
874
+ USAGE
875
+ $ chatbase helpdesk statuses [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
876
+ <value>]
877
+
878
+ FLAGS
879
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
880
+ -q, --quiet Suppress non-essential output
881
+ --agent-name=<value> Agent display name (looked up to an ID)
882
+ --no-color Disable colored output
883
+ --no-input Never prompt; fail instead
884
+ --verbose Verbose diagnostics
885
+
886
+ OUTPUT FLAGS
887
+ --json Output raw API JSON
888
+ --plain Tab-separated output for scripts
889
+
890
+ DESCRIPTION
891
+ List ticket statuses for an agent
892
+
893
+ EXAMPLES
894
+ $ chatbase helpdesk statuses -a agt_123
895
+ ```
896
+
897
+ _See code: [src/commands/helpdesk/statuses.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/helpdesk/statuses.ts)_
898
+
899
+ ## `chatbase helpdesk teams`
900
+
901
+ List helpdesk teams for an agent
902
+
903
+ ```
904
+ USAGE
905
+ $ chatbase helpdesk teams [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
906
+ <value>]
907
+
908
+ FLAGS
909
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
910
+ -q, --quiet Suppress non-essential output
911
+ --agent-name=<value> Agent display name (looked up to an ID)
912
+ --no-color Disable colored output
913
+ --no-input Never prompt; fail instead
914
+ --verbose Verbose diagnostics
915
+
916
+ OUTPUT FLAGS
917
+ --json Output raw API JSON
918
+ --plain Tab-separated output for scripts
919
+
920
+ DESCRIPTION
921
+ List helpdesk teams for an agent
922
+
923
+ EXAMPLES
924
+ $ chatbase helpdesk teams -a agt_123
925
+ ```
926
+
927
+ _See code: [src/commands/helpdesk/teams.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/helpdesk/teams.ts)_
928
+
929
+ ## `chatbase messages feedback [MESSAGEID]`
930
+
931
+ Set or clear user feedback on an assistant message
932
+
933
+ ```
934
+ USAGE
935
+ $ chatbase messages feedback [MESSAGEID] --conversation <value> --rating positive|negative|clear [--json] [--plain]
936
+ [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a <value>] [--message <value>]
937
+
938
+ ARGUMENTS
939
+ [MESSAGEID] Message ID (alternative to --message)
940
+
941
+ FLAGS
942
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
943
+ -q, --quiet Suppress non-essential output
944
+ --agent-name=<value> Agent display name (looked up to an ID)
945
+ --conversation=<value> (required) Conversation ID
946
+ --message=<value> Message ID
947
+ --no-color Disable colored output
948
+ --no-input Never prompt; fail instead
949
+ --rating=<option> (required) Feedback value ("clear" removes existing feedback)
950
+ <options: positive|negative|clear>
951
+ --verbose Verbose diagnostics
952
+
953
+ OUTPUT FLAGS
954
+ --json Output raw API JSON
955
+ --plain Tab-separated output for scripts
956
+
957
+ DESCRIPTION
958
+ Set or clear user feedback on an assistant message
959
+
960
+ EXAMPLES
961
+ $ chatbase messages feedback msg_1 --conversation conv_123 --rating positive -a agt_123
962
+
963
+ $ chatbase messages feedback --conversation conv_123 --message msg_1 --rating clear -a agt_123
964
+ ```
965
+
966
+ _See code: [src/commands/messages/feedback.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/messages/feedback.ts)_
967
+
968
+ ## `chatbase messages list`
969
+
970
+ List messages in a conversation
971
+
972
+ ```
973
+ USAGE
974
+ $ chatbase messages list --conversation <value> [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
975
+ [--agent-name <value> | -a <value>] [--limit <value>] [--cursor <value>] [--all]
976
+
977
+ FLAGS
978
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
979
+ -q, --quiet Suppress non-essential output
980
+ --agent-name=<value> Agent display name (looked up to an ID)
981
+ --all Fetch every page
982
+ --conversation=<value> (required) Conversation ID
983
+ --cursor=<value> Pagination cursor from a previous page
984
+ --limit=<value> Maximum items per page
985
+ --no-color Disable colored output
986
+ --no-input Never prompt; fail instead
987
+ --verbose Verbose diagnostics
988
+
989
+ OUTPUT FLAGS
990
+ --json Output raw API JSON
991
+ --plain Tab-separated output for scripts
992
+
993
+ DESCRIPTION
994
+ List messages in a conversation
995
+
996
+ EXAMPLES
997
+ $ chatbase messages list --conversation conv_123 -a agt_123
998
+
999
+ $ chatbase messages list --conversation conv_123 -a agt_123 --all --json
1000
+ ```
1001
+
1002
+ _See code: [src/commands/messages/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/messages/list.ts)_
1003
+
1004
+ ## `chatbase sources create`
1005
+
1006
+ Create a source: text/qna/link (JSON) or a file upload
1007
+
1008
+ ```
1009
+ USAGE
1010
+ $ chatbase sources create [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
1011
+ <value>] [-f <value>...] [--type text|qna|link | --file <value>] [--name <value>] [--content <value>] [--url
1012
+ <value>] [--link-type individual|sitemap|crawl] [--data <value>]
1013
+
1014
+ FLAGS
1015
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1016
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
1017
+ -q, --quiet Suppress non-essential output
1018
+ --agent-name=<value> Agent display name (looked up to an ID)
1019
+ --content=<value> Text content for --type text (@file, @-, or inline)
1020
+ --data=<value> JSON body (@file, @-, or inline); per-type flags override matching keys
1021
+ --file=<value> Path to a file to upload as a source (mutually exclusive with --type)
1022
+ --link-type=<option> Link crawl mode for --type link
1023
+ <options: individual|sitemap|crawl>
1024
+ --name=<value> Source name (--type text/qna, or a file upload)
1025
+ --no-color Disable colored output
1026
+ --no-input Never prompt; fail instead
1027
+ --type=<option> JSON source type (mutually exclusive with --file)
1028
+ <options: text|qna|link>
1029
+ --url=<value> URL for --type link
1030
+ --verbose Verbose diagnostics
1031
+
1032
+ OUTPUT FLAGS
1033
+ --json Output raw API JSON
1034
+ --plain Tab-separated output for scripts
1035
+
1036
+ DESCRIPTION
1037
+ Create a source: text/qna/link (JSON) or a file upload
1038
+
1039
+ EXAMPLES
1040
+ $ chatbase sources create --type text --name Guide --content "hello" -a agt_123
1041
+
1042
+ $ chatbase sources create --type link --url https://example.com --link-type crawl -a agt_123
1043
+
1044
+ $ chatbase sources create --type qna --data '{"questions":["Q1"],"answer":"A1"}' -a agt_123
1045
+
1046
+ $ chatbase sources create --file ./guide.pdf -a agt_123
1047
+ ```
1048
+
1049
+ _See code: [src/commands/sources/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/create.ts)_
1050
+
1051
+ ## `chatbase sources delete SOURCEID`
1052
+
1053
+ Delete a source (restorable via restore command)
1054
+
1055
+ ```
1056
+ USAGE
1057
+ $ chatbase sources delete SOURCEID [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1058
+ <value> | -a <value>]
1059
+
1060
+ ARGUMENTS
1061
+ SOURCEID Source ID
1062
+
1063
+ FLAGS
1064
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1065
+ -q, --quiet Suppress non-essential output
1066
+ --agent-name=<value> Agent display name (looked up to an ID)
1067
+ --no-color Disable colored output
1068
+ --no-input Never prompt; fail instead
1069
+ --verbose Verbose diagnostics
1070
+
1071
+ OUTPUT FLAGS
1072
+ --json Output raw API JSON
1073
+ --plain Tab-separated output for scripts
1074
+
1075
+ DESCRIPTION
1076
+ Delete a source (restorable via restore command)
1077
+
1078
+ EXAMPLES
1079
+ $ chatbase sources delete src_1 -a agt_1
1080
+ ```
1081
+
1082
+ _See code: [src/commands/sources/delete.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/delete.ts)_
1083
+
1084
+ ## `chatbase sources get SOURCEID`
1085
+
1086
+ Show one source
1087
+
1088
+ ```
1089
+ USAGE
1090
+ $ chatbase sources get SOURCEID [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1091
+ <value> | -a <value>]
1092
+
1093
+ ARGUMENTS
1094
+ SOURCEID Source ID
1095
+
1096
+ FLAGS
1097
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1098
+ -q, --quiet Suppress non-essential output
1099
+ --agent-name=<value> Agent display name (looked up to an ID)
1100
+ --no-color Disable colored output
1101
+ --no-input Never prompt; fail instead
1102
+ --verbose Verbose diagnostics
1103
+
1104
+ OUTPUT FLAGS
1105
+ --json Output raw API JSON
1106
+ --plain Tab-separated output for scripts
1107
+
1108
+ DESCRIPTION
1109
+ Show one source
1110
+
1111
+ EXAMPLES
1112
+ $ chatbase sources get src_123 -a agt_123
1113
+ ```
1114
+
1115
+ _See code: [src/commands/sources/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/get.ts)_
1116
+
1117
+ ## `chatbase sources list`
1118
+
1119
+ List sources for an agent
1120
+
1121
+ ```
1122
+ USAGE
1123
+ $ chatbase sources list [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
1124
+ <value>] [--limit <value>] [--cursor <value>] [--all] [--type <value>] [--name <value>]
1125
+
1126
+ FLAGS
1127
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1128
+ -q, --quiet Suppress non-essential output
1129
+ --agent-name=<value> Agent display name (looked up to an ID)
1130
+ --all Fetch every page
1131
+ --cursor=<value> Pagination cursor from a previous page
1132
+ --limit=<value> Maximum items per page
1133
+ --name=<value> Filter by source name
1134
+ --no-color Disable colored output
1135
+ --no-input Never prompt; fail instead
1136
+ --type=<value> Filter by source type
1137
+ --verbose Verbose diagnostics
1138
+
1139
+ OUTPUT FLAGS
1140
+ --json Output raw API JSON
1141
+ --plain Tab-separated output for scripts
1142
+
1143
+ DESCRIPTION
1144
+ List sources for an agent
1145
+
1146
+ EXAMPLES
1147
+ $ chatbase sources list -a agt_123
1148
+
1149
+ $ chatbase sources list -a agt_123 --all --json
1150
+ ```
1151
+
1152
+ _See code: [src/commands/sources/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/list.ts)_
1153
+
1154
+ ## `chatbase sources restore SOURCEID`
1155
+
1156
+ Restore a deleted source
1157
+
1158
+ ```
1159
+ USAGE
1160
+ $ chatbase sources restore SOURCEID [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1161
+ <value> | -a <value>]
1162
+
1163
+ ARGUMENTS
1164
+ SOURCEID Source ID
1165
+
1166
+ FLAGS
1167
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1168
+ -q, --quiet Suppress non-essential output
1169
+ --agent-name=<value> Agent display name (looked up to an ID)
1170
+ --no-color Disable colored output
1171
+ --no-input Never prompt; fail instead
1172
+ --verbose Verbose diagnostics
1173
+
1174
+ OUTPUT FLAGS
1175
+ --json Output raw API JSON
1176
+ --plain Tab-separated output for scripts
1177
+
1178
+ DESCRIPTION
1179
+ Restore a deleted source
1180
+
1181
+ EXAMPLES
1182
+ $ chatbase sources restore src_1 -a agt_1
1183
+ ```
1184
+
1185
+ _See code: [src/commands/sources/restore.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/restore.ts)_
1186
+
1187
+ ## `chatbase sources summary`
1188
+
1189
+ Show aggregated source counts and sizes for an agent
1190
+
1191
+ ```
1192
+ USAGE
1193
+ $ chatbase sources summary [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
1194
+ <value>]
1195
+
1196
+ FLAGS
1197
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1198
+ -q, --quiet Suppress non-essential output
1199
+ --agent-name=<value> Agent display name (looked up to an ID)
1200
+ --no-color Disable colored output
1201
+ --no-input Never prompt; fail instead
1202
+ --verbose Verbose diagnostics
1203
+
1204
+ OUTPUT FLAGS
1205
+ --json Output raw API JSON
1206
+ --plain Tab-separated output for scripts
1207
+
1208
+ DESCRIPTION
1209
+ Show aggregated source counts and sizes for an agent
1210
+
1211
+ EXAMPLES
1212
+ $ chatbase sources summary -a agt_123
1213
+ ```
1214
+
1215
+ _See code: [src/commands/sources/summary.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/summary.ts)_
1216
+
1217
+ ## `chatbase sources update SOURCEID`
1218
+
1219
+ Update an existing source (text, qna, link, or file)
1220
+
1221
+ ```
1222
+ USAGE
1223
+ $ chatbase sources update SOURCEID [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1224
+ <value> | -a <value>] [-f <value>...] [--data <value> | --file <value>]
1225
+
1226
+ ARGUMENTS
1227
+ SOURCEID Source ID
1228
+
1229
+ FLAGS
1230
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1231
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
1232
+ -q, --quiet Suppress non-essential output
1233
+ --agent-name=<value> Agent display name (looked up to an ID)
1234
+ --data=<value> JSON body for text/qna/link sources (@file, @-, or inline)
1235
+ --file=<value> Path to a file to upload as a replacement (mutually exclusive with --data)
1236
+ --no-color Disable colored output
1237
+ --no-input Never prompt; fail instead
1238
+ --verbose Verbose diagnostics
1239
+
1240
+ OUTPUT FLAGS
1241
+ --json Output raw API JSON
1242
+ --plain Tab-separated output for scripts
1243
+
1244
+ DESCRIPTION
1245
+ Update an existing source (text, qna, link, or file)
1246
+
1247
+ EXAMPLES
1248
+ $ chatbase sources update src_1 --data '{"type":"text","content":"new"}' -a agt_1
1249
+
1250
+ $ chatbase sources update src_1 --file ./updated.pdf -a agt_1
1251
+ ```
1252
+
1253
+ _See code: [src/commands/sources/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/sources/update.ts)_
1254
+
1255
+ ## `chatbase tickets create`
1256
+
1257
+ Create a helpdesk ticket
1258
+
1259
+ ```
1260
+ USAGE
1261
+ $ chatbase tickets create [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
1262
+ <value>] [-f <value>...] [--subject <value>] [--customer-name <value> --customer-email <value>] [--data <value>]
1263
+
1264
+ FLAGS
1265
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1266
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
1267
+ -q, --quiet Suppress non-essential output
1268
+ --agent-name=<value> Agent display name (looked up to an ID)
1269
+ --customer-email=<value> Customer email — builds the required customer object (alternative to customer in --data)
1270
+ --customer-name=<value> Customer display name, used only when the email creates a new customer record
1271
+ --data=<value> JSON body (@file, @-, or inline). Fields: subject, description, customer, statusId,
1272
+ statusCategory, assigneeId, assigneeEmail, teamId
1273
+ --no-color Disable colored output
1274
+ --no-input Never prompt; fail instead
1275
+ --subject=<value> Ticket subject
1276
+ --verbose Verbose diagnostics
1277
+
1278
+ OUTPUT FLAGS
1279
+ --json Output raw API JSON
1280
+ --plain Tab-separated output for scripts
1281
+
1282
+ DESCRIPTION
1283
+ Create a helpdesk ticket
1284
+
1285
+ EXAMPLES
1286
+ $ chatbase tickets create --subject "Export failing" -f description="Customer cannot export." --customer-email jane@example.com -a agt_123
1287
+
1288
+ $ chatbase tickets create --subject "Export failing" --data '{"description":"Customer cannot export.","customer":{"email":"jane@example.com"}}' -a agt_123
1289
+ ```
1290
+
1291
+ _See code: [src/commands/tickets/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/create.ts)_
1292
+
1293
+ ## `chatbase tickets get TICKETNUMBER`
1294
+
1295
+ Show one helpdesk ticket
1296
+
1297
+ ```
1298
+ USAGE
1299
+ $ chatbase tickets get TICKETNUMBER [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1300
+ <value> | -a <value>]
1301
+
1302
+ ARGUMENTS
1303
+ TICKETNUMBER Ticket number
1304
+
1305
+ FLAGS
1306
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1307
+ -q, --quiet Suppress non-essential output
1308
+ --agent-name=<value> Agent display name (looked up to an ID)
1309
+ --no-color Disable colored output
1310
+ --no-input Never prompt; fail instead
1311
+ --verbose Verbose diagnostics
1312
+
1313
+ OUTPUT FLAGS
1314
+ --json Output raw API JSON
1315
+ --plain Tab-separated output for scripts
1316
+
1317
+ DESCRIPTION
1318
+ Show one helpdesk ticket
1319
+
1320
+ EXAMPLES
1321
+ $ chatbase tickets get 42 -a agt_123
1322
+ ```
1323
+
1324
+ _See code: [src/commands/tickets/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/get.ts)_
1325
+
1326
+ ## `chatbase tickets list`
1327
+
1328
+ List helpdesk tickets for an agent
1329
+
1330
+ ```
1331
+ USAGE
1332
+ $ chatbase tickets list [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
1333
+ <value>] [--limit <value>] [--cursor <value>] [--all] [--status <value>] [--channel <value>] [--assignee-id <value>]
1334
+ [--team-id <value>] [--created-after <value>] [--created-before <value>] [--sort-by
1335
+ createdAt|updatedAt|lastMessageAt] [--order asc|desc] [--include-total]
1336
+
1337
+ FLAGS
1338
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1339
+ -q, --quiet Suppress non-essential output
1340
+ --agent-name=<value> Agent display name (looked up to an ID)
1341
+ --all Fetch every page
1342
+ --assignee-id=<value> Filter by assignee UUID, or "none" for unassigned
1343
+ --channel=<value> Filter by channel (comma-separated, e.g. email,api)
1344
+ --created-after=<value> Only tickets created after this ISO 8601 date
1345
+ --created-before=<value> Only tickets created before this ISO 8601 date
1346
+ --cursor=<value> Pagination cursor from a previous page
1347
+ --include-total Include pagination.total in the response
1348
+ --limit=<value> Maximum items per page
1349
+ --no-color Disable colored output
1350
+ --no-input Never prompt; fail instead
1351
+ --order=<option> Sort direction
1352
+ <options: asc|desc>
1353
+ --sort-by=<option> Sort field
1354
+ <options: createdAt|updatedAt|lastMessageAt>
1355
+ --status=<value> Filter by status (comma-separated): new, on_you, on_customer, on_hold, closed, cancelled
1356
+ --team-id=<value> Filter by team UUID, or "none" for no team
1357
+ --verbose Verbose diagnostics
1358
+
1359
+ OUTPUT FLAGS
1360
+ --json Output raw API JSON
1361
+ --plain Tab-separated output for scripts
1362
+
1363
+ DESCRIPTION
1364
+ List helpdesk tickets for an agent
1365
+
1366
+ EXAMPLES
1367
+ $ chatbase tickets list -a agt_123
1368
+
1369
+ $ chatbase tickets list -a agt_123 --status new,on_you
1370
+
1371
+ $ chatbase tickets list -a agt_123 --all --json
1372
+ ```
1373
+
1374
+ _See code: [src/commands/tickets/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/list.ts)_
1375
+
1376
+ ## `chatbase tickets messages [TICKETNUMBER]`
1377
+
1378
+ List a ticket's message thread
1379
+
1380
+ ```
1381
+ USAGE
1382
+ $ chatbase tickets messages [TICKETNUMBER] [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
1383
+ [--agent-name <value> | -a <value>] [--limit <value>] [--cursor <value>] [--all] [--ticket <value>] [--types
1384
+ <value>] [--order asc|desc]
1385
+
1386
+ ARGUMENTS
1387
+ [TICKETNUMBER] Ticket number (alternative to --ticket)
1388
+
1389
+ FLAGS
1390
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1391
+ -q, --quiet Suppress non-essential output
1392
+ --agent-name=<value> Agent display name (looked up to an ID)
1393
+ --all Fetch every page
1394
+ --cursor=<value> Pagination cursor from a previous page
1395
+ --limit=<value> Maximum items per page
1396
+ --no-color Disable colored output
1397
+ --no-input Never prompt; fail instead
1398
+ --order=<option> Sort direction
1399
+ <options: asc|desc>
1400
+ --ticket=<value> Ticket number
1401
+ --types=<value> Message types to include (comma-separated): reply, note, event (default: reply,note)
1402
+ --verbose Verbose diagnostics
1403
+
1404
+ OUTPUT FLAGS
1405
+ --json Output raw API JSON
1406
+ --plain Tab-separated output for scripts
1407
+
1408
+ DESCRIPTION
1409
+ List a ticket's message thread
1410
+
1411
+ EXAMPLES
1412
+ $ chatbase tickets messages 42 -a agt_123
1413
+
1414
+ $ chatbase tickets messages 42 -a agt_123 --all --json
1415
+ ```
1416
+
1417
+ _See code: [src/commands/tickets/messages.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/messages.ts)_
1418
+
1419
+ ## `chatbase tickets reply [TICKETNUMBER]`
1420
+
1421
+ Post an agent reply to a ticket's message thread
1422
+
1423
+ ```
1424
+ USAGE
1425
+ $ chatbase tickets reply [TICKETNUMBER] -m <value> [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color]
1426
+ [--agent-name <value> | -a <value>] [--ticket <value>] [--author-id <value>] [--author-email <value>]
1427
+
1428
+ ARGUMENTS
1429
+ [TICKETNUMBER] Ticket number (alternative to --ticket)
1430
+
1431
+ FLAGS
1432
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1433
+ -m, --message=<value> (required) Reply body as GitHub-flavored Markdown
1434
+ -q, --quiet Suppress non-essential output
1435
+ --agent-name=<value> Agent display name (looked up to an ID)
1436
+ --author-email=<value> Email of the team member the reply is attributed to (exactly one of
1437
+ --author-id/--author-email)
1438
+ --author-id=<value> Platform user id of the team member the reply is attributed to (exactly one of
1439
+ --author-id/--author-email)
1440
+ --no-color Disable colored output
1441
+ --no-input Never prompt; fail instead
1442
+ --ticket=<value> Ticket number
1443
+ --verbose Verbose diagnostics
1444
+
1445
+ OUTPUT FLAGS
1446
+ --json Output raw API JSON
1447
+ --plain Tab-separated output for scripts
1448
+
1449
+ DESCRIPTION
1450
+ Post an agent reply to a ticket's message thread
1451
+
1452
+ EXAMPLES
1453
+ $ chatbase tickets reply 42 -m "On it" --author-email sam@example.com -a agt_123
1454
+ ```
1455
+
1456
+ _See code: [src/commands/tickets/reply.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/reply.ts)_
1457
+
1458
+ ## `chatbase tickets search QUERY`
1459
+
1460
+ Search tickets by message content
1461
+
1462
+ ```
1463
+ USAGE
1464
+ $ chatbase tickets search QUERY [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1465
+ <value> | -a <value>] [--limit <value>]
1466
+
1467
+ ARGUMENTS
1468
+ QUERY Free-text search terms (matched against ticket messages)
1469
+
1470
+ FLAGS
1471
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1472
+ -q, --quiet Suppress non-essential output
1473
+ --agent-name=<value> Agent display name (looked up to an ID)
1474
+ --limit=<value> Number of results (1–50, default 20)
1475
+ --no-color Disable colored output
1476
+ --no-input Never prompt; fail instead
1477
+ --verbose Verbose diagnostics
1478
+
1479
+ OUTPUT FLAGS
1480
+ --json Output raw API JSON
1481
+ --plain Tab-separated output for scripts
1482
+
1483
+ DESCRIPTION
1484
+ Search tickets by message content
1485
+
1486
+ EXAMPLES
1487
+ $ chatbase tickets search "refund not received" -a agt_123
1488
+
1489
+ $ chatbase tickets search "refund" -a agt_123 --limit 10 --json
1490
+ ```
1491
+
1492
+ _See code: [src/commands/tickets/search.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/search.ts)_
1493
+
1494
+ ## `chatbase tickets update TICKETNUMBER`
1495
+
1496
+ Update a ticket's status, assignee, and/or team
1497
+
1498
+ ```
1499
+ USAGE
1500
+ $ chatbase tickets update TICKETNUMBER [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name
1501
+ <value> | -a <value>] [-f <value>...] [--data <value>]
1502
+
1503
+ ARGUMENTS
1504
+ TICKETNUMBER Ticket number
1505
+
1506
+ FLAGS
1507
+ -a, --agent=<value> Agent ID (or set CHATBASE_AGENT_ID)
1508
+ -f, --field=<value>... Set a body field: -f key=value (repeatable)
1509
+ -q, --quiet Suppress non-essential output
1510
+ --agent-name=<value> Agent display name (looked up to an ID)
1511
+ --data=<value> JSON body (@file, @-, or inline). Fields: statusId, statusCategory, assigneeId,
1512
+ assigneeEmail, teamId
1513
+ --no-color Disable colored output
1514
+ --no-input Never prompt; fail instead
1515
+ --verbose Verbose diagnostics
1516
+
1517
+ OUTPUT FLAGS
1518
+ --json Output raw API JSON
1519
+ --plain Tab-separated output for scripts
1520
+
1521
+ DESCRIPTION
1522
+ Update a ticket's status, assignee, and/or team
1523
+
1524
+ EXAMPLES
1525
+ $ chatbase tickets update 42 --data '{"statusCategory":"closed"}' -a agt_123
1526
+ ```
1527
+
1528
+ _See code: [src/commands/tickets/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.1.0/src/commands/tickets/update.ts)_
1529
+ <!-- commandsstop -->