diff --git a/adk/cli-reference.mdx b/adk/cli-reference.mdx index bee89212..431b9bb7 100644 --- a/adk/cli-reference.mdx +++ b/adk/cli-reference.mdx @@ -101,54 +101,56 @@ adk link --workspace wkspace_123 --bot bot_456 ## Integrations -These commands add, inspect, and manage the integrations your agent depends on: +These commands add, inspect, and manage the integrations your agent depends on. They are grouped under `adk integrations`, `adk plugins`, and `adk interfaces`: | Command | Description | |---------|-------------| -| `adk add ` | Add an integration or interface (aliases: `i`, `install`) | -| `adk remove [resource]` | Remove an integration, interface, or plugin (alias: `rm`) | -| `adk upgrade [integration]` | Upgrade integration(s) to latest version (alias: `up`) | -| `adk search ` | Search the Botpress Hub | -| `adk list` | List installed integrations | -| `adk info ` | Show detailed integration info | - -### `adk add` +| `adk integrations add ` | Add an integration | +| `adk integrations remove [resource]` | Remove an integration | +| `adk integrations upgrade [integration]` | Upgrade integration(s) to latest version | +| `adk integrations search ` | Search the Botpress Hub | +| `adk integrations list` | List installed integrations | +| `adk integrations info ` | Show detailed integration info | +| `adk integrations copy --from --to ` | Copy integration state between environments | +| `adk plugins ` | Manage agent plugins (`add`, `remove`, `upgrade`, etc.) | +| `adk interfaces ` | Inspect available interfaces (`list`, `info`) | + +### `adk integrations add` Add an integration or interface to your agent. Accepts a name, `workspace/name`, or a specific version: ```bash -adk add webchat -adk add slack@latest -adk add slack@0.5.0 -adk add my-workspace/custom@1.0.0 -adk add interface:translator@1.0.0 -adk add webchat --alias custom-webchat +adk integrations add webchat +adk integrations add slack@latest +adk integrations add slack@0.5.0 +adk integrations add my-workspace/custom@1.0.0 +adk integrations add webchat --alias custom-webchat ``` | Flag | Description | |------|-------------| | `--alias ` | Custom alias for the resource | -### `adk search` +### `adk integrations search` Search the Botpress Hub for integrations: ```bash -adk search crm -adk search slack --limit 5 +adk integrations search crm +adk integrations search slack --limit 5 ``` | Flag | Description | Default | |------|-------------|---------| | `--limit ` | Max results to return | `20` | -### `adk list` +### `adk integrations list` List integrations in your project, or all available ones on the Hub: ```bash -adk list -adk list --available +adk integrations list +adk integrations list --available ``` | Flag | Description | Default | @@ -156,14 +158,14 @@ adk list --available | `--available` | List all available integrations (not just installed) | | | `--limit ` | Max results | `50` | -### `adk info` +### `adk integrations info` Show details for a specific integration. Filter by a single facet or show the full spec: ```bash -adk info slack -adk info slack --actions -adk info slack --full +adk integrations info slack +adk integrations info slack --actions +adk integrations info slack --full ``` | Flag | Description | diff --git a/adk/setup/integrations.mdx b/adk/setup/integrations.mdx index c9970d85..9ac9d3e7 100644 --- a/adk/setup/integrations.mdx +++ b/adk/setup/integrations.mdx @@ -63,13 +63,13 @@ You can also manage integrations from the command line: | Command | What it does | |---------|-------------| -| `adk search ` | Search the Botpress Hub for integrations | -| `adk list --available` | List all available integrations | -| `adk info ` | Show details, actions, events, and channels for an integration | -| `adk add ` | Add an integration to your project | -| `adk add --alias ` | Add with a custom alias | -| `adk upgrade ` | Update an integration to a newer version | -| `adk remove ` | Remove an integration from your project | +| `adk integrations search ` | Search the Botpress Hub for integrations | +| `adk integrations list --available` | List all available integrations | +| `adk integrations info ` | Show details, actions, events, and channels for an integration | +| `adk integrations add ` | Add an integration to your project | +| `adk integrations add --alias ` | Add with a custom alias | +| `adk integrations upgrade ` | Update an integration to a newer version | +| `adk integrations remove ` | Remove an integration from your project | Newly added integrations are disabled by default. You can enable and configure them in the dev console.