yq is a portable command-line YAML, JSON, XML, CSV, TOML and properties processor
Go to file
kenjones 53b2c64747 Task: Increase test coverage, includes refactor
Adds test cases to increase test coverage.
Refactors code to enable adding tests by reducing the number of
locations where `os.Exit()` is called from.
2017-09-22 23:01:46 -04:00
docs Update docs re using values that look like flags 2017-05-03 10:42:53 +10:00
examples Task: Simplify development 2017-09-23 08:37:34 +10:00
mkdocs Update docs re using values that look like flags 2017-05-03 10:42:53 +10:00
scripts Task: Simplify development 2017-09-23 08:37:34 +10:00
vendor Vendor shas 2017-09-23 08:47:18 +10:00
.gitignore Task: Simplify development 2017-09-23 08:37:34 +10:00
.travis.yml Task: Simplify development 2017-09-23 08:37:34 +10:00
Dockerfile.dev Task: Simplify development 2017-09-23 08:37:34 +10:00
LICENSE Added License (MIT) 2017-02-10 16:00:25 +11:00
Makefile Task: Simplify development 2017-09-23 08:37:34 +10:00
Makefile.variables Task: Simplify development 2017-09-23 08:37:34 +10:00
README.md Task: Simplify development 2017-09-23 08:37:34 +10:00
commands_test.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
data_navigator.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
data_navigator_test.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
json_converter.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
json_converter_test.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
mkdocs.yml Removed redundant code, updated doc w.r.t reading json files 2017-04-19 15:45:45 +10:00
path_parser.go Task: Simplify development 2017-09-23 08:37:34 +10:00
path_parser_test.go Task: Simplify development 2017-09-23 08:37:34 +10:00
utils_test.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
yaml.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00
yaml_test.go Task: Increase test coverage, includes refactor 2017-09-22 23:01:46 -04:00

README.md

yaml Build Status

yaml is a lightweight and portable command-line YAML processor

The aim of the project is to be the jq or sed of yaml files.

Install

Download latest binary 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

Check out the documentation 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
  2. add unit tests
  3. apply changes
  4. make
  5. profit