Features
- Written in portable go, so you can download a lovely dependency free binary
- Colorize the output
- Deep read a yaml file with a given path expression
- List matching paths of a given path expression
- Return the lengths of arrays/object/scalars
- Update a yaml file given a path expression or script file
- Update creates any missing entries in the path on the fly
- Deeply compare yaml files
- Keeps yaml formatting and comments when updating
- Validate a yaml file
- Create a yaml file given a deep path and value or a script file
- Prefix a path to a yaml file
- Convert to/from json to yaml
- Pipe data in by using '-'
- Merge multiple yaml files with various options for overriding and appending
- Supports multiple documents in a single yaml file for reading, writing and merging
- General shell completion scripts (bash/zsh/fish/powershell) (https://mikefarah.gitbook.io/yq/commands/shell-completion)
Usage:
yq [flags]
yq [command]
Available Commands:
compare yq x [--prettyPrint/-P] dataA.yaml dataB.yaml 'b.e(name==fr*).value'
delete yq d [--inplace/-i] [--doc/-d index] sample.yaml 'b.e(name==fred)'
help Help about any command
merge yq m [--inplace/-i] [--doc/-d index] [--overwrite/-x] [--append/-a] sample.yaml sample2.yaml
new yq n [--script/-s script_file] a.b.c newValue
prefix yq p [--inplace/-i] [--doc/-d index] sample.yaml a.b.c
read yq r [--printMode/-p pv] sample.yaml 'b.e(name==fr*).value'
shell-completion Generates shell completion scripts
validate yq v sample.yaml
write yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml 'b.e(name==fr*).value' newValue
Flags:
-C, --colors print with colors
-h, --help help for yq
-I, --indent int sets indent level for output (default 2)
-P, --prettyPrint pretty print
-j, --tojson output as json. By default it prints a json document in one line, use the prettyPrint flag to print a formatted doc.
-v, --verbose verbose mode
-V, --version Print version information and quit
Use "yq [command] --help" for more information about a command.