mirror of https://github.com/mikefarah/yq.git synced 2024-12-19 20:19:04 +00:00

kenjones 86639acf70 Task: Simplify development

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.

2017-09-23 08:37:34 +10:00

1.6 KiB

Raw Blame History

yaml

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

make vendor OR run govendor sync link
add unit tests
apply changes
make
profit