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.

Create a new bot, integration, plugin, or interface project.

Usage

bp init [options]

Options

—type

Project type to initialize:
bp init --type bot
bp init --type integration
bp init --type plugin
bp init --type interface

—name

Project name:
bp init --type bot --name my-bot
bp init --type integration --name acme/slack
Integrations and plugins require workspace handle: workspace/name

—workDir

Working directory (default: current directory):
bp init --workDir ./projects

—template

Template to use:
bp init --type bot --template hello-world

Interactive mode

Run without options for interactive prompts:
bp init
The CLI will prompt for:
  1. Project type
  2. Project name
  3. Workspace (for integrations/plugins)
  4. Template (if multiple available)

Examples

Initialize bot

bp init --type bot --name customer-support

Initialize integration

bp init --type integration --name acme/custom-crm

Initialize plugin

bp init --type plugin --name acme/analytics

After initialization

Navigate to project and install dependencies:
cd my-project
npm install
Build and run:
bp build
bp dev