yq-yaml-processing
yq YAML processing: query, filter, transform YAML. Use when parsing configs, modifying Kubernetes manifests or GitHub Actions workflows, or transforming YAML.
How do I install this agent skill?
npx skills add https://github.com/laurigates/claude-plugins --skill yq-yaml-processingIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides comprehensive instructions for using the yq YAML processor for querying and transforming configuration files. It is well-documented, focuses on standard development tasks like managing Kubernetes manifests, and contains no malicious patterns or security risks.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1/2 files flagged
What does this agent skill do?
yq YAML Processing
Expert knowledge for processing, querying, and transforming YAML data using yq v4+, the lightweight command-line YAML processor with jq-like syntax.
When to Use This Skill
| Use this skill when... | Use another skill instead when... |
|---|---|
| Querying or modifying YAML files | The input is JSON only — use jq-json-processing |
| Editing YAML in place while preserving comments and key order | Multi-step transforms spanning YAML, JSON, CSV, TOML — use nushell-data-processing |
| Targeted updates to a Kubernetes manifest or Actions workflow | Full Kubernetes management (use kubectl); XML (use xmlstarlet) |
| Merging YAML configurations | Aggregating or grouping across many files — use nushell-data-processing |
Core Expertise
YAML Operations
- Query and filter YAML with path expressions
- Transform YAML structure and shape
- Multi-document YAML support
- Convert between YAML, JSON, XML, and other formats
Configuration Management
- Modify Kubernetes manifests
- Update GitHub Actions workflows
- Process Helm values files
- Manage application configurations
Essential Commands
Basic Querying
# Pretty-print YAML
yq '.' file.yaml
# Extract specific field
yq '.fieldName' file.yaml
# Extract nested field
yq '.spec.containers[0].name' pod.yaml
# Access array element
yq '.[0]' array.yaml
yq '.items[2]' data.yaml
Reading YAML
# Read specific field
yq '.metadata.name' deployment.yaml
# Read nested structure
yq '.spec.template.spec.containers[].image' deployment.yaml
# Read with default value
yq '.optional // "default"' file.yaml
# Check if field exists
yq 'has("fieldName")' file.yaml
Modifying YAML (In-Place)
# Update field value
yq -i '.metadata.name = "new-name"' file.yaml
# Update nested field
yq -i '.spec.replicas = 3' deployment.yaml
# Add new field
yq -i '.metadata.labels.app = "myapp"' file.yaml
# Delete field
yq -i 'del(.spec.nodeSelector)' file.yaml
# Append to array
yq -i '.items += {"name": "new-item"}' file.yaml
# Update all matching elements
yq -i '(.items[] | select(.name == "foo")).status = "active"' file.yaml
Multi-Document YAML
# Split multi-document YAML
yq -s '.metadata.name' multi-doc.yaml
# Select specific document (0-indexed)
yq 'select(document_index == 0)' multi-doc.yaml
# Process all documents
yq eval-all '.' multi-doc.yaml
# Filter documents
yq 'select(.kind == "Deployment")' k8s-resources.yaml
# Combine YAML files
yq eval-all '. as $item ireduce ({}; . * $item)' file1.yaml file2.yaml
Object Operations
# Get all keys
yq 'keys' file.yaml
# Select specific fields
yq '{name, version}' file.yaml
# Merge objects
yq '. * {"updated": true}' file.yaml
yq eval-all 'select(fileIndex == 0) * select(fileIndex == 1)' base.yaml override.yaml
# Deep merge
yq eval-all '. as $item ireduce ({}; . *+ $item)' base.yaml override.yaml
JSON Output (for piping)
# YAML to JSON
yq -o=json '.' file.yaml
# Compact single-line JSON — the form to pipe into jq or a tool that reads stdin
yq -o=json -I=0 '.' file.yaml
Quick Reference
Operators
.field- Access field.[]- Iterate array/object|- Pipe (chain operations),- Multiple outputs//- Alternative operator (default value)*- Merge objects (shallow)*+- Deep merge objects
Functions
keys,values- Object keys/valueslength- Array/object/string lengthselect()- Filtersort_by()- Sortgroup_by()- Groupunique- Remove duplicateshas()- Check field existencetype- Get value typeadd- Sum or concatenatedel()- Delete field
Flags
| Flag | Description |
|---|---|
-i | In-place edit |
-o | Output format (json, yaml, xml, csv, tsv, props) |
-p | Input format (json, yaml, xml) |
-I | Indent (default: 2) |
-r | Raw output (no quotes) |
-n | Null input (create from scratch) |
-s | Split multi-document YAML |
String Functions
split(),join()- String/array conversioncontains()- String/array containstest()- Regex matchsub(),gsub()- String substitutionupcase,downcase- Case conversion
For detailed examples, advanced patterns, and best practices, see REFERENCE.md.
Resources
- Official Documentation: https://mikefarah.gitbook.io/yq/
- GitHub Repository: https://github.com/mikefarah/yq
- Try with Docker:
docker run --rm -i mikefarah/yq '.key' <<< 'key: value' - Operators Reference: https://mikefarah.gitbook.io/yq/operators/
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/laurigates/claude-plugins/yq-yaml-processing">View yq-yaml-processing on skillZs</a>