Authentication

Login and logout of Botpress Cloud

Authenticate with Botpress Cloud to deploy projects and manage resources.

Login

Authenticate with Botpress Cloud:

bp login

Interactive login

Running bp login without options opens your browser to authenticate.

Options

—token

Provide Personal Access Token directly:

bp login --token YOUR_PAT

Create PATs at app.botpress.cloud/profile/tokens

—workspaceId

Specify workspace ID:

bp login --token YOUR_PAT --workspaceId abc123

—apiUrl

Use custom API endpoint:

bp login --apiUrl https://api.botpress.cloud

Default: https://api.botpress.cloud

CI/CD authentication

For automated environments:

bp login --token $BOTPRESS_TOKEN --workspaceId $WORKSPACE_ID -y

Logout

Clear stored credentials:

bp logout

This removes:

• Personal Access Token
• Workspace ID
• API URL configuration

Credential storage

Credentials are stored in:

~/.botpress/config.json

Keep your Personal Access Token secure. Never commit it to version control.

Examples

Interactive login

bp login

Opens browser for authentication.

Login with token

bp login --token bp_pat_1234567890abcdef

Login for specific workspace

bp login --token bp_pat_1234567890abcdef --workspaceId ws_abc123

Logout

bp logout

CI/CD example

# In your CI/CD pipeline
export BOTPRESS_TOKEN=${{ secrets.BOTPRESS_TOKEN }}
export WORKSPACE_ID=${{ secrets.WORKSPACE_ID }}

bp login --token $BOTPRESS_TOKEN --workspaceId $WORKSPACE_ID -y
bp deploy

Multiple workspaces

Use profiles to manage multiple workspaces:

# Create profiles
bp login --token TOKEN_DEV --workspaceId ws_dev
bp profiles use dev

bp login --token TOKEN_PROD --workspaceId ws_prod
bp profiles use prod

# Switch between workspaces
bp profiles use dev
bp deploy

bp profiles use prod
bp deploy

Verify authentication

Check active profile:

bp profiles active

Output:

Workspace: acme (ws_abc123)
API URL: https://api.botpress.cloud
Authenticated: Yes

Troubleshooting

Invalid token

Ensure your PAT is valid and not expired:

1. Visit app.botpress.cloud/profile/tokens
2. Generate new token if needed
3. Login with new token

Wrong workspace

Verify workspace ID:

bp profiles active

Switch workspace:

bp login --workspaceId correct_workspace_id

Permission denied

Ensure your token has required permissions for the operation you’re attempting.