READMEs · Open-source developer software

yq README

README demonstrates: A lightweight and portable command-line YAML, JSON, INI and XML processor. `yq` uses jq (a popular JSON processor) like syntax but works with yaml files as well as json, kyaml, xml, ini, properties, csv and tsv. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously. yq is written in Go - so you can download a dependency free bi GitHub's fetched Contents API response identifies README.md and reports the current blob SHA e8b42b0edd83f3e26e09e40ff9e6ae79ec8854cf The fetched GitHub commits endpoint identifies ef305adbe5a703a994f431812e0521d81f5f8668 as the latest commit affecting this README path.

Reviewed 2026-10-09View reviewed source ↗

Our interpretation

Useful when you are building…

Use this README as a reference for explaining yq and helping users find setup and usage information.

Visible first resultUpfront prerequisitesSupport routes

Observed in the source

Patterns and sections

Collapse file tree

This README section provides readers a route to collapse file tree guidance.

Files

This README section provides readers a route to files guidance.

README.md

This README section provides readers a route to readme.md guidance.

Section labels refer to the reviewed public source. Visual design and mobile behavior of the external page were not evaluated.

Adaptation ideas

What to apply to your own product

State the tool's purpose and audience in a concise opening.
Provide a usable first action and list system or account prerequisites.
Link to documentation and support routes with descriptive labels.

Tradeoff to consider

The README primarily serves project users and maintainers, so business buyers may still need product, support and pricing context.

Starting route

Start with Collapse file tree and follow the linked installation or quickstart route.

Source and version

yq/README.md at ef305adbe5a703a994f431812e0521d81f5f8668 · mikefarah/yq · GitHub ↗https://github.com/mikefarah/yq/blob/ef305adbe5a703a994f431812e0521d81f5f8668/README.md

Reviewed README at commit ef305adbe5a703a994f431812e0521d81f5f8668. The linked file is pinned to that revision; the live repository may change.

Retrieved with Firecrawl. Content reviewed; product not installed or tested. Annotations are original editorial analysis.