{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/623", "result": {"data":{"issuesJson":{"id":"77193e22-b056-5aff-824c-ef930929a41e","title":"mikefarah/yq: 款基于 go 语言编写类似 jq 的处理 yaml 文件的工具","number":623,"bodyHTML":"

\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Repos	mikefarah/yq
Views	$\"views\"$
Stars	$\"stars\"$
Forks	$\"forks\"$
License	$\"license\"$
UpdatedAt	$\"last-commit\"$
CreatedAt	$\"create-at\"$

\n\n

\n

\n

\n

yq

\n

$\"Build\"$ $\"Docker$ $\"Github$ $\"Go$ $\"CodeQL\"$

\n

a lightweight and portable command-line YAML, JSON, INI and XML processor. yq uses jq like syntax but works with yaml files as well as json, 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.

\n

yq is written in go - so you can download a dependency free binary for your platform and you are good to go! If you prefer there are a variety of package managers that can be used as well as Docker and Podman, all listed below.

\n

Quick Usage Guide

\n

Read a value:

\n

yq '.a.b[0].c' file.yaml

\n

Pipe from STDIN:

\n

yq '.a.b[0].c' < file.yaml

\n

Update a yaml file, in place

\n

yq -i '.a.b[0].c = \"cool\"' file.yaml

\n

Update using environment variables

\n

NAME=mike yq -i '.a.b[0].c = strenv(NAME)' file.yaml

\n

Merge multiple files

\n

# merge two files\nyq -n 'load(\"file1.yaml\") * load(\"file2.yaml\")'\n\n# merge using globs:\n# note the use of `ea` to evaluate all the files at once\n# instead of in sequence\nyq ea '. as $item ireduce ({}; . * $item )' path/to/*.yml

\n

Multiple updates to a yaml file

\n

yq -i '\n  .a.b[0].c = \"cool\" |\n  .x.y.z = \"foobar\" |\n  .person.name = strenv(NAME)\n' file.yaml

\n

Find and update an item in an array:

\n

yq '(.[] | select(.name == \"foo\") | .address) = \"12 cat st\"'

\n

Convert JSON to YAML

\n

yq -Poy sample.json

\n

See recipes for more examples and the documentation for more information.

\n

Take a look at the discussions for common questions, and cool ideas

\n

Install

\n

Download the latest binary

\n

wget

\n

Use wget to download, gzipped pre-compiled binaries:

\n

For instance, VERSION=v4.2.0 and BINARY=yq_linux_amd64

\n

Compressed via tar.gz

\n

wget https://github.com/mikefarah/yq/releases/download/${VERSION}/${BINARY}.tar.gz -O - |\\\n  tar xz && mv ${BINARY} /usr/local/bin/yq

\n

Plain binary

\n

wget https://github.com/mikefarah/yq/releases/download/${VERSION}/${BINARY} -O /usr/local/bin/yq &&\\\n    chmod +x /usr/local/bin/yq

\n

Latest version

\n

wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/local/bin/yq &&\\\n    chmod +x /usr/local/bin/yq

\n

MacOS / Linux via Homebrew:

\n

\n

brew install yq\n

\n

Linux via snap:

\n

snap install yq\n

\n

Snap notes

\n

yq installs with strict confinement in snap, this means it doesn't have direct access to root files. To read root files you can:

\n

sudo cat /etc/myfile | yq '.a.path'\n

\n

And to write to a root file you can either use sponge:

\n

sudo cat /etc/myfile | yq '.a.path = \"value\"' | sudo sponge /etc/myfile\n

\n

or write to a temporary file:

\n

sudo cat /etc/myfile | yq '.a.path = \"value\"' | sudo tee /etc/myfile.tmp\nsudo mv /etc/myfile.tmp /etc/myfile\nrm /etc/myfile.tmp\n

\n

Run with Docker or Podman

\n

Oneshot use:

\n

docker run --rm -v \"${PWD}\":/workdir mikefarah/yq [command] [flags] [expression ]FILE...

\n

Note that you can run yq in docker without network access and other privileges if you desire,
\nnamely --security-opt=no-new-privileges --cap-drop all --network none.

\n

podman run --rm -v \"${PWD}\":/workdir mikefarah/yq [command] [flags] [expression ]FILE...

\n

Pipe in via STDIN:

\n

You'll need to pass the -i\\--interactive flag to docker:

\n

docker run -i --rm mikefarah/yq '.this.thing' < myfile.yml

\n

podman run -i --rm mikefarah/yq '.this.thing' < myfile.yml

\n

Run commands interactively:

\n

docker run --rm -it -v \"${PWD}\":/workdir --entrypoint sh mikefarah/yq

\n

podman run --rm -it -v \"${PWD}\":/workdir --entrypoint sh mikefarah/yq

\n

It can be useful to have a bash function to avoid typing the whole docker command:

\n

yq() {\n  docker run --rm -i -v \"${PWD}\":/workdir mikefarah/yq \"$@\"\n}

\n

yq() {\n  podman run --rm -i -v \"${PWD}\":/workdir mikefarah/yq \"$@\"\n}

\n

Running as root:

\n

yq's container image no longer runs under root (mikefarah/yq#860). If you'd like to install more things in the container image, or you're having permissions issues when attempting to read/write files you'll need to either:

\n

docker run --user=\"root\" -it --entrypoint sh mikefarah/yq\n

\n

podman run --user=\"root\" -it --entrypoint sh mikefarah/yq\n

\n

Or, in your Dockerfile:

\n

FROM mikefarah/yq\n\nUSER root\nRUN apk add --no-cache bash\nUSER yq\n

\n

Missing timezone data

\n

By default, the alpine image yq uses does not include timezone data. If you'd like to use the tz operator, you'll need to include this data:

\n

FROM mikefarah/yq\n\nUSER root\nRUN apk add --no-cache tzdata\nUSER yq\n

\n

Podman with SELinux

\n

If you are using podman with SELinux, you will need to set the shared volume flag :z on the volume mount:

\n

-v \"${PWD}\":/workdir:z\n

\n

GitHub Action

\n

  - name: Set foobar to cool\n    uses: mikefarah/yq@master\n    with:\n      cmd: yq -i '.foo.bar = \"cool\"' 'config.yml'\n  - name: Get an entry with a variable that might contain dots or spaces\n    id: get_username\n    uses: mikefarah/yq@master\n    with:\n      cmd: yq '.all.children.[\"${{ matrix.ip_address }}\"].username' ops/inventories/production.yml\n  - name: Reuse a variable obtained in another step\n    run: echo ${{ steps.get_username.outputs.result }}\n

\n

See https://mikefarah.gitbook.io/yq/usage/github-action for more.

\n

Go Install:

\n

go install github.com/mikefarah/yq/v4@latest\n

\n

Community Supported Installation methods

\n

As these are supported by the community ❤️ - however, they may be out of date with the officially supported releases.

\n

Please note that the Debian package (previously supported by @rmescandon) is no longer maintained. Please use an alternative installation method.

\n

X-CMD

\n

Checkout yq on x-cmd: https://x-cmd.com/mod/yq

\n

Instant Results: See the output of your yq filter in real-time.
Error Handling: Encounter a syntax error? It will display the error message and the results of the closest valid filter

\n

Thanks @edwinjhlee!

\n

Nix

\n

nix profile install nixpkgs#yq-go\n

\n

See here

\n

Webi

\n

webi yq\n

\n

See webi
\nSupported by @adithyasunil26 (https://github.com/webinstall/webi-installers/tree/master/yq)

\n

Arch Linux

\n

pacman -S go-yq\n

\n

Windows:

\n

Using Chocolatey

\n

$\"Chocolatey\"$
\n $\"Chocolatey\"$

\n

choco install yq\n

\n

Supported by @chillum (https://chocolatey.org/packages/yq)

\n

Using scoop

\n

scoop install main/yq\n

\n

Using winget

\n

winget install --id MikeFarah.yq\n

\n

Mac:

\n

\n

sudo port selfupdate\nsudo port install yq\n

\n

Supported by @herbygillot (https://ports.macports.org/maintainer/github/herbygillot)

\n

Alpine Linux

\n

Alpine Linux v3.20+ (and Edge):

\n

apk add yq-go\n

\n

Alpine Linux up to v3.19:

\n

apk add yq\n

\n

Supported by Tuan Hoang (https://pkgs.alpinelinux.org/packages?name=yq-go)

\n

Flox:

\n

Flox can be used to install yq on Linux, MacOS, and Windows through WSL.

\n

flox install yq\n

\n

Features

\n

Detailed documentation with many examples
Written in portable go, so you can download a lovely dependency free binary
Uses similar syntax as jq but works with YAML, INI, JSON and XML files
Fully supports multi document yaml files
Supports yaml front matter blocks (e.g. jekyll/assemble)
Colorized yaml output
Date/Time manipulation and formatting with TZ
Deeply data structures
Sort keys
Manipulate yaml comments, styling, tags and anchors and aliases.
Update in place
Complex expressions to select and update
Keeps yaml formatting and comments when updating (though there are issues with whitespace)
Decode/Encode base64 data
Load content from other files
Convert to/from json/ndjson
Convert to/from xml
Convert to/from properties
Convert to/from csv/tsv
General shell completion scripts (bash/zsh/fish/powershell)
Reduce to merge multiple files or sum an array or other fancy things.
Github Action to use in your automated pipeline (thanks @devorbitus)

\n

Usage

\n

Check out the documentation for more detailed and advanced usage.

\n

Usage:\n  yq [flags]\n  yq [command]\n\nExamples:\n\n# yq defaults to 'eval' command if no command is specified. See \"yq eval --help\" for more examples.\nyq '.stuff' < myfile.yml # outputs the data at the \"stuff\" node from \"myfile.yml\"\n\nyq -i '.stuff = \"foo\"' myfile.yml # update myfile.yml in place\n\n\nAvailable Commands:\n  completion  Generate the autocompletion script for the specified shell\n  eval        (default) Apply the expression to each document in each yaml file in sequence\n  eval-all    Loads _all_ yaml documents of _all_ yaml files and runs expression once\n  help        Help about any command\n\nFlags:\n  -C, --colors                        force print with colors\n      --csv-auto-parse                parse CSV YAML/JSON values (default true)\n      --csv-separator char            CSV Separator character (default ,)\n  -e, --exit-status                   set exit status if there are no matches or null or false is returned\n      --expression string             forcibly set the expression argument. Useful when yq argument detection thinks your expression is a file.\n      --from-file string              Load expression from specified file.\n  -f, --front-matter string           (extract|process) first input as yaml front-matter. Extract will pull out the yaml content, process will run the expression against the yaml content, leaving the remaining data intact\n      --header-preprocess             Slurp any header comments and separators before processing expression. (default true)\n  -h, --help                          help for yq\n  -I, --indent int                    sets indent level for output (default 2)\n  -i, --inplace                       update the file in place of first file given.\n  -p, --input-format string           [auto|a|yaml|y|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|lua|l|ini|i] parse format for input. (default \"auto\")\n      --lua-globals                   output keys as top-level global variables\n      --lua-prefix string             prefix (default \"return \")\n      --lua-suffix string             suffix (default \";\\n\")\n      --lua-unquoted                  output unquoted string keys (e.g. {foo=\"bar\"})\n  -M, --no-colors                     force print with no colors\n  -N, --no-doc                        Don't print document separators (---)\n  -0, --nul-output                    Use NUL char to separate values. If unwrap scalar is also set, fail if unwrapped scalar contains NUL char.\n  -n, --null-input                    Don't read input, simply evaluate the expression given. Useful for creating docs from scratch.\n  -o, --output-format string          [auto|a|yaml|y|json|j|props|p|csv|c|tsv|t|xml|x|base64|uri|toml|shell|s|lua|l|ini|i] output format type. (default \"auto\")\n  -P, --prettyPrint                   pretty print, shorthand for '... style = \"\"'\n      --properties-array-brackets     use [x] in array paths (e.g. for SpringBoot)\n      --properties-separator string   separator to use between keys and values (default \" = \")\n  -s, --split-exp string              print each result (or doc) into a file named (exp). [exp] argument must return a string. You can use $index in the expression as the result counter. The necessary directories will be created.\n      --split-exp-file string         Use a file to specify the split-exp expression.\n      --string-interpolation          Toggles strings interpolation of \\(exp) (default true)\n      --tsv-auto-parse                parse TSV YAML/JSON values (default true)\n  -r, --unwrapScalar                  unwrap scalar, print the value with no quotes, colors or comments. Defaults to true for yaml (default true)\n  -v, --verbose                       verbose mode\n  -V, --version                       Print version information and quit\n      --xml-attribute-prefix string   prefix for xml attributes (default \"+@\")\n      --xml-content-name string       name for xml content (if no attribute name is present). (default \"+content\")\n      --xml-directive-name string     name for xml directives (e.g. <!DOCTYPE thing cat>) (default \"+directive\")\n      --xml-keep-namespace            enables keeping namespace after parsing attributes (default true)\n      --xml-proc-inst-prefix string   prefix for xml processing instructions (e.g. <?xml version=\"1\"?>) (default \"+p_\")\n      --xml-raw-token                 enables using RawToken method instead Token. Commonly disables namespace translations. See https://pkg.go.dev/encoding/xml#Decoder.RawToken for details. (default true)\n      --xml-skip-directives           skip over directives (e.g. <!DOCTYPE thing cat>)\n      --xml-skip-proc-inst            skip over process instructions (e.g. <?xml version=\"1\"?>)\n      --xml-strict-mode               enables strict parsing of XML. See https://pkg.go.dev/encoding/xml for more details.\n\nUse \"yq [command] --help\" for more information about a command.\n

\n

Known Issues / Missing Features

\n

yq attempts to preserve comment positions and whitespace as much as possible, but it does not handle all scenarios (see https://github.com/go-yaml/yaml/tree/v3 for details)
Powershell has its own...opinions on quoting yq
\"yes\", \"no\" were dropped as boolean values in the yaml 1.2 standard - which is the standard yq assumes.

\n

See tips and tricks for more common problems and solutions.

","updatedAt":"2025-05-22T01:54:01Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"命令行工具","color":"e05879"}},{"node":{"name":"mikefarah","color":"6188f8"}}]},"comments":{"edges":[]}}},"pageContext":{"number":623,"previous":{"title":"nerdswords/yet-another-cloudwatch-exporter: AWS CloudWatch 的 Prometheus 导出器 - 通过 AWS 标签发现服务，获取 CloudWatch 指标数据，并以 AWS 标签作为标签，将其作为 Prometheus 指标提供","number":622},"next":{"title":"koderover/zadig: 基于 Kubernetes 研发的自助式云原生 DevOps 平台","number":624}}}, "staticQueryHashes": ["151096407","2861350382"]}