Deploy
How to use the deploy command to publish your Buster project
Deploy Your Semantic Models
The buster deploy
command publishes your semantic models to the Buster platform, making them available for natural language querying. This is the final step in the Buster model development workflow.
Basic Usage
Command Options
Option | Description |
---|---|
--path PATH | Optional path to a specific model file or directory to deploy. If not provided, uses the model paths from buster.yml. |
--dry-run | Validate models without actually deploying them (default: false). |
--recursive | Recursively search for model files in subdirectories (default: true). |
Authentication Requirement
Before using the deploy command, you must be authenticated with the Buster API:
The deploy command will automatically check for valid authentication and prompt you if not authenticated.
Deployment Process
When you run buster deploy
, the following steps occur:
- Authentication Check: Verifies you have valid Buster API credentials
- File Discovery: Finds all semantic model files in the specified paths
- Validation: Parses and validates each model (similar to
buster parse
) - Conflict Resolution: Handles any conflicts with existing models
- Publishing: Uploads the models to the Buster platform
- Activation: Makes models available for natural language querying
Example Output
The command provides detailed progress information during deployment:
Examples
Deploy All Models
Deploy all models defined in your buster.yml:
Deploy Specific Directory
Deploy only models in a specific directory:
Validate Without Deploying
Check if models would deploy successfully without actually deploying them:
Troubleshooting
Common issues and their solutions:
- Authentication errors: Run
buster auth
to refresh your credentials - Validation failures: Run
buster parse
first to identify and fix issues - API connectivity issues: Check your network connection and firewall settings
- Incompatible models: Ensure your models follow the latest Buster semantic model schema
Best Practices
- Run Parse First: Use
buster parse
before deploying to catch issues early - Use Version Control: Commit your models to version control before deployment
- Test Locally: Use the
--dry-run
flag to validate without deploying - Deploy Regularly: Keep your deployed models in sync with your development
- Check Deployment Status: Verify in the Buster UI that models deployed correctly