NAME

yq - YAML query command for Developer Dashboard

SYNOPSIS

dashboard yq [path] [file]

DESCRIPTION

This command provides YAML path extraction for Developer Dashboard.

PURPOSE

This staged helper owns the public dashboard yq command. It accepts an optional dotted YAML path plus an optional input file, then hands the request to the shared query runtime so parsing, file-vs-STDIN handling, and output formatting stay consistent with the rest of the dashboard toolchain.

WHY IT EXISTS

It exists because the dashboard ships a private, repo-local YAML inspection tool instead of depending on a globally installed parser binary. Keeping yq as a staged helper also preserves the thin-switchboard contract in bin/dashboard.

WHEN TO USE

Use this file when you are changing how dashboard yq chooses between STDIN and files, how it reports parse errors, or how the staged helper is wired into the shared query implementation.

HOW TO USE

Users run dashboard yq [path] [file]. The staged helper selects the YAML backend in the shared query runtime, which accepts the file and path in either order, reads STDIN when no file is given, prints scalar hits as plain text, and prints the whole parsed document when the path is $d or ..

WHAT USES IT

It is used by the public dashboard yq command, by shell snippets that want a runtime-local YAML query tool, by integration smoke runs, and by the focused query-helper coverage under t/.

EXAMPLES

printf 'alpha:\n  beta: 3\n' | dashboard yq alpha.beta
dashboard yq config.yml '$d'
dashboard yq '$d' config.yml
printf 'items:\n  - name: demo\n' | dashboard yq items.0.name