Get yq on macOS and Linux Now!
yq is a portable command-line YAML, JSON, XML, CSV, TOML, HCL and properties processor
Get yq with one command
Pick your system, reveal the step-by-step guide, copy the command, paste it into your terminal and press Enter. This command comes from the project's public source.
Not available for Windows yet.
yq doesn't publish an install command for Windows anywhere we can verify, so there's nothing for us to show you. We won't invent one. It does document one for macOS and Linux — switch to that tab.
Pastes into PowerShell and installs yq on your Windows machine in one step. Runs as your normal user account, and needs no administrator rights.
Not available for macOS yet.
yq doesn't publish an install command for macOS or Linux anywhere we can verify, so there's nothing for us to show you. We won't invent one.
Installs yq on your macOS or Linux machine and links it into your PATH — after this,
yq just works from any directory. Runs as your normal user account, and needs no administrator rights.
How to set up yq, step by step
Open Terminal. On a Mac it's in Applications ▸ Utilities, or press Cmd+Space and type Terminal. On Linux, press Ctrl+Alt+T. Paste the command and press Enter.
Run yq --help to see the available commands, and
yq --version to confirm the install worked. If your shell complains about
permissions, that project usually documents a corrected command on its own site.
This asks Homebrew to fetch yq and link it into /opt/homebrew/bin (Apple Silicon) or /usr/local/bin (Intel), so you can run it by name.
What yq does
- Uses similar syntax as but works with YAML, INI, JSON and XML files
- Date/Time manipulation and formatting with TZ
- Manipulate yaml comments, styling, tags and anchors and aliases
- Complex expressions to select and update
- Error Handling: Encounter a syntax error? It will display the error message and the results of the closest valid filter
- Examples: Recipes and examples
Summarised from yq's own documentation.
About yq
yq is a portable command-line YAML, JSON, XML, CSV, TOML, HCL and properties processor
| Category | Command-line tool |
|---|---|
| Install method | Homebrew |
| Windows | no install command published |
| macOS / Linux | documented install command available |
| Price | Free and open source |
| Command verified | From project source |
| Popularity | 16k stars on the project's public repository |
On mobile
yq is a command-line tool, so there is no phone app for it — a phone has no shell to run it in. You'll need a desktop, or a remote shell into a machine that has one.
yq is developed by its own authors. This page is an independent reference; we are not affiliated with or sponsored by the project. The command shown here was reproduced from the project's public documentation — always check the project's own documentation before running anything.