`dct docs`¶

Browse the dbt Charts YAML reference offline. The syntax guide lives in one file (dbt_charts/DBT_CHARTS_SYNTAX.md in the wheel) with one H2 per topic; the generated field, error, and warning references ship beside it and appear in the topic index as reference, error-reference, and warning-reference. Useful when you're editing YAML without a browser, or when an AI agent needs to look something up. The topic index also links to the full web docs site.

dct docs [OPTIONS] [TOPIC]

Modes¶

Invocation	Behavior
`dct docs`	Topic index: one row per topic, each with a one-line description
`dct docs cheatsheet`	One-page essentials: the shape of a board in one screen
`dct docs <topic>`	One H2 section by slugified name
`dct docs all`	Syntax guide plus the generated field reference, unsliced
`dct docs reference`	Generated YAML field reference
`dct docs errors`	List every registered error code with a one-line summary
`dct docs errors <CODE>`	Full documentation for one error code
`dct docs warnings`	List every registered render-time warning code with a one-line summary
`dct docs warnings <CODE>`	Full documentation for one warning code
`dct docs --search "grid"`	Ranked search across every topic section and the generated references
`dct docs charts --search "legend"`	The same search, scoped to one topic

Both errors and warnings are filtered views over the same diagnostic registry; a code typed under the "wrong" verb still resolves and reports its actual level, rather than failing with an unknown-code error.

Arguments¶

Argument	Description
`TOPIC`	Topic slug, slugified H2 heading (for example, `board`, `charts`, `queries`, `layout`). Use `all` for the syntax guide plus the field reference, `reference` for the field reference alone, `errors` to browse error codes, or `warnings` to browse render-time warning codes. Omit for the topic index.
`CODE`	Diagnostic code to look up in detail (for example, `ERR-NO-LAYOUT`, `WARN-REDUNDANT-ENCODING`). Only valid when `TOPIC` is `errors` or `warnings`; case-insensitive.

Options¶

Flag	Description
`--search TEXT`, `-s TEXT`	Ranked term search (BM25) over every H2/H3 section of the reference plus the generated field, error, and warning references. Multi-word queries match on terms, not the exact phrase. Pass a `TOPIC` as well to scope the hits to that topic. Each hit prints the whole matched section and names the topic to read next with `dct docs <topic>`.
`--json`	Stable JSON output suitable for agent consumption.
`--limit INT`	Max search hits to return. Default 5, max 20.

Examples¶

dct docs                          # Topic index
dct docs cheatsheet               # One-page essentials
dct docs charts                   # Full docs for the charts topic
dct docs all                      # Syntax guide + field reference, unsliced
dct docs reference                # Generated YAML field reference
dct docs errors                   # List every registered error code
dct docs errors ERR-NO-LAYOUT     # Full doc for one error code
dct docs warnings                 # List every render-time warning code
dct docs warnings WARN-REDUNDANT-ENCODING  # Full doc for one warning code
dct docs --search "grid layout"   # Ranked search across topics
dct docs charts -s "hide legend"  # Ranked search scoped to the charts topic
dct docs charts --json            # Agent-shaped output

When to use which discovery verb¶

If you want…	Use
Reference docs about YAML fields, chart types, layout	`dct docs`
To search dashboards in your project	`dct search`
To explore the warehouse schema	`dct query` against `INFORMATION_SCHEMA`
Packaged agent skill examples	`dct skills`

dct docs¶