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.
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.
Connect your data warehouse
In the Buster dashboard, connect your data warehouse:
- Go to Settings â Data Sources
- Select your warehouse type (Snowflake, BigQuery, PostgreSQL, etc.)
- Enter your credentials
See Data Warehouse integrations for detailed setup instructions. Optionally connect Slack
To receive agent notifications in Slack:
- Go to Settings â Integrations â Slack
- Click Connect Slack
- Authorize and select a default channel
Buster CLI
The CLI is used to authenticate, deploy agents, and manage your Buster configuration.
Install
macOS / Linux
Windows
GitHub Actions
curl -fsSL https://platform.buster.so/cli | bash
irm https://platform.buster.so/cli/windows | iex
- uses: buster-so/buster/actions/install@v1
with:
version: latest
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.
