Overview
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:
| Command | Description |
|---|---|
init | Initialize a new Buster project |
auth | Authenticate with Buster API |
deploy | Deploy semantic models to Buster |
generate | Generate or update semantic models from dbt projects |
parse | Parse and validate semantic model YAML definitions |
config | Interactively manage LLM and Reranker configurations |
start | Start the Buster services |
stop | Stop the Buster services |
reset | Restart the Buster services |
update | Update the CLI to the latest version |
Getting Help
For help with any command, use the --help flag:
Command Syntax
The Buster CLI follows a consistent command structure:
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:
| Variable | Description |
|---|---|
BUSTER_HOST | URL of the Buster API |
BUSTER_API_KEY | Your API key for the Buster service |
Workflow Example
A typical workflow with the Buster CLI might look like:
- Authenticate with the API:
buster auth - Initialize a project:
buster init(this can automatically generate semantic models) - Optionally regenerate semantic models:
buster generate - Parse and validate models:
buster parse - Deploy models to Buster:
buster deploy - Start the Buster services:
buster start