Experimental commands

Preview experimental CLI features

Experimental commands are unstable and may change without notice. Use at your own risk.

Experimental features currently being developed for the Botpress CLI.

Lint

Lint an integration definition for errors and best practices:

bp lint

EXPERIMENTAL: This command is under active development and may change.

Usage

cd my-integration
bp lint

Options

—workDir

Specify integration directory:

bp lint --workDir ./my-integration

What it checks

The lint command validates:

• Integration definition syntax
• Schema validation errors
• Best practice violations
• Naming conventions
• Required fields
• Type correctness

Example output

✓ Integration definition syntax valid
✓ All schemas valid
⚠ Warning: Consider adding description to action 'sendMessage'
✗ Error: Event 'messageReceived' missing required schema

1 error, 1 warning

Use cases

Pre-deployment validation

bp lint
if [ $? -eq 0 ]; then
  bp deploy
fi

CI/CD integration

# In your pipeline
bp lint || exit 1

Development workflow

# Check before committing
bp lint --verbose

Chat

Interact with a deployed bot directly from the CLI:

bp chat <botId>

EXPERIMENTAL: This command is under active development and may change.

Usage

bp chat abc123

The bot ID is required as a positional argument.

Options

—chatApiUrl

Custom chat API endpoint:

bp chat abc123 --chatApiUrl https://chat.botpress.cloud

Authentication

Requires authentication:

bp chat abc123 --token YOUR_TOKEN --workspaceId ws_abc123

Interactive mode

The chat command starts an interactive session:

> Hello
Bot: Hi! How can I help you today?

> What can you do?
Bot: I can assist you with...

> exit
Goodbye!

Commands

In chat mode:

• Type your message and press Enter
• exit or quit to end session
• clear to clear screen
• help for available commands

Examples

Start chat session

bp chat abc123

Chat with authentication

bp chat abc123 --token $BP_TOKEN --workspaceId $WS_ID

Custom endpoint

bp chat abc123 --chatApiUrl https://custom.api.endpoint

Use cases

Quick bot testing

bp chat abc123

Test your bot without opening the web interface.

Automated testing

echo "test message" | bp chat abc123

CI/CD smoke tests

# Test bot responds
echo "hello" | bp chat $BOT_ID | grep -q "response"

Providing feedback

Experimental features need your feedback!

Report issues

File issues at github.com/botpress/botpress

Feature requests

Share your ideas in the Botpress Discord community.

Stability

Experimental commands:

• May have bugs
• May change behavior
• May be removed
• Are not production-ready

Once stable, experimental commands will be promoted to regular commands and fully documented.

Migration notice

When experimental commands are promoted:

• Breaking changes will be announced
• Migration guides will be provided
• Deprecation period will be given

Related commands

• bp read - Read integration definition (stable)
• bp generate - Generate types (stable)
• bp deploy - Deploy projects (stable)