Skip to content

dft describe

Describe a dashboard's queries, charts, variables, and layout.

dft describe [OPTIONS] PATH...

Arguments

Argument Description
PATH... Path(s) to face YAML files or directories. One or more required.

Options

Flag Description
--json Output as JSON.
--project-dir PATH Project directory for resolving relative paths.

Examples

dft describe faces/sales.yml
dft describe faces/sales.yml --json
dft describe faces/sales.yml faces/inventory.yml --json
dft describe faces/
dft describe faces/*.yml --json | jq '.[] | select(.charts | length > 5)'

When given a directory, dft describe globs **/*.yml and **/*.yaml, skipping any file whose name starts with _ (partials and templates).

JSON output shape

Single file: returns a JSON object. Two or more files: returns a JSON array. Exit code is 1 if any file has errors.