UNPKG

@botpress/adk-cli

Version:

Command-line interface for the Botpress Agent Development Kit (ADK)

github.com/botpress/adk

botpress/adk

71 lines (44 loc) • 3.66 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Multi-Agent Dashboard The Dev Console is a **singleton shared dashboard** that coordinates multiple running agents. Each `adk dev` process registers its agent with the shared DevConsole, and the UI lets developers switch between them instantly. ## How It Works Running `adk dev` in multiple project directories registers each agent with a single shared DevConsole. The UI automatically updates to show all running agents, and developers can switch between them from the sidebar. Each agent shows a status indicator: | Status | Meaning | | ---------- | ----------------------------------------- | | `starting` | Agent is initializing (building, syncing) | | `ready` | Agent is running and accepting requests | | `error` | Agent encountered a fatal error | If all agents are stopped, the DevConsole exits automatically (unless started in standalone mode via `adk dashboard`). ## Console Modes The Dev Console supports two orthogonal concepts: ### Console Mode — where is the console operating? - **Local Dev Console** — selects a local project registered over the socket. This is the default during `adk dev`. - **Cloud Dev Console** — selects a deployed Botpress Cloud prod bot from the prod bot picker. No local project backend needed. ### Target — which bot data is used? - **Dev target** — uses the local project's dev bot ID and local backend. All pages available. - **Prod target** — uses the deployed prod bot data. Hides dev-only pages (Actions, Workflows, Triggers, Evals, Files, Conversations, Traces, Logs). | Console Mode | Dev Target | Prod Target | | ------------ | ------------------------- | -------------------------------- | | Local | Local dev bot + all pages | Prod bot data + restricted pages | | Cloud | Not available | Prod bot data + restricted pages | Prod views that need ADK source-shaped definitions (actions, workflows, triggers, tables, knowledge) read **deployed metadata** published by `adk deploy`, not local source files. This is true in both local-prod and cloud-prod modes. ## Agent Selector UI ### Sidebar Header Full-width dropdown trigger showing: ADK logo, status ring (color matches agent status), agent name, mode pill (dev/prod/cloud), chevron. ### Dropdown Content - **Active agents section** — lists running local agents with status dot, name, project path (truncated right-to-left), and close button - **Cloud Dev Console** — switches to the prod bot picker (workspace dropdown → bot list), shows recent prod bots - **Recent projects** — projects previously opened but not currently running - **Footer actions** — Create new project, Open existing project, Switch environment (dev↔prod), About ### Topbar Agent Picker Compact pill in the top navigation center: status dot + agent name + mode pill + chevron. Opens the same dropdown content. Falls back to a non-interactive label if no agents are connected. ## CLI Commands See the [CLI Reference](../../adk/references/cli.md) for full options and examples. | Command | What it does | | --------------- | --------------------------------- | | `adk ps` | List running agents and processes | | `adk dashboard` | Open Dev Console without an agent | | `adk kill` | Stop agents or the Dev Console | | `adk status` | Show project health info | ## Data Isolation Each agent's data is isolated to its own project directory (`.adk/`). Traces, logs, eval results, and dev bot IDs stay per-project — switching agents in the UI switches the data you see.