Skip to main content
Buster has three installation options depending on your needs:
  • Cloud: Managed service and web app. Recommended for most teams.
  • CLI: Command-line tool for local development and testing of agents.
  • Self-Hosted: Deploy Buster in your own infrastructure for maximum control.

​
Buster Cloud

The fastest way to get started. No infrastructure to manage.
1

Sign up

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

Install GitHub App

Authorize and install the Buster GitHub App on your repositories.Permissions required:
  • Read repository contents
  • Read and write pull requests
  • Read and write issues and comments
3

Connect integrations

In the Buster dashboard:
  1. Connect your data warehouse (Snowflake, BigQuery, etc.)
  2. Optionally connect Slack, dbt Cloud, and other tools
4

Deploy your first agent

Add a YAML file to .github/buster/agents/ in your repository and push to main.The agent will be automatically detected and deployed.

​
Buster CLI

The CLI lets you test agents locally before deploying them.
npm Install
npm install -g buster-cli
yarn Install
yarn global add buster-cli
Homebrew Install
brew install buster-cli
Below are some common commands:
Authenticate
buster auth login
Basic Commands
# Initialize a new project
buster init

# Validate agent configurations
buster validate

# Run an agent locally (dry run)
buster run my-agent --dry-run

# View logs
buster logs my-agent

# Deploy agents to Buster Cloud
buster deploy

# Verify installations
buster --version
See the Testing & Debugging guide for more CLI commands and usage examples.

​
Self-Hosted Deployment

Deploy Buster in your own infrastructure for maximum control over data, security, and compliance.
Self-hosting requires an Enterprise plan. Contact [email protected] for more information and license keys.
Infrastructure:
  • Kubernetes cluster (version 1.24+)
  • PostgreSQL database (version 14+)
  • Redis (version 7+)
  • S3-compatible object storage
Resources (minimum):
  • 4 CPU cores
  • 8 GB RAM
  • 50 GB storage
Resources (recommended for production):
  • 8+ CPU cores
  • 16+ GB RAM
  • 200+ GB storage
  • Auto-scaling enabled