@botpress/adk-cli

# Dev Console Pages Every page accessible from the ADK Dev Console at `http://localhost:3001`. Pages marked **(dev only)** are hidden when the environment toggle is set to Production. Pages marked **(experimental)** are behind a feature flag and may change. --- ## Multi-Agent Navigation The Dev Console is a shared singleton — multiple `adk dev` agents register with one UI server. The sidebar agent selector switches between running agents, and the environment toggle switches between dev and prod targets. See [multi-agent-dashboard.md](./multi-agent-dashboard.md) for details. --- ## Chat (`/chat`) Real-time conversation interface for testing the agent. **Layout:** Webchat embed (left) + Agent Steps visualization (right) **Features:** - Webchat panel for sending messages to the agent - Agent Steps panel showing execution flow (see `agent-steps.md`) - Conversation picker dropdown (filters to webchat conversations) - "Open conversation traces" link to jump to full Traces view - Download transcript button - Agent(0) side panel can show a **Tasks** dock when Agent(0) emits todo-tool updates: collapsed progress count, active task text, and an expandable list with status and priority. --- ## Agent Map (`/agent-map`) — dev only, experimental Interactive bird's-eye visualization of the agent's architecture as a graph. Feature-flagged behind `enable_agent_forge`. **Layout:** Full-screen React Flow canvas with auto-layout (elkjs) + detail panel **Features:** - Graph nodes for agent primitives: triggers, actions, workflows, autonomous handlers, knowledge bases, tables - Edges showing relationships between primitives - Auto-layout with elkjs; user can drag nodes (positions persist to localStorage per agent) - Detail panel: click a node to inspect metadata (description, knowledge counts, table schemas) - Hover cards with node summary - Change pulse animation when the agent snapshot updates (e.g., after file save) - Data from `/api/agent-map/snapshot` (one-shot) and `/api/agent-map/stream` (SSE for live updates) - "Experimental feature" badge — the map is compiled by parsing code and may be incomplete or inaccurate --- ## Components ### Webchat Components (`/components`) Browse the component registry and inspect components installed in the agent. **Layout:** Two-tab interface (Installed / Registry) + masonry card grid + detail overlay **Tabs:** **Installed** — Components present in the agent's `src/components/` directory: - Masonry card layout with component preview (rendered in shadow DOM) - Click a card to open overlay with full details - Empty state: "No components installed yet" with guidance **Registry** — Available components from the external component registry: - Same masonry layout - Click a card to open overlay with installation instructions and metadata - Empty state: "Registry is empty" **Features:** - Live reload on component source changes - Preview rendering via shadow DOM isolation - Error states for load/fetch failures - Loading skeletons while fetching See `component-registry.md` for details on the registry model and component lifecycle. ### Actions (`/actions`) — dev only Browse and test bot actions and integration actions. **Layout:** Sidebar (action list) + detail pane **Features:** - Bot custom actions with input/output schema visualization - Integration actions grouped by integration (icon, title, description) - "Invoke action" button opens a modal to test with live inputs - Schema view for input/output types ### Workflows (`/workflows`) — dev only Browse workflows and view execution history. **Layout:** Sidebar (workflow list) + detail pane **Features:** - Workflow name, path, description, timeout badge - "Invoke workflow" button to trigger manually - Workflow definition schema - **Runs tab** (`/workflows/runs`): execution history table with status, duration, timestamp - Click a run to open WorkflowRunDetail modal ### Triggers (`/triggers`) — dev only Browse event triggers defined in the agent. **Layout:** Sidebar (trigger list) + detail pane **Features:** - Trigger names and event types - Trigger metadata and status --- ## Test ### RAG Search (`/search`) Test knowledge base search interactively. **Layout:** Sidebar (KB filter + content tree) + search input + results area + detail drawer **Features:** - Dropdown to filter by specific knowledge base - Query input with advanced settings (result limit, context depth) - Search results as cards: relevance score, source file, text snippet - Content tree sidebar showing hierarchical KB structure - Click a result to open detail drawer with full document + highlighted passages - Real-time search as you type ### Evals (`/evals`) — dev only Run and inspect automated conversation tests. **Layout:** Sidebar (eval list) + detail pane **Features:** - Eval definitions with run history - Run status: pending, in-progress, completed - Per-turn assertion results with pass/fail badges - Assertion types: response content, tool usage, state changes, table data, workflow triggers - Outcome summary (passed/failed/pending counts) - Elapsed time, turn counts - **Runs tab** (`/evals/runs`): run history with timestamps and status - Download results button --- ## Data ### Knowledge (`/knowledge`) Manage knowledge bases and uploaded files. **Layout:** Sidebar (KB list) + toolbar + file grid **Features:** - Knowledge base list with icons and descriptions - File grid: name, size, upload date, status badge (synced/syncing/error/local) - Filter by name, source, status, date range - Sort by name, date, or size - File detail drawer: metadata, embedding status, delete/sync/copy path - KB sync dialog to upload and sync files - "Add knowledge connector" opens the connector panel. In dev, if the project has no KBs yet, the empty state can create `src/knowledge/connectors.ts` and sync a `connectors` KB first. - Connector file selection accepts `.pdf`, `.html`, `.htm`, `.txt`, `.doc`, `.docx`, `.md`, `.mdx`, and extensionless provider files. - Pagination for large file lists ### Tables (`/tables`) Manage agent data tables. **Layout:** Sidebar (table list) + toolbar + data grid + pagination **Features:** - Table definitions with row counts - Sortable, filterable data grid (100 rows/page) - Add/edit/delete rows - Import/export data - "Transfer to prod" option (with confirmation modal) - "Recreate table" for schema changes - Column headers with sort indicators ### Files (`/files`) — dev only Browse agent files. **Layout:** Folder browser **Features:** - Folder tree: All Files, Knowledge Base, System, Webchat - File list with name, size, modification time - Copy file path button - Hover cards with full file info - Browser-style navigation (back/forward/refresh) --- ## Observe ### Conversations (`/conversations`) — dev only View all conversations with the agent. **Layout:** Conversation table + read-only detail viewer **Features:** - Table columns: ID, Integration → Channel, Created, Updated, Preview - Sortable columns - Real-time polling for new conversations - Click row to inspect a live transcript without sending messages ### Traces (`/traces`) — dev only Deep execution trace inspection. More detailed than Agent Steps — shows the full span tree including internal runtime spans. **Layout:** Full-page trace viewer **Features:** - Hierarchical span tree grouped by parent - Span detail panel: name, timing, status, full data payload - JSON and tree view of span data - Filter by trace ID or conversation ID - Auto-refresh - Trace-level cost calculation - Timeline visualization showing concurrent spans ### Logs (`/logs`) — dev only Agent runtime logs. **Layout:** Full-page log viewer **Features:** - Real-time log stream (stdout, stderr, info) - Time range filters: 5m, 15m, 1h, 6h, all - Text search/filter - Color-coded: green (stdout), red (stderr), blue (info) - ANSI color support (terminal-style rendering) - Pause/play, clear, copy buttons - Collapsible JSON payload inspection --- ## Config ### Settings (`/settings`) Agent configuration management. **Sections (sidebar navigation):** 1. **Overview** — Agent metadata: name, Bot ID, Workspace ID, file path, created/updated dates. Copy buttons for IDs. 2. **Configuration Variables** (dev only) — Runtime config schema and values. Add/edit/delete variables. 3. **Secrets** — Secret schema and set/unset status for the selected target. Dev values are local; prod values are remote and write-only. Add/edit/delete declared secret values. 4. **LLM Config** (dev only) — Model selection and parameters. ### Integrations (`/integrations`) Install, configure, and manage integrations. **Features:** - Integration Hub UI (Botpress component) - OAuth redirect handling - Integration name and alias resolution - Configuration editing via UI - Installation status per integration - Configured integrations' actions appear on the Actions page - Dependency actions for comparing dev/prod state and promoting reviewed changes - In Cloud Console mode, install/uninstall/upgrade controls are disabled; finish config/auth in the Hub or disable/remove the dependency from the owning environment. ### Deploy Dialog The deploy dialog computes the same deploy plan as `adk deploy`. **Warnings and blockers:** - Missing required prod secrets warn by default. Deploy does not write secret values; use `adk secret:set <KEY> <value> --prod` or Settings -> Secrets to set them. CI can require them with `adk deploy --require-secrets`. - Enabled dependencies that are unavailable, unconfigured, or unresolved block deploy. - Integration version mismatches are non-blocking: if dev and prod have the same alias/name but different versions, the dialog shows a warning and points to Integrations dependency actions for Compare Dev vs Prod and Promote Dev to Prod. - Destructive table, KB, or asset changes require explicit confirmation. --- ## Dev vs. Production Mode The environment toggle in the top navigation switches between dev and prod: **Dev mode** (default during `adk dev`): All pages and features available. **Production mode**: Hides development-only pages (Actions, Workflows, Triggers, Evals, Files, Conversations, Traces, Logs) and restricts some Settings sections. Chat, Search, Knowledge, Tables, Integrations, and Settings Overview remain available.