mirror of
https://github.com/mikefarah/yq.git
synced 2026-07-07 06:10:36 +00:00
Updating README with latest yq help
This commit is contained in:
parent
810e9d921e
commit
fc164ca9c3
19
README.md
19
README.md
@ -380,10 +380,18 @@ Usage:
|
|||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
# yq defaults to 'eval' command if no command is specified. See "yq eval --help" for more examples.
|
# yq tries to auto-detect the file format based off the extension, and defaults to YAML if it's unknown (or piping through STDIN)
|
||||||
yq '.stuff' < myfile.yml # outputs the data at the "stuff" node from "myfile.yml"
|
# Use the '-p/--input-format' flag to specify a format type.
|
||||||
|
cat file.xml | yq -p xml
|
||||||
|
|
||||||
yq -i '.stuff = "foo"' myfile.yml # update myfile.yml in place
|
# read the "stuff" node from "myfile.yml"
|
||||||
|
yq '.stuff' < myfile.yml
|
||||||
|
|
||||||
|
# update myfile.yml in place
|
||||||
|
yq -i '.stuff = "foo"' myfile.yml
|
||||||
|
|
||||||
|
# print contents of sample.json as idiomatic YAML
|
||||||
|
yq -P -oy sample.json
|
||||||
|
|
||||||
|
|
||||||
Available Commands:
|
Available Commands:
|
||||||
@ -396,6 +404,7 @@ Flags:
|
|||||||
-C, --colors force print with colors
|
-C, --colors force print with colors
|
||||||
--csv-auto-parse parse CSV YAML/JSON values (default true)
|
--csv-auto-parse parse CSV YAML/JSON values (default true)
|
||||||
--csv-separator char CSV Separator character (default ,)
|
--csv-separator char CSV Separator character (default ,)
|
||||||
|
--debug-node-info debug node info
|
||||||
-e, --exit-status set exit status if there are no matches or null or false is returned
|
-e, --exit-status set exit status if there are no matches or null or false is returned
|
||||||
--expression string forcibly set the expression argument. Useful when yq argument detection thinks your expression is a file.
|
--expression string forcibly set the expression argument. Useful when yq argument detection thinks your expression is a file.
|
||||||
--from-file string Load expression from specified file.
|
--from-file string Load expression from specified file.
|
||||||
@ -417,6 +426,9 @@ Flags:
|
|||||||
-P, --prettyPrint pretty print, shorthand for '... style = ""'
|
-P, --prettyPrint pretty print, shorthand for '... style = ""'
|
||||||
--properties-array-brackets use [x] in array paths (e.g. for SpringBoot)
|
--properties-array-brackets use [x] in array paths (e.g. for SpringBoot)
|
||||||
--properties-separator string separator to use between keys and values (default " = ")
|
--properties-separator string separator to use between keys and values (default " = ")
|
||||||
|
--security-disable-env-ops Disable env related operations.
|
||||||
|
--security-disable-file-ops Disable file related operations (e.g. load)
|
||||||
|
--shell-key-separator string separator for shell variable key paths (default "_")
|
||||||
-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.
|
-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.
|
||||||
--split-exp-file string Use a file to specify the split-exp expression.
|
--split-exp-file string Use a file to specify the split-exp expression.
|
||||||
--string-interpolation Toggles strings interpolation of \(exp) (default true)
|
--string-interpolation Toggles strings interpolation of \(exp) (default true)
|
||||||
@ -433,6 +445,7 @@ Flags:
|
|||||||
--xml-skip-directives skip over directives (e.g. <!DOCTYPE thing cat>)
|
--xml-skip-directives skip over directives (e.g. <!DOCTYPE thing cat>)
|
||||||
--xml-skip-proc-inst skip over process instructions (e.g. <?xml version="1"?>)
|
--xml-skip-proc-inst skip over process instructions (e.g. <?xml version="1"?>)
|
||||||
--xml-strict-mode enables strict parsing of XML. See https://pkg.go.dev/encoding/xml for more details.
|
--xml-strict-mode enables strict parsing of XML. See https://pkg.go.dev/encoding/xml for more details.
|
||||||
|
--yaml-fix-merge-anchor-to-spec Fix merge anchor to match YAML spec. Will default to true in late 2025
|
||||||
|
|
||||||
Use "yq [command] --help" for more information about a command.
|
Use "yq [command] --help" for more information about a command.
|
||||||
```
|
```
|
||||||
|
|||||||
@ -1,3 +1 @@
|
|||||||
[[fruits]]
|
a: apple
|
||||||
[[fruits.varieties]] # nested array of tables
|
|
||||||
name = "red delicious
|
|
||||||
Loading…
Reference in New Issue
Block a user