Skip to content

CLI cheatsheet

Curated commands for daily use. Full flags and examples: packages/cli/README.md.

Set DBT_TOOLS_DBT_TARGET=./target or pass --dbt-target ./target on every command. Remote targets: Local and remote artifacts.

Remote targets

bash
dbt-tools status --dbt-target ./target
dbt-tools status --dbt-target s3://my-bucket/dbt/prod
dbt-tools status --dbt-target gs://my-bucket/dbt/prod

Readiness and manifest

CommandPurpose
statusArtifact presence and readiness
summaryManifest statistics
freshnessAlias for status
bash
dbt-tools status --dbt-target ./target --json
dbt-tools summary --dbt-target ./target --fields "total_nodes" --json

Discovery and inventory

CommandPurpose
discoverRanked search with reasons (preferred)
searchResource search (shared parsing; different output shape)
inventoryList/filter resources
bash
dbt-tools discover --dbt-target ./target "orders" --json
dbt-tools inventory --dbt-target ./target --type model --json

Graph and dependencies

CommandPurpose
depsUpstream/downstream dependencies
graphExport graph (JSON, DOT, GEXF)
explainIntent-shaped resource summary
bash
dbt-tools deps model.pkg.node --dbt-target ./target --direction downstream --json
dbt-tools explain model.pkg.node --dbt-target ./target --json

Execution

CommandPurpose
query-executionsFilter/sort run executions
timelinePer-node execution timeline
run-summaryRun-level aggregates
run-reportExecution report + critical path
bash
dbt-tools query-executions --dbt-target ./target --sort duration --limit 20 --json
dbt-tools run-report --dbt-target ./target --json

Introspection

CommandPurpose
schemaRuntime command/field schemas
bash
dbt-tools schema --json

Common flags

FlagPurpose
--jsonMachine-readable stdout
--fields "a,b"Shrink JSON payloads
--traceInvestigation transcript on intent/discover output

Workflows

Released under the repository license terms.