yq/README.md

135 lines
5.1 KiB
Markdown
Raw Normal View History

2019-05-14 17:28:06 +00:00
# yq
2018-07-31 09:04:34 +00:00
2020-01-14 22:01:08 +00:00
[![Build Status](https://api.travis-ci.com/mikefarah/yq.svg?branch=master)](https://travis-ci.com/mikefarah/yq/) ![Docker Pulls](https://img.shields.io/docker/pulls/mikefarah/yq.svg) ![Github Releases (by Release)](https://img.shields.io/github/downloads/mikefarah/yq/total.svg) ![Go Report](https://goreportcard.com/badge/github.com/mikefarah/yq)
2018-07-10 11:46:36 +00:00
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
2020-01-29 22:58:21 +00:00
## New version!
V3 is officially out - if you've been using v2 and want/need to upgrade, checkout the [upgrade guide](https://mikefarah.gitbook.io/yq/upgrading-from-v2).
2020-01-11 00:44:02 +00:00
2015-11-20 10:42:45 +00:00
## Install
2020-01-11 00:44:02 +00:00
2020-01-30 23:37:27 +00:00
### Download the latest binary
[Here](https://github.com/mikefarah/yq/releases/latest)
### 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
```
#### Snap notes
`yq` installs with with [_strict confinement_](https://docs.snapcraft.io/snap-confinement/6233) in snap, this means it doesn't have direct access to root files. To read root files you can:
```
2020-01-11 05:01:32 +00:00
sudo cat /etc/myfile | yq r - a.path
```
And to write to a root file you can either use [sponge](https://linux.die.net/man/1/sponge):
```
2020-01-11 05:01:32 +00:00
sudo cat /etc/myfile | yq w - a.path value | sudo sponge /etc/myfile
```
or write to a temporary file:
```
2020-01-11 05:01:32 +00:00
sudo cat /etc/myfile | yq w - a.path value | sudo tee /etc/myfile.tmp
sudo mv /etc/myfile.tmp /etc/myfile
rm /etc/myfile.tmp
```
### On Ubuntu 16.04 or higher from Debian package:
```
sudo add-apt-repository ppa:rmescandon/yq
sudo apt update
sudo apt install yq -y
```
2020-01-30 23:37:27 +00:00
### Go Get:
2015-11-20 10:42:45 +00:00
```
2020-01-13 05:58:11 +00:00
GO111MODULE=on go get github.com/mikefarah/yq/v3
2015-11-20 10:42:45 +00:00
```
## Run with Docker
Oneshot use:
```bash
docker run --rm -v ${PWD}:/workdir mikefarah/yq yq [flags] <command> FILE...
```
Run commands interactively:
```bash
docker run --rm -it -v ${PWD}:/workdir mikefarah/yq sh
```
It can be useful to have a bash function to avoid typing the whole docker command:
```bash
yq() {
docker run --rm -i -v ${PWD}:/workdir mikefarah/yq yq $@
}
```
2015-10-13 10:31:02 +00:00
## Features
- Written in portable go, so you can download a lovely dependency free binary
2020-01-29 22:58:21 +00:00
- [Deep read a yaml file with a given path expression](https://mikefarah.gitbook.io/yq/commands/read#basic)
- [List matching paths of a given path expression](https://mikefarah.gitbook.io/yq/commands/read#path-only)
- Update a yaml file given a [path expression](https://mikefarah.gitbook.io/yq/commands/write-update#basic) or [script file](https://mikefarah.gitbook.io/yq/commands/write-update#basic)
2017-04-12 11:17:54 +00:00
- Update creates any missing entries in the path on the fly
2020-02-03 03:28:38 +00:00
- Deeply compare yaml files
2020-01-29 22:58:21 +00:00
- Keeps yaml formatting and comments when updating
2020-01-30 23:32:44 +00:00
- [Validate a yaml file](https://mikefarah.gitbook.io/yq/commands/validate)
2020-01-29 22:58:21 +00:00
- Create a yaml file given a [deep path and value](https://mikefarah.gitbook.io/yq/commands/create#creating-a-simple-yaml-file) or a [script file](https://mikefarah.gitbook.io/yq/commands/create#creating-using-a-create-script)
- [Prefix a path to a yaml file](https://mikefarah.gitbook.io/yq/commands/prefix)
- [Convert to/from json to yaml](https://mikefarah.gitbook.io/yq/usage/convert)
- [Pipe data in by using '-'](https://mikefarah.gitbook.io/yq/commands/read#from-stdin)
- [Merge](https://mikefarah.gitbook.io/yq/commands/merge) multiple yaml files with various options for [overriding](https://mikefarah.gitbook.io/yq/commands/merge#overwrite-values) and [appending](https://mikefarah.gitbook.io/yq/commands/merge#append-values-with-arrays)
- Supports multiple documents in a single yaml file for [reading](https://mikefarah.gitbook.io/yq/commands/read#multiple-documents), [writing](https://mikefarah.gitbook.io/yq/commands/write-update#multiple-documents) and [merging](https://mikefarah.gitbook.io/yq/commands/merge#multiple-documents)
2015-09-29 00:20:31 +00:00
2020-01-29 22:58:21 +00:00
## [Usage](https://mikefarah.gitbook.io/yq/)
2017-04-13 05:44:31 +00:00
2020-01-29 22:58:21 +00:00
Check out the [documentation](https://mikefarah.gitbook.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:
2020-02-03 05:21:00 +00:00
compare yq x [--prettyPrint/-P] dataA.yaml dataB.yaml 'b.e(name==fr*).value'
2020-01-30 03:55:58 +00:00
delete yq d [--inplace/-i] [--doc/-d index] sample.yaml 'b.e(name==fred)'
help Help about any command
2018-07-07 05:27:15 +00:00
merge yq m [--inplace/-i] [--doc/-d index] [--overwrite/-x] [--append/-a] sample.yaml sample2.yaml
new yq n [--script/-s script_file] a.b.c newValue
2019-05-14 17:28:06 +00:00
prefix yq p [--inplace/-i] [--doc/-d index] sample.yaml a.b.c
2020-01-29 22:58:21 +00:00
read yq r [--printMode/-p pv] sample.yaml 'b.e(name==fr*).value'
2020-01-30 23:32:44 +00:00
validate yq v sample.yaml
2020-01-29 22:58:21 +00:00
write yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml 'b.e(name==fr*).value' newValue
2015-10-05 03:41:01 +00:00
2017-04-14 02:40:03 +00:00
Flags:
2020-02-03 05:37:53 +00:00
-h, --help help for yq
-P, --prettyPrint pretty print
-j, --tojson output as json
-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
2019-12-22 23:01:55 +00:00
2020-01-12 23:21:28 +00:00
**Note: v3 is currently in progress - for the moment I won't be accepting new feature PRs until v3 is ready :)**
2019-12-22 23:01:55 +00:00
2018-08-06 06:24:06 +00:00
1. `scripts/devtools.sh`
2. `make [local] vendor`
3. add unit tests
4. apply changes to go.mod
2018-08-06 06:24:06 +00:00
5. `make [local] build`
7. profit