mirror of
https://github.com/mikefarah/yq.git
synced 2024-11-12 13:48:06 +00:00
86639acf70
The base directory has all shell scripts in scripts/ and all example/test files in examples/. A Makefile provides all the commands with helpful information. If a developer simply types `make` then vendor is properly updated, the code is formatted, linted, tested, built, acceptance test run, and installed. Linting errors resolved. Ignored test case (`TestParsePath`) updated to work as expected.
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
# yaml [](https://travis-ci.org/mikefarah/yaml)
|
|
yaml is a lightweight and portable command-line YAML processor
|
|
|
|
The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
|
|
|
|
## Install
|
|
[Download latest binary](https://github.com/mikefarah/yaml/releases/latest) or alternatively:
|
|
```
|
|
go get github.com/mikefarah/yaml
|
|
```
|
|
|
|
## 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
|
|
- 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
|
|
- Convert from json to yaml
|
|
- Convert from yaml to json
|
|
- Pipe data in by using '-'
|
|
|
|
## [Usage](http://mikefarah.github.io/yaml/)
|
|
|
|
Check out the [documentation](http://mikefarah.github.io/yaml/) for more detailed and advanced usage.
|
|
|
|
```
|
|
Usage:
|
|
yaml [command]
|
|
|
|
Available Commands:
|
|
read yaml r sample.yaml a.b.c
|
|
write yaml w [--inplace/-i] [--script/-s script_file] sample.yaml a.b.c newValueForC
|
|
new yaml n [--script/-s script_file] a.b.c newValueForC
|
|
|
|
Flags:
|
|
-h, --help[=false]: help for yaml
|
|
-j, --tojson[=false]: output as json
|
|
-t, --trim[=true]: trim yaml output
|
|
-v, --verbose[=false]: verbose mode
|
|
|
|
Use "yaml [command] --help" for more information about a command.
|
|
```
|
|
|
|
## 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
|