Skip to main content
The ADK CLI provides commands for creating, developing, building, and deploying Botpress agents.

​
Global flags

These flags are available for all commands:
FlagAliasDescription
--help-hShow help information
--version-VShow version number
--no-cacheDisable 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:
ArgumentDescription
project-nameName of the project directory to create
Flags:
FlagDescriptionDefault
--templateTemplate to use: blank or hello-worldblank

​
adk dev

Start the development server with hot reloading. Usage: 
adk dev
adk dev --port 3000
adk dev --logs
Flags:
FlagDescriptionDefault
-p, --portPort for the development server3000
--port-consolePort for the console/UI server3001
-l, --logsStream 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:
FlagDescriptionDefault
-e, --envDeployment environmentproduction

​
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:
ArgumentDescription
resourceIntegration or interface name with optional version (e.g., webchat@latest, [email protected], or interface:[email protected])
Flags:
FlagDescription
--aliasUse 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.

​
adk login

Authenticate with your Botpress account. Usage: 
adk login
adk login --token <token>
adk login --profile <profile>
adk login --api-url <url>
Flags:
FlagDescriptionDefault
--tokenBotpress API token
--profileProfile name to usedefault
--api-urlBotpress API URLhttps://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:
ArgumentDescription
profileProfile name to switch to (interactive if not provided)

​
adk upgrade

Upgrade integration(s) to latest version. Usage: 
adk upgrade
adk upgrade <integration>
Arguments:
ArgumentDescription
integrationIntegration alias to upgrade (interactive if not specified)
Aliases: up

​
adk remove

Remove an integration from your agent. Usage: 
adk remove
adk remove <integration>
Arguments:
ArgumentDescription
integrationIntegration alias to remove (interactive if not specified)
Aliases: rm
Search for integrations in the Botpress hub. Usage: 
adk search <query>
adk search slack --format json --limit 10
Arguments:
ArgumentDescription
querySearch query
Flags:
FlagDescriptionDefault
--formatOutput format: table or jsontable
--limitLimit number of results20

​
adk list

List integrations (installed or available). Usage: 
adk list
adk list --available
adk list --format json --limit 100
Flags:
FlagDescriptionDefault
--availableList all available integrations (instead of installed)false
--formatOutput format: table or jsontable
--limitLimit number of results50

​
adk info

Show detailed information about an integration. Usage: 
adk info <name>
adk info slack --actions
adk info webchat --full --format json
Arguments:
ArgumentDescription
nameIntegration name
Flags:
FlagDescription
--actionsShow only actions
--channelsShow only channels
--eventsShow only events
--fullShow all details
--formatOutput format: table or json (default: table)
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:
FlagDescription
--workspaceWorkspace ID
--botBot ID to link to
--devDev 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:
FlagDescription
--dry-runPreview changes without applying them
-y, --yesSkip confirmation prompts
--bail-on-failureStop on first error
--forceForce re-upload all files

​
adk assets list

List all asset files. Usage: 
adk assets list
adk assets list --local
adk assets list --remote
Flags:
FlagDescription
--localShow only local assets
--remoteShow 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