`dft docs`¶

Browse the Dataface YAML reference offline. The reference lives in one file (dataface/DATAFACE_SYNTAX.md in the wheel) with one H2 per topic. 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.

dft docs [OPTIONS] [TOPIC]

Modes¶

Invocation	Behavior
`dft docs`	Topic index — one row per H2 with a one-line description
`dft docs cheatsheet`	One-page essentials — the shape of a face in one screen
`dft docs <topic>`	One H2 section by slugified name
`dft docs all`	The whole reference, unsliced
`dft docs reference`	Generated YAML field reference
`dft docs errors`	List every registered error code with a one-line summary
`dft docs errors <CODE>`	Full documentation for one error code
`dft docs warnings`	List every registered render-time warning code with a one-line summary
`dft docs warnings <CODE>`	Full documentation for one warning code
`dft docs --search "grid"`	Substring search across all topics

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 (e.g. `face`, `charts`, `queries`, `layout`). Use `all` for the whole file, `reference` for the generated field reference, `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 (e.g. `ERR-NO-LAYOUT`, `WARN-REDUNDANT-ENCODING`). Only valid when `TOPIC` is `errors` or `warnings`; case-insensitive.

Options¶

Flag	Description
`--search TEXT`, `-s TEXT`	Substring search across all topics.
`--json`	Stable JSON output suitable for agent consumption.
`--limit INT`	Max search hits to return. Default 5, max 50.

Examples¶

dft docs                          # Topic index
dft docs cheatsheet               # One-page essentials
dft docs charts                   # Full docs for the charts topic
dft docs all                      # Whole reference, unsliced
dft docs reference                # Generated YAML field reference
dft docs errors                   # List every registered error code
dft docs errors ERR-NO-LAYOUT     # Full doc for one error code
dft docs warnings                 # List every render-time warning code
dft docs warnings WARN-REDUNDANT-ENCODING  # Full doc for one warning code
dft docs --search "grid layout"   # Search across topics
dft docs charts --json            # Agent-shaped output

When to use which discovery verb¶

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

dft docs¶