Plugin management

Manage Botpress plugins

View and manage plugins in your Botpress workspace.

Get plugin

Retrieve details about a specific plugin:

bp plugins get <plugin>

Plugin reference

Specify plugin name and version:

bp plugins get knowledge@0.0.1

List plugins

List all available plugins:

bp plugins list

Alias: bp plugins ls

Filter options

—name

Filter by plugin name:

bp plugins list --name knowledge

—versionNumber

Filter by version:

bp plugins list --versionNumber 0.0.1

Combined filters

bp plugins list --name knowledge --versionNumber 0.0.1

Delete plugin

Delete a plugin:

bp plugins delete <plugin>

Alias: bp plugins rm

Usage

bp plugins delete knowledge@0.0.1

Deleting a plugin is permanent and cannot be undone.

Options

Authentication

All commands support authentication options:

bp plugins list --token YOUR_TOKEN
bp plugins list --workspaceId abc123
bp plugins list --apiUrl https://api.botpress.cloud

Global options

All global options are available:

bp plugins list --json
bp plugins list --verbose

Examples

List all plugins

bp plugins list

Get plugin details

bp plugins get knowledge@0.0.1

Filter by name

bp plugins list --name knowledge

Delete plugin

bp plugins delete knowledge@0.0.1

JSON output

bp plugins list --json > plugins.json

Skip confirmation

bp plugins delete knowledge@0.0.1 -y

Plugin details

The get command displays:

• Plugin ID
• Name and version
• Description
• Configuration schema
• Required permissions
• Dependencies
• Installation status

Use cases

Browse available plugins

bp plugins list

Check plugin version

bp plugins get knowledge@0.0.1

Export plugin list

bp plugins list --json > workspace-plugins.json

Clean up old versions

bp plugins delete knowledge@0.0.1

What are plugins?

Plugins extend Botpress functionality:

• Knowledge Plugin: Add knowledge bases and RAG capabilities
• Analytics Plugin: Track and analyze bot performance
• Custom Plugins: Build your own extensions

Plugins are installed at the workspace level and available to all bots.

Installing plugins

Use the init command to create a new plugin:

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

Deploy to your workspace:

cd my-plugin
bp deploy

Related commands

• bp init - Create new plugin project
• bp deploy - Deploy plugin to workspace