Skip to content

Deploy dbt-tools

dbt-tools reads dbt artifacts from a target root. The same target root configuration works across CLI, Web, and MCP.

Supported target roots

TypeFormatExample
Local directoryFilesystem path./target
Amazon S3s3://bucket/prefixs3://my-bucket/dbt/prod/latest
Google Cloud Storagegs://bucket/prefixgs://my-bucket/dbt/prod/latest

How to specify the target root

Use the --dbt-target flag or the DBT_TOOLS_DBT_TARGET environment variable:

bash
# Flag
npx @dbt-tools/cli status --dbt-target ./target --json

# Environment variable
export DBT_TOOLS_DBT_TARGET=./target
npx @dbt-tools/cli status --json

All three surfaces (CLI, Web, MCP) accept the same --dbt-target flag and environment variable.

Required artifacts

Every target root must contain:

FileRequired
manifest.jsonYes
run_results.jsonYes (for run-related commands)
catalog.jsonNo (enables column-level metadata)
sources.jsonNo (enables source freshness data)

Deployment guides

  • Local target directory — use ./target from a dbt project
  • S3 — configure credentials and read artifacts from an S3 bucket
  • GCS — configure credentials and read artifacts from a GCS bucket
  • GitHub Actions — run dbt-tools in CI
  • Credentials — credential precedence and least-privilege setup

Released under the repository license terms.