yq/commands/evaluate.md

57 lines
1.4 KiB
Markdown
Raw Normal View History

2021-10-30 03:14:39 +00:00
---
description: >-
Evaluates the given expression against each yaml document in each file, in
sequence
---
# Evaluate
2022-01-28 01:50:13 +00:00
Note that (as of 4.18.1) this is the default command when none is supplied to yq.
2021-10-30 03:14:39 +00:00
## Usage: 
```bash
yq eval [expression] [yaml_file1]... [flags]
```
Aliases: `eval, e`
Note that you can pass in `-` as a filename to pipe from STDIN.
## Examples:
```bash
# runs the expression against each file, in series
2022-01-28 01:50:13 +00:00
yq '.a.b | length' f1.yml f2.yml
2021-10-30 03:14:39 +00:00
# '-' will pipe from STDIN
2022-01-28 01:50:13 +00:00
cat file.yml | yq '.a.b' f1.yml - f2.yml
2021-10-30 03:14:39 +00:00
# prints out the file
2022-01-28 01:50:13 +00:00
yq sample.yaml
2021-10-30 03:14:39 +00:00
cat sample.yml | yq e
# prints a new yaml document
2022-01-28 01:50:13 +00:00
yq -n '.a.b.c = "cat"'
2021-10-30 03:14:39 +00:00
# updates file.yaml directly
2022-01-28 01:50:13 +00:00
yq '.a.b = "cool"' -i file.yaml
2021-10-30 03:14:39 +00:00
```
## Flags:
```
-h, --help help for eval
-C, --colors force print with colors
-e, --exit-status set exit status if there are no matches or null or false is returned
-I, --indent int sets indent level for output (default 2)
-i, --inplace update the yaml file inplace of first yaml file given.
-M, --no-colors force print with no colors
-N, --no-doc Don't print document separators (---)
-n, --null-input Don't read input, simply evaluate the expression given. Useful for creating yaml docs from scratch.
-j, --tojson output as json. Set indent to 0 to print json in one line.
-v, --verbose verbose mode
```