Skip to main content

Get started with the dbt Wizard local CLI

Install dbt Wizard locally and start an agentic dbt development session from your terminal.

Install dbt Wizard as wizard on your PATH using the curl script for your operating system:

curl -fsSL https://public.cdn.getdbt.com/dbt-wizard/install/install-wizard.sh | sh

Then verify the install and start a session:

wizard --version   # confirm the install
wizard # start an interactive session

After running wizard --version, you should see something like dbt-wizard VERSION. Run wizard --help to see all available commands and flags. dbt Wizard installs default config files — refer to the config reference for more details.

By the end of this guide, you can install dbt Wizard locally, authenticate with your dbt platform credentials if applicable, complete first-run onboarding, and send your first prompt from the terminal.

dbt Wizard is data warehouse agnostic and works with both the dbt Fusion engine and dbt Core — no specific engine is required.

Be warned, the wizard has been known to

.

Supported AI providers

dbt Wizard

dbt Wizard supports different AI providers depending on where you use it.

Providerdbt Wizard in dbt platformdbt Wizard CLI
OpenAI✓ (managed or BYOK)✓ (OpenAI subscription or BYOK)
Anthropic✓ (BYOK)✓ (BYOK)
Azure AI Foundry / Azure OpenAI✓ (BYOK)✓ (BYOK)
AWS Bedrock-✓ (BYOK)
Google Gemini-✓ (BYOK)
Snowflake Cortex-✓ (BYOK)

Anthropic enterprise and subscription licenses (such as Claude Enterprise) aren't supported per Anthropic's terms of service. BYOK requires an Anthropic API key.

Prerequisites

You'll need:

  • An OpenAI subscription, or your own API key or provider credentials for a supported provider using BYOK: OpenAI, Anthropic, AWS Bedrock, Azure, or Snowflake Cortex (preview)
  • A dbt project set up locally

Note that the dbt Wizard CLI doesn't yet work with the dbt platform CLI (formerly the dbt Cloud CLI), support coming soon. In the meantime, run the dbt Wizard CLI in a project that uses Fusion or dbt Core.

New to the terminal?

If you've never used the terminal before, check out the terminal guide. Some tips include:

  • Enter / to see the available commands or try out /overview to get a quick summary of your project.
  • Press Shift+Tab to cycle through collaboration modes.

Complete first-run onboarding

The first time you start dbt Wizard in a project, it walks you through a short setup and saves your answers to wizard_config.toml, providers.json, and provider-auth.json, so you only do this once per project. You'll be asked to:

  • Review and accept the Terms of Use.
  • If you have a dbt platform account, sign in through the browser authentication link when prompted and follow the steps in the browser.
  • Trust the directory so dbt Wizard can read your project.
  • Confirm the path to your dbt executable or virtual environment — point it at /path/to/bin/dbt or a .venv root (dbt Wizard uses bin/dbt automatically).
  • Add any extra compile flags to append to the startup dbt compile -s state:modified+, or leave empty to skip.
  • Configure deferral — choose Wizard (dbt Wizard manages it), Manual, or Disabled. If you choose Wizard, enter the profiles.yml target to defer to (defaults to prod). On the dbt Fusion engine connected to the dbt platform, dbt Wizard instead offers to let the platform handle deferral.
  • Confirm your detected dbt profile and target, or customize the profile, target, or profiles.yml path.
  • Configure a provider (OpenAI subscription, OpenAI API key, Anthropic, Amazon Bedrock, Azure, Gemini, or Snowflake). Refer to Configure BYOK.

To re-run any of these steps later, refer to Re-trigger onboarding flows.

Set your API key without the prompt

During onboarding, dbt Wizard prompts you to configure a provider interactively. To skip the API key prompt — for headless runs like wizard exec or to reuse your key across sessions — set it as an environment variable before starting wizard instead:

export OPENAI_API_KEY="sk-..."                  # or ANTHROPIC_API_KEY
export AWS_BEARER_TOKEN_BEDROCK="ABSK..." # for Amazon Bedrock

For AWS Bedrock and Snowflake Cortex, refer to Configure BYOK.

After onboarding, dbt Wizard shows a welcome screen with two sections:

  • STATUS — the dbt Wizard version, the active AI model (change it with /model), and your project directory.
  • OVERVIEW — a snapshot of your project from the metadata engine: build status and a count of passing (✓), warning (⚠), and failing (✗) checks.

Enter / to see the available slash commands, or try /overview for a summary of your project. CLI commands use the wizard prefix, so you can also run subcommands such as wizard exec, wizard review, and wizard resume.

Once you're set up, ask your first question in your terminal. Try some prompts to see how dbt Wizard works:

Understand your project:

summarize what this project does

Find coverage gaps:

which models in this project have no tests?

Enhance coverage:

add not_null and unique tests to the primary key of stg_customers

Ship changes:

commit the changes to the branch and create a pull request

dbt Wizard will read your project's lineage, tests, and metadata and propose changes as a diff. You approve, reject, or redirect before anything is written.

dbt Wizard CLI in your terminal

For refactor or change requests, dbt Wizard automatically assesses downstream impact first by reporting affected models, metrics, and tests with a severity rating before proposing any changes.

When dbt Wizard manages deferral, you point it at a target in your profiles.yml and it compiles and defers to that target automatically, so it can validate against already-built upstream models without rebuilding everything. Refer to Deferral and state and About dbt State for details.

Useful terminal commands

Use the following commands to get started:

CommandDescriptionExample
wizard "[prompt]"Start an interactive session seeded with a prompt. Once you activate the session, you don't need to pass your prompt in quotes.wizard "summarize what this project does"
wizard exec "[prompt]"Run a single prompt non-interactively and exitwizard exec "list all models with no tests"
wizard review --uncommittedNon-interactive code review of uncommitted changeswizard review --uncommitted
wizard review --base BRANCHReview diff against a base branchwizard review --base main
wizard resumeResume a previous sessionwizard resume --last
wizard applyApply the latest Wizard diff to your working directorywizard apply TASK_ID
wizard login / logoutAuthenticate with your dbt platform accountwizard login
wizard mcpManage MCP server connectionswizard mcp add dbt
wizard updateUpdate Wizard to the latest versionwizard update
Need to re-run setup?

If you want to re-run onboarding — re-authenticate, reset project config, or retrigger the trusted folder prompt — refer to Re-trigger onboarding flows.

Next steps

Share your feedback!

We'd love to hear how dbt Wizard is working for you. Share your feedback by either running the /feedback slash command in your interactive terminal session or by going to the #dbt-wizard channel in the dbt Community Slack.

Thanks so much for your help in improving dbt Wizard and dbt data development!

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0