92 /100
yq is useful for agents when usage is constrained to predictable commands and documented output.
Installability 96/100
Availability through common package managers and simple install commands.
Structured output 92/100
JSON, YAML, CSV, markdown, or stable machine-readable output for agents.
Safety 78/100
Clear read-only commands, dry-run options, and approval gates for destructive work.
Agent docs 84/100
How easily an agent can learn the command surface from docs, help, and examples.
Install options
Recommended
$ brew install yq Common commands
Show help · safe
$ yq --help Inspect command surface before automation.
Check version · safe
$ yq --version Verify the installed CLI.
Agent usage examples
Claude Code / Codex CLI / Gemini CLI
Use yq only with non-interactive commands. Prefer structured output: yaml, json, text. Ask before destructive operations. Safety notes
- Prefer non-interactive usage and explicit output flags when an agent runs this command.
- Treat commands that deploy, delete, charge money, or mutate production data as approval-required.
- Record the exact command, output format, and scope before adding it to an agent workflow.
What agents can use it for
A scriptable CLI for transforming YAML, JSON, XML, TOML, and properties files.
Agent usage rule
Prefer non-interactive commands, structured output, and approval gates for state-changing operations.
Install
brew install yq