diff --git a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt index 4cc21a34..1fbd272c 100644 --- a/.vale/styles/config/vocabularies/botpress-vocab/accept.txt +++ b/.vale/styles/config/vocabularies/botpress-vocab/accept.txt @@ -55,4 +55,11 @@ Airtable Persat Mintlify Sharepoint -Chatwoot \ No newline at end of file +Chatwoot +[Ee]vals? +[Ee]val +ADK +gitignored +stdout +helpdesk +Kommo \ No newline at end of file diff --git a/adk/ai-native/skills.mdx b/adk/ai-native/skills.mdx index 5379036f..1d5af5f8 100644 --- a/adk/ai-native/skills.mdx +++ b/adk/ai-native/skills.mdx @@ -32,12 +32,12 @@ Or install as a Claude Code plugin: | Skill | What it teaches | Use when | |-------|----------------|----------| -| **adk** | Core ADK framework: actions, tools, workflows, conversations, tables, knowledge, triggers, Zai, configuration | Building any feature with the ADK | -| **adk-debugger** | Trace reading, log analysis, common failure diagnosis, the debug loop | Bot isn't responding, tools failing, workflows stuck, LLM issues | -| **adk-evals** | Eval file format, all assertion types, CLI usage, per-primitive testing patterns | Writing and running automated tests | -| **adk-frontend** | Authentication, type generation, client setup, calling bot actions from React/Next.js | Building a frontend that connects to your bot | -| **adk-integrations** | Discovery, adding, configuring, and using integrations end-to-end | Connecting Slack, WhatsApp, Linear, or any integration | -| **adk-docs** | Documentation standards, creation, review, and maintenance | Writing or updating docs for your bot | +| **`adk`** | Core ADK framework: actions, tools, workflows, conversations, tables, knowledge, triggers, Zai, configuration | Building any feature with the ADK | +| **`adk-debugger`** | Trace reading, log analysis, common failure diagnosis, the debug loop | Bot isn't responding, tools failing, workflows stuck, LLM issues | +| **`adk-evals`** | Eval file format, all assertion types, CLI usage, per-primitive testing patterns | Writing and running automated tests | +| **`adk-frontend`** | Authentication, type generation, client setup, calling bot actions from React/Next.js | Building a frontend that connects to your bot | +| **`adk-integrations`** | Discovery, adding, configuring, and using integrations end-to-end | Connecting Slack, WhatsApp, Linear, or any integration | +| **`adk-docs`** | Documentation standards, creation, review, and maintenance | Writing or updating docs for your bot | ## Slash commands diff --git a/adk/cli-reference.mdx b/adk/cli-reference.mdx index a9987052..66f8a8a0 100644 --- a/adk/cli-reference.mdx +++ b/adk/cli-reference.mdx @@ -14,7 +14,7 @@ These flags work with every command: | `--help`, `-h` | Show help information | | `--version`, `-V` | Show version number | | `--no-cache` | Disable caching for integration lookups | -| `--profile ` | Credentials profile to use (overrides the `ADK_PROFILE` env var and the current profile) | +| `--profile ` | Credentials profile to use (overrides the `ADK_PROFILE` environment variable and the current profile) | Most commands also accept `--format json` for machine-readable output. The following commands don't: `dev`, `login`, `profiles list`, `profiles set`, `upgrade`, `remove`, `self-upgrade`, `telemetry`, `theme`, `mcp`, `mcp:init`, `run`, `assets pull`. @@ -32,7 +32,7 @@ These commands manage an agent project from scaffold to deploy: | `adk status` | Show project status, integrations, and server state | | `adk link` | Link local agent to a workspace and bot | -### adk init +### `adk init` Scaffold a new agent project. Pass a name, or omit it to be prompted: @@ -49,7 +49,7 @@ adk init --list-templates | `--skip-link` | Skip the linking step | | `--list-templates` | List available templates and exit | -### adk dev +### `adk dev` Start the dev server with hot reload: @@ -67,7 +67,7 @@ adk dev --port 3000 --port-console 3001 | `-v, --verbose` | Show additional details | | | `--non-interactive` | Emit structured NDJSON events to stdout | | -### adk deploy +### `adk deploy` Deploy the built agent to Botpress Cloud: @@ -81,7 +81,7 @@ adk deploy -y | `-e, --env ` | Deployment environment | `production` | | `-y, --yes` | Auto-approve preflight changes | | -### adk link +### `adk link` Link the local agent to a workspace and bot. Writes to `agent.json`, or to `agent.local.json` with `--local`: @@ -112,7 +112,7 @@ These commands add, inspect, and manage the integrations your agent depends on: | `adk list` | List installed integrations | | `adk info ` | Show detailed integration info | -### adk add +### `adk add` Add an integration or interface to your agent. Accepts a name, `workspace/name`, or a specific version: @@ -129,7 +129,7 @@ adk add webchat --alias custom-webchat |------|-------------| | `--alias ` | Custom alias for the resource | -### adk search +### `adk search` Search the Botpress Hub for integrations: @@ -142,7 +142,7 @@ adk search slack --limit 5 |------|-------------|---------| | `--limit ` | Max results to return | `20` | -### adk list +### `adk list` List integrations in your project, or all available ones on the Hub: @@ -156,7 +156,7 @@ adk list --available | `--available` | List all available integrations (not just installed) | | | `--limit ` | Max results | `50` | -### adk info +### `adk info` Show details for a specific integration. Filter by a single facet or show the full spec: @@ -199,7 +199,7 @@ These commands let you send messages to your agent and run eval suites: | `adk evals [name]` | Run eval suites | | `adk evals runs [runId]` | List or show eval run history | -### adk chat +### `adk chat` Open an interactive chat, or send a single message with `--single`. Requires `adk dev` to be running: @@ -215,7 +215,7 @@ adk chat --single "Follow up" --conversation-id | `--conversation-id ` | Continue a conversation | | | `--timeout ` | Max wait duration | `60s` | -### adk evals +### `adk evals` Run eval suites. With no arguments, runs all evals; pass a name to run just one: @@ -235,7 +235,7 @@ adk evals -v | `-v, --verbose` | Show full details for all evals | | | `--server ` | Dev server URL | `http://localhost:3001` | -### adk evals runs +### `adk evals runs` List past eval runs, or show the details of a specific one: @@ -261,7 +261,7 @@ These commands discover and run workflows against the local dev server: | `adk workflows inspect ` | Inspect a workflow schema and metadata | | `adk workflows run [payload]` | Run a workflow | -### adk workflows run +### `adk workflows run` Run a workflow with a JSON payload. Add `--wait` to block until it finishes: @@ -285,7 +285,7 @@ These commands help you inspect what your agent is doing: | `adk traces [tokens...]` | Query trace data | | `adk run