{"schemaVersion":"opencli.cli.v1","slug":"yq","name":"yq","shortName":"yq","binaryName":"yq","maker":{"slug":"mike-farah","name":"Mike Farah","type":"individual","url":"https://github.com/mikefarah","officialPlatformMaker":false,"featuredBuilder":true},"category":"Data","description":"YAML processing, config edits, and kubernetes files from the terminal. Built by Mike Farah.","tagline":"YAML processing, config edits, and kubernetes files from the terminal.","install":{"packageManager":"brew","command":"brew install yq","packageName":null,"npmPackage":null,"brewFormula":"yq","brewCask":null,"crateName":null,"pypiPackage":null,"goPackage":null,"dockerImage":null},"verify":{"command":"yq --version","signal":"yq responds locally and is ready for the first real command."},"quickStart":"yq '.services.web.image' docker-compose.yml","exampleWorkflow":["yq '.services.web.image' docker-compose.yml"],"agent":{"readiness":{"label":"Usable with guardrails","score":50,"reasons":["Supports non-interactive/scripted use.","Works well in CI or repeatable automation."],"guardrails":["Prefer small commands and ask the agent to summarize plain text output."]},"packUrl":"https://opencli.co/cli/yq/agent.md","packMarkdown":"# OpenCLI Agent Pack: yq\n\nUse this when an AI agent needs to work with `yq`.\n\n## What this CLI is for\nYAML processing, config edits, and kubernetes files from the terminal. Built by Mike Farah.\n\nBest for: yaml processing, config edits, and kubernetes files from the terminal.\n\n## Agent readiness\nUsable with guardrails (50/100)\n- Supports non-interactive/scripted use.\n- Works well in CI or repeatable automation.\n\n## Install\n```sh\nbrew install yq\n```\n\n## Verify before real work\n```sh\nyq --version\n```\nExpected signal: yq responds locally and is ready for the first real command.\n\n## Safe starting commands\n```sh\nyq --version\n```\n\n```sh\nyq '.services.web.image' docker-compose.yml\n```\n\n## Guardrails for agents\n- Prefer small commands and ask the agent to summarize plain text output.\n\n## Suggested agent instruction\nYou may use yq (`yq`) for yaml processing, config edits, and kubernetes files from the terminal.. First install it if missing, then run the verify command. Start with read-only or inspection commands. Summarize what you found before changing anything. Ask for confirmation before commands that mutate remote state, spend money, deploy, delete data, merge code, or expose secrets.\n\nSource: OpenCLI\n"},"fit":{"bestFor":"yaml processing, config edits, and kubernetes files from the terminal.","useThisIf":"You need data processing in both local dev and CI.","skipIf":"You don't work with data processing.","whatHappensNext":"Run `yq '.services.web.image' docker-compose.yml` and see what comes back."},"capabilities":{"agentFriendly":true,"supportsJsonOutput":false,"supportsNonInteractive":true,"supportsDryRun":false,"requiresAuth":false,"requiresNetwork":false,"ciFriendly":true,"localFirst":false,"destructivePotential":"low"},"taxonomy":{"useCases":["YAML processing","Config edits","Kubernetes files"],"aliases":["yaml cli"],"keywords":["yaml query edit"],"tags":["builder","shell-essential","agent-friendly","ci-friendly"]},"links":{"website":"https://mikefarah.gitbook.io/yq/","github":"https://github.com/mikefarah/yq","docs":"https://mikefarah.gitbook.io/yq/","opencli":"https://opencli.co/cli/yq","markdown":"https://opencli.co/cli/yq/agent.md","json":"https://opencli.co/cli/yq.json"},"metrics":{"githubStars":15502,"latestRelease":"2026-06-07T10:09:50Z","license":"MIT","metricLabel":"Homebrew installs (30d)","metricValue":47765,"metricSource":"homebrew","metricAsOf":"2026-06-08T11:00:42.628Z"}}