> ## Documentation Index
> Fetch the complete documentation index at: https://botpress-ak-docs-20-document-updating-variables-from-outsid.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI reference

> All commands and flags available with the ADK CLI.

The ADK CLI provides commands for creating, developing, building, and deploying Botpress agents.

## Global flags

These flags are available for all commands:

| Flag         | Alias | Description                             |
| ------------ | ----- | --------------------------------------- |
| `--help`     | `-h`  | Show help information                   |
| `--version`  | `-V`  | Show version number                     |
| `--no-cache` |       | Disable caching for integration lookups |

## Commands

### `adk init`

Initialize a new ADK agent project.

**Usage:**

```bash theme={null}
adk init my-agent
adk init my-agent --template hello-world
```

**Arguments:**

| Argument       | Description                             |
| -------------- | --------------------------------------- |
| `project-name` | Name of the project directory to create |

**Flags:**

| Flag         | Description                               | Default |
| ------------ | ----------------------------------------- | ------- |
| `--template` | Template to use: `blank` or `hello-world` | `blank` |

***

### `adk dev`

Start the development server with hot reloading.

**Usage:**

```bash theme={null}
adk dev
adk dev --port 3000
adk dev --logs
```

**Flags:**

| Flag             | Description                                                 | Default |
| ---------------- | ----------------------------------------------------------- | ------- |
| `-p, --port`     | Port for the development server                             | `3000`  |
| `--port-console` | Port for the console/UI server                              | `3001`  |
| `-l, --logs`     | Stream logs to `stderr` (CI/CLI-friendly mode, disables UI) | `false` |

***

### `adk build`

Build your agent for production.

**Usage:**

```bash theme={null}
adk build
```

**Flags:**

No flags available.

***

### `adk deploy`

Deploy your agent to Botpress Cloud.

**Usage:**

```bash theme={null}
adk deploy
adk deploy --env production
```

**Flags:**

| Flag        | Description                                      | Default      |
| ----------- | ------------------------------------------------ | ------------ |
| `-e, --env` | Deployment environment                           | `production` |
| `-y, --yes` | Auto-approve preflight changes without prompting | `false`      |

***

### `adk add`

Add an integration to your agent project.

**Usage:**

```bash theme={null}
adk add webchat
adk add slack@latest
adk add my-workspace/custom-integration@1.0.0
adk add interface:translator@1.0.0
adk add webchat --alias custom-webchat
```

**Arguments:**

| Argument   | Description                                                                                                                  |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `resource` | Integration or interface name with optional version (e.g., `webchat@latest`, `slack@1.2.0`, or `interface:translator@1.0.0`) |

**Flags:**

| Flag      | Description                         |
| --------- | ----------------------------------- |
| `--alias` | Use a custom alias for the resource |

**Aliases:** `i`, `install`

***

### `adk chat`

Chat with your deployed bot directly from the CLI.

**Usage:**

```bash theme={null}
adk chat
```

<Note>
  Run `adk dev` first to create a development bot if you don't have a `devId` in your `agent.json`.
</Note>

***

### `adk mcp`

Start an MCP (Model Context Protocol) server for AI assistant integration. This allows AI coding assistants like Claude Code and Cursor to interact with your ADK agent.

**Usage:**

```bash theme={null}
adk mcp
adk mcp --cwd ./my-agent
```

**Flags:**

| Flag    | Description                          |
| ------- | ------------------------------------ |
| `--cwd` | Working directory for MCP operations |

#### `adk mcp:init`

Generate MCP configuration files for AI assistants.

**Usage:**

```bash theme={null}
adk mcp:init --tool cursor
adk mcp:init --tool claude-code --tool vscode
adk mcp:init --all
adk mcp:init --all --force
adk mcp:init --tool cursor --project-dir ./bot
```

**Flags:**

