Getting started with @dbt-tools/web
Artifact-driven investigation UI: dependency graphs, execution timelines, inventory search, and health summaries from manifest.json and run_results.json—no LLM required.
Use dbt-tools-web when you want a browser to explore lineage, critical path, bottlenecks, and inventory over a local target/ directory or remote s3:// / gs:// sources.
Install and run
npx @dbt-tools/web --help
npx @dbt-tools/web --dbt-target ./target--target ./target remains a shorthand for local directories (sets DBT_TOOLS_TARGET_DIR). For remote URIs, use --dbt-target.
# Remote GCS (credentials on the Node process, not in the browser)
npx @dbt-tools/web \
--dbt-target gs://my-bucket/dbt/prod \
--gcs-impersonate-service-account reader@project.iam.gserviceaccount.comOpen the URL printed in the terminal (default 127.0.0.1:3000 unless you pass --port). Monorepo Vite dev (pnpm dev:web) listens on 5173.
Load artifacts
If you skip --dbt-target, or want to switch after startup, use in-app Load artifacts. This is a server-mediated path or URI—not a browser file upload.
- Choose Local, S3, or GCS.
- Enter a directory path or
s3:///gs://prefix (resolved on the Node process). - Scan location, then Load workspace.
Remote buckets poll about every 30s. When a newer complete artifact pair appears, the banner Remote update available offers Load latest remote run. The current investigation stays loaded until you switch—there is no auto-switch.
See Local and remote artifacts.
Learn more
- Web server CLI — full flag list (aligned with MCP)
- Configuration — environment variables
- Package README
- Troubleshooting — common setup issues