yq/README.md

91 lines
2.7 KiB
Markdown
Raw Normal View History

2017-12-19 00:39:54 +00:00
# yq [![Build Status](https://travis-ci.org/mikefarah/yq.svg?branch=master)](https://travis-ci.org/mikefarah/yq)
2017-12-17 22:11:08 +00:00
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
On MacOS:
2017-12-24 19:30:49 +00:00
```
brew install yq
```
On Ubuntu and other Linux distros supporting `snap` packages:
```
snap install yq
```
On Ubuntu 16.04 or higher from Debian package:
```
sudo add-apt-repository ppa:rmescandon/yq
sudo apt update
sudo apt install yq -y
```
2017-12-24 19:30:49 +00:00
or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
2015-11-20 10:42:45 +00:00
```
go get gopkg.in/mikefarah/yq.v1
2015-11-20 10:42:45 +00:00
```
## Run with Docker
Oneshot use:
```bash
docker run -v ${PWD}:/workdir mikefarah/yq yq [flags] <command> FILE...
```
Run commands interactively:
```bash
docker run -it -v ${PWD}:/workdir mikefarah/yq sh
```
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-12-17 22:11:08 +00:00
## [Usage](http://mikefarah.github.io/yq/)
2017-04-13 05:44:31 +00:00
2017-12-17 22:11:08 +00:00
Check out the [documentation](http://mikefarah.github.io/yq/) for more detailed and advanced usage.
2017-04-13 05:44:31 +00:00
2015-09-27 03:29:20 +00:00
```
2017-04-14 02:40:03 +00:00
Usage:
2017-12-17 22:11:08 +00:00
yq [flags]
yq [command]
2015-09-27 03:40:09 +00:00
2017-04-14 02:40:03 +00:00
Available Commands:
2018-05-07 06:06:33 +00:00
delete yq d [--inplace/-i] sample.yaml a.b.c
help Help about any command
2017-12-17 22:11:08 +00:00
merge yq m [--inplace/-i] [--overwrite/-x] sample.yaml sample2.yaml
new yq n [--script/-s script_file] a.b.c newValueForC
read yq r sample.yaml a.b.c
write yq 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:
2017-12-17 22:11:08 +00:00
-h, --help help for yq
-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-12-17 22:11:08 +00:00
Use "yq [command] --help" for more information about a command.
2015-09-29 06:29:32 +00:00
```
## Contribute
2017-12-17 22:11:08 +00:00
1. `make [local] vendor`
2. add unit tests
3. apply changes (ensure that [gopkg](https://gopkg.in/) and govendor is used for package dependencies)
2017-12-17 22:11:08 +00:00
4. `make [local] build`
2018-06-12 00:16:54 +00:00
5. If required, update the user documentation
- Update README.md and/or documentation under the mkdocs folder
- `make [local] build-docs`
- browse to docs/index.html and check your changes
6. profit