dft docs

Browse Dataface YAML reference docs offline. Same content as this site, accessible from the terminal — useful when you're editing YAML without a browser, or when an AI agent needs to look something up.

dft docs [OPTIONS] [TOPIC]

Modes

Invocation	Behavior
dft docs	Overview of the face schema (greeting)
dft docs <topic>	Full docs for a topic
dft docs --search "grid"	Full-text search across all topics
dft docs --list	List all available topic IDs

Arguments

Argument	Description
TOPIC	Topic ID to look up (e.g. face, charts, queries, layout).

Options

Flag	Description
--search TEXT, -s TEXT	Full-text query across all topics.
--list, -l	List all available topic IDs.
--json	Stable JSON output suitable for agent consumption.
--limit INT	Max search hits to return. Default 5, max 50.

Examples

dft docs                          # Greeting / overview
dft docs charts                   # Full docs for the charts topic
dft docs --list                   # All topic IDs
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 search the warehouse schema	dft schema-search
Packaged agent skill examples	dft skills

Related

• dft skills
• dft search
• dft schema-search