Skip to content

auto-update(docs) - refactor(cli): remove legacy integration command shims #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
charmenta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

auto-update(docs) - refactor(cli): remove legacy integration command shims #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions adk/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,69 +101,71 @@ 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 <resource>` | 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 <query>` | Search the Botpress Hub |
| `adk list` | List installed integrations |
| `adk info <name>` | Show detailed integration info |

### `adk add`
| `adk integrations add <resource>` | Add an integration |
| `adk integrations remove [resource]` | Remove an integration |
| `adk integrations upgrade [integration]` | Upgrade integration(s) to latest version |
| `adk integrations search <query>` | Search the Botpress Hub |
| `adk integrations list` | List installed integrations |
| `adk integrations info <name>` | Show detailed integration info |
| `adk integrations copy --from <env> --to <env>` | Copy integration state between environments |
| `adk plugins <command>` | Manage agent plugins (`add`, `remove`, `upgrade`, etc.) |
| `adk interfaces <command>` | 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 <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 <number>` | 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 |
|------|-------------|---------|
| `--available` | List all available integrations (not just installed) | |
| `--limit <n>` | 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 |
Expand Down
14 changes: 7 additions & 7 deletions adk/setup/integrations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ You can also manage integrations from the command line:

| Command | What it does |
|---------|-------------|
| `adk search <query>` | Search the Botpress Hub for integrations |
| `adk list --available` | List all available integrations |
| `adk info <name>` | Show details, actions, events, and channels for an integration |
| `adk add <name>` | Add an integration to your project |
| `adk add <name> --alias <alias>` | Add with a custom alias |
| `adk upgrade <name>` | Update an integration to a newer version |
| `adk remove <name>` | Remove an integration from your project |
| `adk integrations search <query>` | Search the Botpress Hub for integrations |
| `adk integrations list --available` | List all available integrations |
| `adk integrations info <name>` | Show details, actions, events, and channels for an integration |
| `adk integrations add <name>` | Add an integration to your project |
| `adk integrations add <name> --alias <alias>` | Add with a custom alias |
| `adk integrations upgrade <name>` | Update an integration to a newer version |
| `adk integrations remove <name>` | Remove an integration from your project |

Newly added integrations are disabled by default. You can enable and configure them in the dev console.

Expand Down
Loading