home / skills / dbt-labs / dbt-agent-skills / running-dbt-commands

running-dbt-commands skill

/skills/running-dbt-commands

This skill helps execute dbt commands reliably by selecting appropriate CLI flavor, applying best practices, and validating selectors for efficient builds.

npx playbooks add skill dbt-labs/dbt-agent-skills --skill running-dbt-commands

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
5.8 KB
---
name: running-dbt-commands
description: Use when executing dbt commands via CLI - running models, tests, builds, compiles, or show queries. Use when unsure which dbt executable to use or how to format command parameters.
user-invocable: false
metadata:
  author: dbt-labs
---

# Running dbt Commands

## Preferences

1. **Use MCP tools if available** (`dbt_build`, `dbt_run`, `dbt_show`, etc.) - they handle paths, timeouts, and formatting automatically
2. **Use `build` instead of `run` or `test`** - `test` doesn't refresh the model, so testing a model change requires `build`. `build` does a `run` and a `test` of each node (model, seed, snapshot) in the order of the DAG
3. **Always use `--quiet`** with `--warn-error-options '{"error": ["NoNodesForSelectionCriteria"]}'` to reduce output while catching selector typos
4. **Always use `--select`** - never run the entire project without explicit user approval

## Quick Reference

```bash
# Standard command pattern
dbt build --select my_model --quiet --warn-error-options '{"error": ["NoNodesForSelectionCriteria"]}'

# Preview model output
dbt show --select my_model --limit 10

# Run inline SQL query
dbt show --inline "select * from {{ ref('orders') }}" --limit 5

# With variables (JSON format for multiple)
dbt build --select my_model --vars '{"key": "value"}'

# Full refresh for incremental models
dbt build --select my_model --full-refresh

# List resources before running
dbt list --select my_model+ --resource-type model
```

## dbt CLI Flavors

Three CLIs exist. **Ask the user which one if unsure.**

| Flavor | Location | Notes |
|--------|----------|-------|
| **dbt Core** | Python venv | `pip show dbt-core` or `uv pip show dbt-core` |
| **dbt Fusion** | `~/.local/bin/dbt` or `dbtf` | Faster and has stronger SQL comprehension |
| **dbt Cloud CLI** | `~/.local/bin/dbt` | Go-based, runs on platform |

**Common setup:** Core in venv + Fusion at `~/.local/bin`. Running `dbt` uses Core. Use `dbtf` or `~/.local/bin/dbt` for Fusion.

## Selectors

**Always provide a selector.** Graph operators:

| Operator | Meaning | Example |
|----------|---------|---------|
| `model+` | Model and all downstream | `stg_orders+` |
| `+model` | Model and all upstream | `+dim_customers` |
| `+model+` | Both directions | `+orders+` |
| `model+N` | Model and N levels downstream | `stg_orders+1` |

```bash
--select my_model              # Single model
--select staging.*             # Path pattern
--select fqn:*stg_*            # FQN pattern
--select model_a model_b       # Union (space)
--select tag:x,config.mat:y    # Intersection (comma)
--exclude my_model             # Exclude from selection
```

**Resource type filter:**
```bash
--resource-type model
--resource-type test --resource-type unit_test
```

Valid types: `model`, `test`, `unit_test`, `snapshot`, `seed`, `source`, `exposure`, `metric`, `semantic_model`, `saved_query`, `analysis`

## List

Use `dbt list` to preview what will be selected before running. Helpful for validating complex selectors.

```bash
dbt list --select my_model+              # Preview selection
dbt list --select my_model+ --resource-type model  # Only models
dbt list --output json                   # JSON output
dbt list --select my_model --output json --output-keys unique_id name resource_type config
```

**Available output keys for `--output json`:**
`unique_id`, `name`, `resource_type`, `package_name`, `original_file_path`, `path`, `alias`, `description`, `columns`, `meta`, `tags`, `config`, `depends_on`, `patch_path`, `schema`, `database`, `relation_name`, `raw_code`, `compiled_code`, `language`, `docs`, `group`, `access`, `version`, `fqn`, `refs`, `sources`, `metrics`

## Show

Preview data with `dbt show`. Use `--inline` for arbitrary SQL queries.

```bash
dbt show --select my_model --limit 10
dbt show --inline "select * from {{ ref('orders') }} where status = 'pending'" --limit 5
```

