yq/README.md

58 lines
2.0 KiB
Markdown
Raw Normal View History

# yaml [![Build Status](https://travis-ci.org/mikefarah/yaml.svg?branch=master)](https://travis-ci.org/mikefarah/yaml)
2017-04-14 02:40:03 +00:00
yaml is a lightweight and portable command-line YAML processor
2015-09-27 03:29:20 +00:00
2015-10-13 10:31:02 +00:00
The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
2015-09-27 03:29:20 +00:00
2015-11-20 10:42:45 +00:00
## Install
[Download latest binary](https://github.com/mikefarah/yaml/releases/latest) or alternatively:
```
go get github.com/mikefarah/yaml
```
2015-10-13 10:31:02 +00:00
## Features
- Written in portable go, so you can download a lovely dependency free binary
- Deep read a yaml file with a given path
- Update a yaml file given a path
- Update a yaml file given a script file
2017-04-12 11:17:54 +00:00
- Update creates any missing entries in the path on the fly
- Create a yaml file given a deep path and value
- Create a yaml file given a script file
2015-10-13 10:31:02 +00:00
- Convert from json to yaml
- Convert from yaml to json
2017-04-12 11:30:29 +00:00
- Pipe data in by using '-'
- Merge multiple yaml files where each additional file sets values for missing or null value keys.
- Merge multiple yaml files with overwrite to support overriding previous values.
2015-09-29 00:20:31 +00:00
2017-04-13 05:44:31 +00:00
## [Usage](http://mikefarah.github.io/yaml/)
Check out the [documentation](http://mikefarah.github.io/yaml/) for more detailed and advanced usage.
2015-09-27 03:29:20 +00:00
```
2017-04-14 02:40:03 +00:00
Usage:
yaml [flags]
2017-04-14 02:40:03 +00:00
yaml [command]
2015-09-27 03:40:09 +00:00
2017-04-14 02:40:03 +00:00
Available Commands:
help Help about any command
merge yaml m [--inplace/-i] [--overwrite/-x] sample.yaml sample2.yaml
new yaml n [--script/-s script_file] a.b.c newValueForC
2017-04-14 02:40:03 +00:00
read yaml r sample.yaml a.b.c
write yaml w [--inplace/-i] [--script/-s script_file] sample.yaml a.b.c newValueForC
2015-10-05 03:41:01 +00:00
2017-04-14 02:40:03 +00:00
Flags:
-h, --help help for yaml
-j, --tojson output as json
-t, --trim trim yaml output (default true)
-v, --verbose verbose mode
-V, --version Print version information and quit
2015-10-05 23:01:33 +00:00
2017-04-14 02:40:03 +00:00
Use "yaml [command] --help" for more information about a command.
2015-09-29 06:29:32 +00:00
```
## Contribute
1. `make vendor` OR run `govendor sync` [link](https://github.com/kardianos/govendor)
2. add unit tests
3. apply changes
4. `make`
5. profit