Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/botpress/botpress/llms.txt

Use this file to discover all available pages before exploring further.

Deploy bots, integrations, and plugins to Botpress Cloud.

Usage

bp deploy

Options

—noBuild

Skip build step:
bp deploy --noBuild

—visibility

Set integration/plugin visibility:
bp deploy --visibility public
bp deploy --visibility private
bp deploy --visibility unlisted

—dryRun

Validate without deploying:
bp deploy --dryRun

—botId

Deploy to specific bot:
bp deploy --botId abc123

—createNewBot

Create new bot instead of updating:
bp deploy --createNewBot

Deployment flow

1

Build

Project is built (unless —noBuild)
2

Validate

Definition is validated
3

Upload

Code is uploaded to cloud
4

Register

Resources are registered

Bot deployment

cd my-bot
bp deploy
First deploy prompts for bot selection. Subsequent deploys use cached bot ID.

Integration deployment

cd my-integration
bp deploy --visibility public
Integrations are deployed to workspace.

Plugin deployment

cd my-plugin
bp deploy --visibility public

Secrets

Integrations prompt for secrets:
? Enter value for API_KEY: ****
? Enter value for WEBHOOK_SECRET: ****