**Important:** Use `--limit` flag, not SQL `LIMIT` clause.

## Variables

Pass as STRING, not dict. No special characters (`\`, `\n`).

```bash
--vars 'my_var: value'                              # Single
--vars '{"k1": "v1", "k2": 42, "k3": true}'         # Multiple (JSON)
```

## Analyzing Run Results

After a dbt command, check `target/run_results.json` for detailed execution info:

```bash
# Quick status check
cat target/run_results.json | jq '.results[] | {node: .unique_id, status: .status, time: .execution_time}'

# Find failures
cat target/run_results.json | jq '.results[] | select(.status != "success")'
```

**Key fields:**
- `status`: success, error, fail, skipped, warn
- `execution_time`: seconds spent executing
- `compiled_code`: rendered SQL
- `adapter_response`: database metadata (rows affected, bytes processed)

## Defer (Skip Upstream Builds)

Reference production data instead of building upstream models:

```bash
dbt build --select my_model --defer --state prod-artifacts
```

**Flags:**
- `--defer` - enable deferral to state manifest
- `--state <path>` - path to manifest from previous run (e.g., production artifacts)
- `--favor-state` - prefer node definitions from state even if they exist locally

```bash
dbt build --select my_model --defer --state prod-artifacts --favor-state
```

## Static Analysis (Fusion Only)

Override SQL analysis for models with dynamic SQL or unrecognized UDFs:

```bash
dbt run --static-analysis=off
dbt run --static-analysis=unsafe
```

## Common Mistakes

| Mistake | Fix |
|---------|-----|
| Using `test` after model change | Use `build` - test doesn't refresh the model |
| Running without `--select` | Always specify what to run |
| Using `--quiet` without warn-error | Add `--warn-error-options '{"error": ["NoNodesForSelectionCriteria"]}'` |
| Running `dbt` expecting Fusion when we are in a venv | Use `dbtf` or `~/.local/bin/dbt` |
| Adding LIMIT to SQL in `dbt_show` | Use `limit` parameter instead |
| Vars with special characters | Pass as simple string, no `\` or `\n` |

Overview

This skill helps agents construct and run dbt CLI commands safely and predictably. It codifies best practices for selecting models, choosing the correct dbt flavor, passing variables, and interpreting run results so commands behave as users expect.

How this skill works

The skill inspects the desired action (build, run, test, show, list) and builds a recommended dbt CLI invocation with safe defaults: explicit --select, --quiet plus warn-error options, and appropriate flags for vars, limits, full-refresh, defer/state, or static analysis. It also guides which dbt executable to use (core, fusion, or cloud CLI) and how to preview selections with dbt list before executing.

When to use it

  • When running or testing specific models and you need a safe, explicit CLI command
  • When unsure which dbt executable (dbt, dbtf, or platform CLI) to invoke
  • When previewing which resources a selector will target before executing
  • When passing variables, limits, or full-refresh options to dbt commands
  • When you want to defer upstream builds to production artifacts or favor state

Best practices

  • Always include an explicit --select; never run the whole project without approval
  • Prefer dbt build (runs + tests) over running test alone after model changes
  • Use --quiet with --warn-error-options '{"error": ["NoNodesForSelectionCriteria"]}' to catch selector typos while minimizing noise
  • Preview targeted nodes with dbt list --select <selector> (use --output json for programmatic checks)
  • Ask which dbt CLI flavor to use; use dbtf or ~/.local/bin/dbt for Fusion if available

Example use cases

  • Build a single model and its downstream models: dbt build --select stg_orders+ --quiet --warn-error-options '{"error": ["NoNodesForSelectionCriteria"]}'
  • Preview selection output before running: dbt list --select my_model+ --resource-type model --output json
  • Inspect sample rows from a model: dbt show --select my_model --limit 10
  • Run an inline SQL preview: dbt show --inline "select * from {{ ref('orders') }}" --limit 5
  • Run using production artifacts for deferral: dbt build --select my_model --defer --state prod-artifacts --favor-state

FAQ

Which dbt executable should I use?

If unsure, ask the user. Common setups: dbt Core in a virtualenv (command dbt), Fusion installed at ~/.local/bin/dbt or dbtf (use dbtf for Fusion), or the cloud CLI at ~/.local/bin/dbt.

Why prefer build over run or test?

dbt build performs both run and test for each node and refreshes models; test alone does not rebuild models after changes.