yq/mkdocs/read.md

126 lines
1.7 KiB
Markdown
Raw Normal View History

2017-04-13 05:36:59 +00:00
```
2017-12-17 22:11:08 +00:00
yq r <yaml_file|json_file> <path>
2017-04-13 05:36:59 +00:00
```
{!snippets/works_with_json.md!}
2017-04-13 05:36:59 +00:00
### Basic
Given a sample.yaml file of:
```yaml
b:
c: 2
```
then
```bash
2017-12-17 22:11:08 +00:00
yq r sample.yaml b.c
2017-04-13 05:36:59 +00:00
```
will output the value of '2'.
### From Stdin
Given a sample.yaml file of:
```bash
2017-12-17 22:11:08 +00:00
cat sample.yaml | yq r - b.c
2017-04-13 05:36:59 +00:00
```
will output the value of '2'.
### Splat
Given a sample.yaml file of:
```yaml
---
bob:
item1:
cats: bananas
item2:
cats: apples
```
then
```bash
2017-12-17 22:11:08 +00:00
yq r sample.yaml bob.*.cats
2017-04-13 05:36:59 +00:00
```
will output
```yaml
- bananas
- apples
```
2018-07-08 11:53:38 +00:00
### Multiple Documents - specify a single document
2018-06-20 03:42:00 +00:00
Given a sample.yaml file of:
```yaml
something: else
---
b:
c: 2
```
then
```bash
yq r -d1 sample.yaml b.c
```
will output the value of '2'.
2018-07-08 11:53:38 +00:00
### Multiple Documents - read all documents
Reading all documents will return the result as an array. This can be converted to json using the '-j' flag if desired.
Given a sample.yaml file of:
```yaml
name: Fred
age: 22
---
name: Stella
age: 23
---
name: Android
age: 232
```
then
```bash
yq r -d'*' sample.yaml name
```
will output:
```
- Fred
- Stella
- Android
```
2017-04-13 05:36:59 +00:00
### Arrays
You can give an index to access a specific element:
e.g.: given a sample file of
```yaml
b:
e:
- name: fred
value: 3
- name: sam
value: 4
```
then
```
yq r sample.yaml 'b.e[1].name'
2017-04-13 05:36:59 +00:00
```
will output 'sam'
Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
2017-04-13 05:36:59 +00:00
### Array Splat
e.g.: given a sample file of
```yaml
b:
e:
- name: fred
value: 3
- name: sam
value: 4
```
then
```
yq r sample.yaml 'b.e[*].name'
2017-04-13 05:36:59 +00:00
```
will output:
```
- fred
- sam
```
Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
{!snippets/keys_with_dots.md!}