buster/cli/README.md

882 B

buster-cli

A CLI tool for creating and managing your semantic model in Buster.

This tool is two-way compatible with your dbt projects as well. We like dbt and think its a great tool,

Installation

TODO

How does it work?

You can imagine Buster as a layer on top of your dbt project that allows you to create and manage semantic models.

Quick Start

  1. Obtain your Buster API key. You can create one here.

Initialize your project by running:

buster init

This command will go through the following steps:

  1. Authenticate with your Buster API key.
  2. Checks to see if you have an existing dbt project. If you do, you will be prompted to use the existing project or create a new one.
  • If you choose to use the existing project, Buster will use the existing project to create semantic model files.