Skip to content

Common CLI tasks

The CLI is for one-shot, scriptable analysis: JSON output, stable exit codes, and --fields to shrink payloads for CI and agents.

Commands to learn first

CommandPurpose
statusArtifact presence and readiness (full, manifest-only, unavailable)
summaryManifest statistics
discoverRanked search with scores and reasons
explainStructured summary for one unique_id
depsUpstream or downstream dependencies
query-executionsFilter and sort run executions

Patterns

JSON for automation (default in non-TTY):

bash
dbt-tools summary --dbt-target ./target --json
dbt-tools discover --dbt-target ./target "orders" --json

Shrink output with --fields:

bash
dbt-tools summary --dbt-target ./target --fields "total_nodes,total_edges" --json

Environment variable instead of repeating the flag:

bash
export DBT_TOOLS_DBT_TARGET=./target
dbt-tools status

Workflows

Learn more

Released under the repository license terms.