| Flag            | Description                                                      |
| --------------- | ---------------------------------------------------------------- |
| `--tool`        | Specific tool(s) to configure: `claude-code`, `vscode`, `cursor` |
| `--all`         | Generate configuration for all supported tools                   |
| `--force`       | Overwrite existing ADK configuration                             |
| `--project-dir` | ADK project subdirectory (for monorepos, e.g., `./bot`)          |

***

### `adk login`

Authenticate with your Botpress account.

**Usage:**

```bash theme={null}
adk login
adk login --token <token>
adk login --profile <profile>
adk login --api-url <url>
```

**Flags:**

| Flag        | Description         | Default                      |
| ----------- | ------------------- | ---------------------------- |
| `--token`   | Botpress API token  |                              |
| `--profile` | Profile name to use | `default`                    |
| `--api-url` | Botpress API URL    | `https://api.botpress.cloud` |

***

### `adk profiles`

Manage authentication profiles.

#### `adk profiles list`

List all configured profiles.

**Usage:**

```bash theme={null}
adk profiles list
```

#### `adk profiles set`

Switch to a different profile.

**Usage:**

```bash theme={null}
adk profiles set
adk profiles set <profile>
```

**Arguments:**

| Argument  | Description                                             |
| --------- | ------------------------------------------------------- |
| `profile` | Profile name to switch to (interactive if not provided) |

***

### `adk upgrade`

Upgrade integration(s) to latest version.

**Usage:**

```bash theme={null}
adk upgrade
adk upgrade <integration>
```

**Arguments:**

| Argument      | Description                                                 |
| ------------- | ----------------------------------------------------------- |
| `integration` | Integration alias to upgrade (interactive if not specified) |

**Aliases:** `up`

***

### `adk remove`

Remove an integration from your agent.

**Usage:**

```bash theme={null}
adk remove
adk remove <integration>
```

**Arguments:**

| Argument      | Description                                                |
| ------------- | ---------------------------------------------------------- |
| `integration` | Integration alias to remove (interactive if not specified) |

**Aliases:** `rm`

***

### `adk search`

Search for integrations in the Botpress hub.

**Usage:**

```bash theme={null}
adk search <query>
adk search slack --format json --limit 10
```

**Arguments:**

| Argument | Description  |
| -------- | ------------ |
| `query`  | Search query |

**Flags:**

| Flag       | Description                      | Default |
| ---------- | -------------------------------- | ------- |
| `--format` | Output format: `table` or `json` | `table` |
| `--limit`  | Limit number of results          | `20`    |

***

### `adk list`

List integrations (installed or available).

**Usage:**

```bash theme={null}
adk list
adk list --available
adk list --format json --limit 100
```

**Flags:**

| Flag          | Description                                            | Default |
| ------------- | ------------------------------------------------------ | ------- |
| `--available` | List all available integrations (instead of installed) | `false` |
| `--format`    | Output format: `table` or `json`                       | `table` |
| `--limit`     | Limit number of results                                | `50`    |

***

### `adk info`

Show detailed information about an integration.

**Usage:**

```bash theme={null}
adk info <name>
adk info slack --actions
adk info webchat --full --format json
```

**Arguments:**

| Argument | Description      |
| -------- | ---------------- |
| `name`   | Integration name |

**Flags:**

| Flag         | Description                                         |
| ------------ | --------------------------------------------------- |
| `--actions`  | Show only actions                                   |
| `--channels` | Show only channels                                  |
| `--events`   | Show only events                                    |
| `--full`     | Show all details                                    |
| `--format`   | Output format: `table` or `json` (default: `table`) |

***

### `adk link`

Link local agent to workspace and bot.

**Usage:**

```bash theme={null}
adk link
adk link --workspace <workspaceId> --bot <botId>
adk link --workspace <workspaceId> --bot <botId> --dev <devBotId>
```

**Flags:**

| Flag          | Description                                           |
| ------------- | ----------------------------------------------------- |
| `--workspace` | Workspace ID                                          |
| `--bot`       | Bot ID to link to                                     |
| `--dev`       | Dev bot ID (optional)                                 |
| `--api-url`   | Botpress API URL (e.g., `https://api.botpress.cloud`) |
| `-f, --force` | Overwrite existing `agent.json` if present            |

