Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.buster.so/llms.txt

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

Buster consists of a cloud platform and a CLI tool. The platform manages agent execution, and the CLI handles authentication and deployment.

​
Buster Cloud

The Buster platform is where you connect integrations, view agent runs, and manage your organization.
1

Sign up

Visit buster.so/sign-up and create your account.
2

Install GitHub App

Install the Buster GitHub App on your repositories to enable agent triggers.Permissions required:
  • Repository contents (read/write)
  • Pull requests (read/write)
  • Issues (read/write)
  • Checks (read/write)
We recommend granting access only to repositories where you plan to deploy agents.
3

Connect your data warehouse

In the Buster dashboard, connect your data warehouse:
  1. Go to Settings → Data Sources
  2. Select your warehouse type (Snowflake, BigQuery, PostgreSQL, etc.)
  3. Enter your credentials
See Data Warehouse integrations for detailed setup instructions.
4

Optionally connect Slack

To receive agent notifications in Slack:
  1. Go to Settings → Integrations → Slack
  2. Click Connect Slack
  3. Authorize and select a default channel

​
Buster CLI

The CLI is used to authenticate, deploy agents, and manage your Buster configuration.

​
Install

curl -fsSL https://platform.buster.so/cli | bash
Verify the installation: 
buster --version

​
Authenticate

Get your API key from the Buster platform under Settings → API Keys, then: 
buster auth --api-key YOUR_API_KEY
For CI/CD pipelines, use the BUSTER_API_KEY environment variable instead.

​
Deploy

Once authenticated, deploy your agents: 
buster deploy
To validate without deploying: 
buster deploy --dry-run