yq/README.md

163 lines
2.1 KiB
Markdown
Raw Normal View History

2015-09-26 22:14:44 +00:00
# yaml
2015-10-04 06:07:39 +00:00
yaml is portable command line tool written in go
2015-09-27 03:29:20 +00:00
2015-10-05 03:48:57 +00:00
Allows you to read and update yaml files from bash (or whatever). All in a lovely dependency free binary!
2015-09-27 03:29:20 +00:00
2015-09-29 00:20:31 +00:00
[Download latest release](https://github.com/mikefarah/yaml/releases/latest)
or alternatively install using go get:
2015-09-27 05:06:02 +00:00
```
go get github.com/mikefarah/yaml
```
2015-09-28 00:50:32 +00:00
## Read examples
2015-09-27 03:29:20 +00:00
```
2015-10-06 05:07:09 +00:00
yaml r <yaml file> <path>
2015-09-27 03:29:20 +00:00
```
2015-09-28 00:50:32 +00:00
### Basic
Given a sample.yaml file of:
```yaml
b:
c: 2
2015-09-27 03:29:20 +00:00
```
2015-09-28 00:50:32 +00:00
then
```bash
2015-10-06 05:07:09 +00:00
yaml r sample.yaml b.c
2015-09-27 03:29:20 +00:00
```
will output the value of '2'.
2015-09-27 03:40:09 +00:00
2015-10-05 04:48:34 +00:00
### Reading from STDIN
Given a sample.yaml file of:
2015-10-06 00:51:36 +00:00
```bash
2015-10-06 05:07:09 +00:00
cat sample.yaml | yaml r - b.c
2015-10-05 04:48:34 +00:00
```
will output the value of '2'.
2015-10-05 23:01:33 +00:00
### Splat
Given a sample.yaml file of:
```yaml
---
bob:
item1:
cats: bananas
item2:
cats: apples
```
then
```bash
2015-10-06 05:07:09 +00:00
yaml r sample.yaml bob.*.cats
2015-10-05 23:01:33 +00:00
```
will output
```yaml
- bananas
- apples
```
2015-10-03 05:10:29 +00:00
### Handling '.' in the yaml key
Given a sample.yaml file of:
```yaml
b.x:
c: 2
```
then
```bash
2015-10-06 05:07:09 +00:00
yaml r sample.yaml \"b.x\".c
2015-10-03 05:10:29 +00:00
```
will output the value of '2'.
2015-09-28 00:50:32 +00:00
### Arrays
You can give an index to access a specific element:
e.g.: given a sample file of
```yaml
2015-09-27 03:40:09 +00:00
b:
e:
- name: fred
value: 3
- name: sam
value: 4
```
then
```
2015-10-06 05:07:09 +00:00
yaml r sample.yaml b.e[1].name
2015-09-27 03:40:09 +00:00
```
will output 'sam'
2015-09-28 00:50:32 +00:00
2015-10-06 00:58:51 +00:00
### Array Splat
2015-10-05 03:41:01 +00:00
e.g.: given a sample file of
```yaml
b:
e:
- name: fred
value: 3
- name: sam
value: 4
```
then
```
2015-10-06 05:07:09 +00:00
yaml r sample.yaml b.e[*].name
2015-10-05 03:41:01 +00:00
```
will output:
```
- fred
- sam
```
2015-10-06 00:58:51 +00:00
## Update examples
2015-10-05 23:01:33 +00:00
2015-10-06 00:58:51 +00:00
### Update to stdout
2015-09-29 06:29:32 +00:00
Given a sample.yaml file of:
```yaml
b:
c: 2
```
then
```bash
2015-10-03 08:19:13 +00:00
yaml w sample.yaml b.c cat
2015-09-29 06:29:32 +00:00
```
will output:
```yaml
b:
c: cat
```
2015-10-06 00:58:51 +00:00
### Updating yaml in-place
Given a sample.yaml file of:
```yaml
b:
c: 2
```
then
```bash
2015-10-06 05:07:09 +00:00
yaml w -i sample.yaml b.c cat
2015-10-06 00:58:51 +00:00
```
will update the sample.yaml file so that the value of 'c' is cat.
### Updating multiple values with a script
Given a sample.yaml file of:
```yaml
b:
c: 2
e:
- name: Billy Bob
```
and a script update_instructions.yaml of:
```yaml
b.c: 3
b.e[0].name: Howdy Partner
```
then
```bash
2015-10-08 09:07:27 +00:00
yaml w -s update_instructions.yaml sample.yaml
```
will output:
```yaml
b:
c: 3
e:
- name: Howdy Partner
```