​
Buster CLI Overview

The Buster CLI is a powerful command-line tool designed to help you manage, develop, and deploy your semantic models for natural language data analysis. It provides an intuitive interface to interact with the Buster platform.

​
Installation

Before using the Buster CLI, you’ll need to install it. See the installation guide for detailed instructions for your operating system.

​
Available Commands

The CLI includes the following commands:
CommandDescription
initInitialize a new Buster project
authAuthenticate with Buster API
deployDeploy semantic models to Buster
generateGenerate or update semantic models from dbt projects
parseParse and validate semantic model YAML definitions
configInteractively manage LLM and Reranker configurations
startStart the Buster services
stopStop the Buster services
resetRestart the Buster services
updateUpdate the CLI to the latest version

​
Getting Help

For help with any command, use the --help flag: 
buster --help         # General CLI help
buster init --help    # Help for the init command

​
Command Syntax

The Buster CLI follows a consistent command structure: 
buster <command> [options]
Most commands accept various options that modify their behavior. These options are typically provided using the --option-name value format or short flags like -o value.

​
Environment Variables

The Buster CLI respects the following environment variables:
VariableDescription
BUSTER_HOSTURL of the Buster API
BUSTER_API_KEYYour API key for the Buster service

​
Workflow Example

A typical workflow with the Buster CLI might look like:
  1. Authenticate with the API: buster auth
  2. Initialize a project: buster init (this can automatically generate semantic models)
  3. Optionally regenerate semantic models: buster generate
  4. Parse and validate models: buster parse
  5. Deploy models to Buster: buster deploy
  6. Start the Buster services: buster start