CLI reference

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:

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:

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:

adk build

Flags: No flags available.

`adk deploy`

Deploy your agent to Botpress Cloud. Usage:

adk deploy
adk deploy --env production

Flags:

Flag	Description	Default
`-e, --env`	Deployment environment	`production`

`adk add`

Add an integration to your agent project. Usage:

adk add webchat
adk add slack@latest
adk add my-workspace/[email protected]
adk add interface:[email protected]
adk add webchat --alias custom-webchat

Arguments:

Argument	Description
`resource`	Integration or interface name with optional version (e.g., `webchat@latest`, `[email protected]`, or `interface:[email protected]`)

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:

adk chat

Run adk dev first to create a development bot if you don’t have a devId in your agent.json.

Authenticate with your Botpress account. Usage:

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:

adk profiles list

`adk profiles set`

Switch to a different profile. Usage:

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:

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:

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:

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:

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:

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:

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)

`adk self-upgrade`

Upgrade ADK CLI to the latest version. Usage:

adk self-upgrade

Aliases: self-update

`adk assets`

Manage agent assets and static files.

`adk assets sync`

Synchronize assets with remote storage. Usage:

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:

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:

adk assets status

`adk assets pull`

Download remote assets to local directory. Usage:

adk assets pull

Project scripts

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

{
  "scripts": {
    "dev": "adk dev",
    "build": "adk build",
    "deploy": "adk deploy"
  }
}

Run these with your package manager:

npm run dev
bun run dev
pnpm dev
yarn dev

Get started

Studio

Integrations

Webchat

For developers

Global flags

Commands

`adk init`

`adk dev`

`adk build`

`adk deploy`

`adk add`

`adk chat`

`adk profiles`

`adk profiles list`

`adk profiles set`

`adk upgrade`

`adk remove`

`adk search`

`adk list`

`adk info`

`adk link`

`adk self-upgrade`

`adk assets`

`adk assets sync`

`adk assets list`

`adk assets status`

`adk assets pull`

Project scripts

Get started

Studio

Integrations

Webchat

For developers

​Global flags

​Commands

​adk init

​adk dev

​adk build

​adk deploy

​adk add

​adk chat

​adk login

​adk profiles

​adk profiles list

​adk profiles set

​adk upgrade

​adk remove

​adk search

​adk list

​adk info

​adk link

​adk self-upgrade

​adk assets

​adk assets sync

​adk assets list

​adk assets status

​adk assets pull

​Project scripts

Global flags

Commands

`adk init`

`adk dev`

`adk build`

`adk deploy`

`adk add`

`adk chat`

`adk login`

`adk profiles`

`adk profiles list`

`adk profiles set`

`adk upgrade`

`adk remove`

`adk search`

`adk list`

`adk info`

`adk link`

`adk self-upgrade`

`adk assets`

`adk assets sync`

`adk assets list`

`adk assets status`

`adk assets pull`

Project scripts