***

### `adk self-upgrade`

Upgrade ADK CLI to the latest version.

**Usage:**

```bash theme={null}
adk self-upgrade
```

**Aliases:** `self-update`

***

### `adk assets`

Manage agent assets and static files.

#### `adk assets sync`

Synchronize assets with remote storage.

**Usage:**

```bash theme={null}
adk assets sync
adk assets sync --dry-run
adk assets sync --yes --force
```

**Flags:**

| Flag                | Description                           |
| ------------------- | ------------------------------------- |
| `--dry-run`         | Preview changes without applying them |
| `-y, --yes`         | Skip confirmation prompts             |
| `--bail-on-failure` | Stop on first error                   |
| `--force`           | Force re-upload all files             |

#### `adk assets list`

List all asset files.

**Usage:**

```bash theme={null}
adk assets list
adk assets list --local
adk assets list --remote
```

**Flags:**

| Flag       | Description             |
| ---------- | ----------------------- |
| `--local`  | Show only local assets  |
| `--remote` | Show only remote assets |

#### `adk assets status`

Show asset synchronization status.

**Usage:**

```bash theme={null}
adk assets status
```

#### `adk assets pull`

Download remote assets to local directory.

**Usage:**

```bash theme={null}
adk assets pull
```

***

### `adk config`

Configure agent settings interactively or manage specific configuration values.

**Usage:**

```bash theme={null}
adk config
adk config --prod
```

**Flags:**

| Flag     | Description                  |
| -------- | ---------------------------- |
| `--prod` | Use production configuration |

#### `adk config:get`

Get a specific configuration value.

**Usage:**

```bash theme={null}
adk config:get <key>
adk config:get myKey --prod
```

**Arguments:**

| Argument | Description                   |
| -------- | ----------------------------- |
| `key`    | Configuration key to retrieve |

**Flags:**

| Flag     | Description                  |
| -------- | ---------------------------- |
| `--prod` | Use production configuration |

#### `adk config:set`

Set a specific configuration value.

**Usage:**

```bash theme={null}
adk config:set <key> <value>
adk config:set myKey myValue --prod
```

**Arguments:**

| Argument | Description              |
| -------- | ------------------------ |
| `key`    | Configuration key to set |
| `value`  | Configuration value      |

**Flags:**

| Flag     | Description                  |
| -------- | ---------------------------- |
| `--prod` | Use production configuration |

***

### `adk kb`

Manage knowledge bases and synchronization.

#### `adk kb sync`

Synchronize knowledge bases with Botpress.

**Usage:**

```bash theme={null}
adk kb sync --dev
adk kb sync --prod
adk kb sync --dev --dry-run
adk kb sync --prod --force --yes
```

**Flags:**

| Flag        | Description                           |
| ----------- | ------------------------------------- |
| `--dev`     | Sync with development bot             |
| `--prod`    | Sync with production bot              |
| `--dry-run` | Preview changes without applying them |
| `-y, --yes` | Skip confirmation prompts             |
| `--force`   | Force re-sync all knowledge bases     |

<Note>
  Either `--dev` or `--prod` is required when running `adk kb sync`.
</Note>

***

### `adk telemetry`

Manage telemetry preferences.

**Usage:**

```bash theme={null}
adk telemetry --status
adk telemetry --enable
adk telemetry --disable
```

**Flags:**

| Flag        | Description                   |
| ----------- | ----------------------------- |
| `--status`  | Show current telemetry status |
| `--enable`  | Enable telemetry              |
| `--disable` | Disable telemetry             |

***

## Project scripts

The ADK also provides npm scripts that you can use in your `package.json`:

```json theme={null}
{
  "scripts": {
    "dev": "adk dev",
    "build": "adk build",
    "deploy": "adk deploy"
  }
}
```

Run these with your package manager:

```bash theme={null}
npm run dev
bun run dev
pnpm dev
yarn dev
```