Skip to content

dct describe

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

dct describe [OPTIONS] PATH...

Arguments

Argument Description
PATH... Path(s) to board 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

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

When given a directory, dct 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.