yq

Read, query, and transform YAML files from the command line using yq syntax.

2|Updated Mar 25, 2026
One-click install
npx skills add https://github.com/slabgorb/sidequest --skill yq-slabgorb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: yq
Source: https://github.com/slabgorb/sidequest/tree/main/.pennyfarthing/skills/pf-yq
Command: npx skills add https://github.com/slabgorb/sidequest --skill yq-slabgorb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

YAML data is common in configuration and deployment workflows; this skill helps users read, query, and modify YAML content quickly from the command line, reducing manual editing and errors.

Core Features & Use Cases

  • Read and extract values from YAML files using expressive queries.
  • Modify YAML content in place or generate updated outputs for automation.
  • Convert or format YAML data for JSON interoperability and scripting workflows.

Quick Start

Run yq to read or modify a YAML file, starting with a sample file named config.yaml.

Frequently Asked Questions about yq

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I extract a specific value from a YAML configuration file?

Query YAML data from the command line using yq to read and extract specific values with expressive queries. It handles missing keys robustly and outputs the exact configuration data needed for your software projects.

Can I convert YAML to JSON for scripting workflows?

You can convert YAML to JSON for scripting workflows using yq's format conversion features. It transforms YAML configuration content into JSON output, ensuring data interoperability and seamless integration across different automation and processing pipelines.

How do I modify YAML content in place for automation tasks?

Modify YAML content in place for automation tasks by running yq commands that write updates directly to the file. It generates updated outputs and streamlines configuration modifications across deployment environments without manual editing errors.

Do I need to install a specific YAML processor to use this?

Yes, using this skill requires a YAML processor like mikefarah/yq installed in your environment. It depends on this CLI tool to execute read, write, and format conversion operations on YAML data.

What happens when querying missing keys in YAML data?

When querying missing keys in YAML data, the processor provides robust handling to prevent script failures. It safely manages absent keys during data extraction and modification, reducing manual editing errors in automation workflows.