wip update docs

- Move data_navigator, json_converter, merge, and path_parser to pkg/yqlib
- Extract yamlToString from yq to pkg/yqlib/yaml_converter
- Move utils_test to test/utils

.dockerignore

@@ -0,0 +1 @@
+bin

.gitignore

@@ -8,6 +8,7 @@ _obj
 _test
 bin
 build
+build-done
 .DS_Store
 
 # Architecture specific extensions/prefixes
@@ -22,11 +23,12 @@ _cgo_export.*
 
 _testmain.go
 coverage.out
+coverage.html
 *.exe
 *.test
 *.prof
 yaml
-vendor/*/
+vendor/
 tmp/
 cover/
 yq

.travis.yml

@@ -1,6 +1,6 @@
 language: go
 go:
-    - 1.9.x
+  - 1.13.x
 script:
   - scripts/devtools.sh
   - make local build

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.9 as builder
+FROM golang:1.13 as builder
 
 WORKDIR /go/src/mikefarah/yq
 
@@ -6,10 +6,6 @@ WORKDIR /go/src/mikefarah/yq
 COPY ./scripts/devtools.sh /go/src/mikefarah/yq/scripts/devtools.sh
 RUN ./scripts/devtools.sh
 
-# cache vendor
-COPY ./vendor/vendor.json /go/src/mikefarah/yq/vendor/vendor.json
-RUN govendor sync
-
 COPY . /go/src/mikefarah/yq
 
 RUN CGO_ENABLED=0 make local build

Dockerfile.dev

@@ -1,4 +1,4 @@
-FROM golang:1.9
+FROM golang:1.13
 
 COPY scripts/devtools.sh /opt/devtools.sh
 

Makefile

@@ -14,8 +14,7 @@ help:
 	@echo '    make build           Build yq binary.'
 	@echo '    make install         Install yq.'
 	@echo '    make xcompile        Build cross-compiled binaries of yq.'
-	@echo '    make snap            Build a snap package of yq.'
-	@echo '    make vendor          Install dependencies using govendor.'
+	@echo '    make vendor          Install dependencies to vendor directory.'
 	@echo '    make format          Run code formatter.'
 	@echo '    make check           Run static code analysis (lint).'
 	@echo '    make test            Run tests on project.'
@@ -65,10 +64,6 @@ xcompile: check
 	@find build -type d -exec chmod 755 {} \; || :
 	@find build -type f -exec chmod 755 {} \; || :
 
-.PHONY: snap
-snap:
-	snapcraft
-
 .PHONY: install
 install: build
 	${DOCKRUN} go install
@@ -76,8 +71,7 @@ install: build
 # Each of the fetch should be an entry within vendor.json; not currently included within project
 .PHONY: vendor
 vendor: tmp/dev_image_id
-	${DOCKRUN} govendor sync
-	@chmod 664 vendor/vendor.json
+	${DOCKRUN} go mod vendor
 
 # ----------------------------------------------
 # develop and test

README.md

@@ -1,6 +1,6 @@
-# yq 
+# yq
 
-[![Build Status](https://travis-ci.org/mikefarah/yq.svg?branch=master)](https://travis-ci.org/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)
+[![Build Status](https://travis-ci.org/mikefarah/yq.svg?branch=master)](https://travis-ci.org/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)
 
 
 a lightweight and portable command-line YAML processor
@@ -8,23 +8,42 @@ 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
-On MacOS:
+### On MacOS:
 ```
 brew install yq
 ```
-On Ubuntu and other Linux distros supporting `snap` packages:
+### On Ubuntu and other Linux distros supporting `snap` packages:
 ```
 snap install yq
 ```
-On Ubuntu 16.04 or higher from Debian package:
+
+#### 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:
+
+```
+sudo cat /etc/myfile | yq -r - somecommand
+```
+
+And to write to a root file you can either use [sponge](https://linux.die.net/man/1/sponge):
+```
+sudo cat /etc/myfile | yq -r - somecommand | sudo sponge /etc/myfile
+```
+or write to a temporary file:
+```
+sudo cat /etc/myfile | yq -r - somecommand | 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
 ```
-or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
+### or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
 ```
-go get gopkg.in/mikefarah/yq.v2
+GO111MODULE=on go get github.com/mikefarah/yq/v3
 ```
 
 ## Run with Docker
@@ -32,13 +51,21 @@ go get gopkg.in/mikefarah/yq.v2
 Oneshot use:
 
 ```bash
-docker run -v ${PWD}:/workdir mikefarah/yq yq [flags] <command> FILE...
+docker run --rm -v ${PWD}:/workdir mikefarah/yq yq [flags] <command> FILE...
 ```
 
 Run commands interactively:
 
 ```bash
-docker run -it -v ${PWD}:/workdir mikefarah/yq sh
+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 $@
+}
 ```
 
 ## Features
@@ -63,6 +90,8 @@ docker run -it -v ${PWD}:/workdir mikefarah/yq sh
 Check out the [documentation](http://mikefarah.github.io/yq/) for more detailed and advanced usage.
 
 ```
+yq is a lightweight and portable command-line YAML processor. It aims to be the jq or sed of yaml files.
+
 Usage:
   yq [flags]
   yq [command]
@@ -72,9 +101,9 @@ Available Commands:
   help        Help about any command
   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
+  prefix      yq p [--inplace/-i] [--doc/-d index] sample.yaml a.b.c
   read        yq r [--doc/-d index] sample.yaml a.b.c
   write       yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml a.b.c newValue
-  prefix      yq p [--inplace/-i] [--doc/-d index] sample.yaml a.b.c
 
 Flags:
   -h, --help      help for yq
@@ -89,10 +118,10 @@ Use "yq [command] --help" for more information about a command.
 1. `scripts/devtools.sh`
 2. `make [local] vendor`
 3. add unit tests
-4. apply changes (use govendor with a preference to [gopkg](https://gopkg.in/) for package dependencies)
+4. apply changes to go.mod
 5. `make [local] build`
-6. If required, update the user documentation 
+6. 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 
+    - browse to docs/index.html and check your changes
 7. profit

Upgrade Notes

@@ -0,0 +1,74 @@
+
+Major release! Upgraded underlying yaml parser, re-written majority of yq. This has brought on a number of features that have been in demand for a while (see below).
+
+This is in beta and needs some community feedback and testing :)
+
+# New Features
+  - Keeps yaml comments and formatting, can specify yaml tags when updating. https://github.com/mikefarah/yq/issues/19, https://github.com/mikefarah/yq/issues/169, https://github.com/mikefarah/yq/issues/107, https://github.com/mikefarah/yq/issues/171, https://github.com/mikefarah/yq/issues/245, https://github.com/mikefarah/yq/issues/303,https://github.com/mikefarah/yq/issues/308,https://github.com/mikefarah/yq/issues/314
+  - Handles anchors!  https://github.com/mikefarah/yq/issues/310, https://github.com/mikefarah/yq/issues/178
+  - Can print out matching paths and values when splatting https://github.com/mikefarah/yq/issues/20
+  - JSON output works for all commands! Yaml files with multiple documents are printed out as one JSON document per line. 
+  - Deep splat (**) to match arbitrary paths
+
+
+# Breaking changes
+
+## Update scripts file format has changed to be more powerful. 
+Comments can be added, and delete commands have been introduced.
+
+Before:
+```yaml
+b.e[+].name: Mike Farah
+```
+
+After:
+```yaml
+- command: update 
+  path: b.e[+].thing
+  value:
+    #great 
+    things: frog # wow!
+- command: delete
+  path: b.d
+```
+
+https://github.com/mikefarah/yq/issues/305
+
+## Reading and splatting, matching results are printed once per line.
+  e.g:
+
+```json
+parent:
+  childA: 
+    no: matches here
+  childB:
+    there: matches
+    hi: no match
+    there2: also matches
+```
+
+```bash
+yq r sample.yaml 'parent.*.there*'
+```
+
+old
+```yaml
+- null
+- - matches
+  - also matches
+```
+
+new
+```yaml
+matches
+also matches
+```
+
+and you can print the matching paths:
+
+yq r --printMode pv sample.yaml 'parent.*.there*'
+
+```yaml
+parent.childB.there: matches
+parent.childB.there2: also matches
+```

compare.sh

@@ -0,0 +1,13 @@
+GREEN='\033[0;32m'
+NC='\033[0m'
+
+echo "${GREEN}---Old---${NC}"
+yq $@ > /tmp/yq-old-output
+cat /tmp/yq-old-output
+
+echo "${GREEN}---New---${NC}"
+./yq $@ > /tmp/yq-new-output
+cat /tmp/yq-new-output
+
+echo "${GREEN}---Diff---${NC}"
+colordiff /tmp/yq-old-output /tmp/yq-new-output

data_navigator.go

@@ -1,282 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"strconv"
-
-	yaml "gopkg.in/mikefarah/yaml.v2"
-)
-
-func entryInSlice(context yaml.MapSlice, key interface{}) *yaml.MapItem {
-	for idx := range context {
-		var entry = &context[idx]
-		if entry.Key == key {
-			return entry
-		}
-	}
-	return nil
-}
-
-func getMapSlice(context interface{}) yaml.MapSlice {
-	var mapSlice yaml.MapSlice
-	switch context.(type) {
-	case yaml.MapSlice:
-		mapSlice = context.(yaml.MapSlice)
-	default:
-		mapSlice = make(yaml.MapSlice, 0)
-	}
-	return mapSlice
-}
-
-func getArray(context interface{}) (array []interface{}, ok bool) {
-	switch context.(type) {
-	case []interface{}:
-		array = context.([]interface{})
-		ok = true
-	default:
-		array = make([]interface{}, 0)
-		ok = false
-	}
-	return
-}
-
-func writeMap(context interface{}, paths []string, value interface{}) yaml.MapSlice {
-	log.Debugf("writeMap for %v for %v with value %v\n", paths, context, value)
-
-	mapSlice := getMapSlice(context)
-
-	if len(paths) == 0 {
-		return mapSlice
-	}
-
-	child := entryInSlice(mapSlice, paths[0])
-	if child == nil {
-		newChild := yaml.MapItem{Key: paths[0]}
-		mapSlice = append(mapSlice, newChild)
-		child = entryInSlice(mapSlice, paths[0])
-		log.Debugf("\tAppended child at %v for mapSlice %v\n", paths[0], mapSlice)
-	}
-
-	log.Debugf("\tchild.Value %v\n", child.Value)
-
-	remainingPaths := paths[1:]
-	child.Value = updatedChildValue(child.Value, remainingPaths, value)
-	log.Debugf("\tReturning mapSlice %v\n", mapSlice)
-	return mapSlice
-}
-
-func updatedChildValue(child interface{}, remainingPaths []string, value interface{}) interface{} {
-	if len(remainingPaths) == 0 {
-		return value
-	}
-
-	_, nextIndexErr := strconv.ParseInt(remainingPaths[0], 10, 64)
-	if nextIndexErr != nil && remainingPaths[0] != "+" {
-		// must be a map
-		return writeMap(child, remainingPaths, value)
-	}
-
-	// must be an array
-	return writeArray(child, remainingPaths, value)
-}
-
-func writeArray(context interface{}, paths []string, value interface{}) []interface{} {
-	log.Debugf("writeArray for %v for %v with value %v\n", paths, context, value)
-	array, _ := getArray(context)
-
-	if len(paths) == 0 {
-		return array
-	}
-
-	log.Debugf("\tarray %v\n", array)
-
-	rawIndex := paths[0]
-	var index int64
-	// the append array indicator
-	if rawIndex == "+" {
-		index = int64(len(array))
-	} else {
-		index, _ = strconv.ParseInt(rawIndex, 10, 64) // nolint
-		// writeArray is only called by updatedChildValue which handles parsing the
-		// index, as such this renders this dead code.
-	}
-
-	for index >= int64(len(array)) {
-		array = append(array, nil)
-	}
-	currentChild := array[index]
-
-	log.Debugf("\tcurrentChild %v\n", currentChild)
-
-	remainingPaths := paths[1:]
-	array[index] = updatedChildValue(currentChild, remainingPaths, value)
-	log.Debugf("\tReturning array %v\n", array)
-	return array
-}
-
-func readMap(context yaml.MapSlice, head string, tail []string) (interface{}, error) {
-	if head == "*" {
-		return readMapSplat(context, tail)
-	}
-	var value interface{}
-
-	entry := entryInSlice(context, head)
-	if entry != nil {
-		value = entry.Value
-	}
-	return calculateValue(value, tail)
-}
-
-func readMapSplat(context yaml.MapSlice, tail []string) (interface{}, error) {
-	var newArray = make([]interface{}, len(context))
-	var i = 0
-	for _, entry := range context {
-		if len(tail) > 0 {
-			val, err := recurse(entry.Value, tail[0], tail[1:])
-			if err != nil {
-				return nil, err
-			}
-			newArray[i] = val
-		} else {
-			newArray[i] = entry.Value
-		}
-		i++
-	}
-	return newArray, nil
-}
-
-func recurse(value interface{}, head string, tail []string) (interface{}, error) {
-	switch value.(type) {
-	case []interface{}:
-		if head == "*" {
-			return readArraySplat(value.([]interface{}), tail)
-		}
-		index, err := strconv.ParseInt(head, 10, 64)
-		if err != nil {
-			return nil, fmt.Errorf("Error accessing array: %v", err)
-		}
-		return readArray(value.([]interface{}), index, tail)
-	case yaml.MapSlice:
-		return readMap(value.(yaml.MapSlice), head, tail)
-	default:
-		return nil, nil
-	}
-}
-
-func readArray(array []interface{}, head int64, tail []string) (interface{}, error) {
-	if head >= int64(len(array)) {
-		return nil, nil
-	}
-
-	value := array[head]
-	return calculateValue(value, tail)
-}
-
-func readArraySplat(array []interface{}, tail []string) (interface{}, error) {
-	var newArray = make([]interface{}, len(array))
-	for index, value := range array {
-		val, err := calculateValue(value, tail)
-		if err != nil {
-			return nil, err
-		}
-		newArray[index] = val
-	}
-	return newArray, nil
-}
-
-func calculateValue(value interface{}, tail []string) (interface{}, error) {
-	if len(tail) > 0 {
-		return recurse(value, tail[0], tail[1:])
-	}
-	return value, nil
-}
-
-func deleteMap(context interface{}, paths []string) yaml.MapSlice {
-	log.Debugf("deleteMap for %v for %v\n", paths, context)
-
-	mapSlice := getMapSlice(context)
-
-	if len(paths) == 0 {
-		return mapSlice
-	}
-
-	var found bool
-	var index int
-	var child yaml.MapItem
-	for index, child = range mapSlice {
-		if child.Key == paths[0] {
-			found = true
-			break
-		}
-	}
-
-	if !found {
-		return mapSlice
-	}
-
-	remainingPaths := paths[1:]
-
-	var newSlice yaml.MapSlice
-	if len(remainingPaths) > 0 {
-		newChild := yaml.MapItem{Key: child.Key}
-		newChild.Value = deleteChildValue(child.Value, remainingPaths)
-
-		newSlice = make(yaml.MapSlice, len(mapSlice))
-		for i := range mapSlice {
-			item := mapSlice[i]
-			if i == index {
-				item = newChild
-			}
-			newSlice[i] = item
-		}
-	} else {
-		// Delete item from slice at index
-		newSlice = append(mapSlice[:index], mapSlice[index+1:]...)
-		log.Debugf("\tDeleted item index %d from mapSlice", index)
-	}
-
-	log.Debugf("\t\tlen: %d\tcap: %d\tslice: %v", len(mapSlice), cap(mapSlice), mapSlice)
-	log.Debugf("\tReturning mapSlice %v\n", mapSlice)
-	return newSlice
-}
-
-func deleteArray(context interface{}, paths []string, index int64) interface{} {
-	log.Debugf("deleteArray for %v for %v\n", paths, context)
-
-	array, ok := getArray(context)
-	if !ok {
-		// did not get an array
-		return context
-	}
-
-	if index >= int64(len(array)) {
-		return array
-	}
-
-	remainingPaths := paths[1:]
-	if len(remainingPaths) > 0 {
-		// Recurse into the array element at index
-		array[index] = deleteMap(array[index], remainingPaths)
-	} else {
-		// Delete the array element at index
-		array = append(array[:index], array[index+1:]...)
-		log.Debugf("\tDeleted item index %d from array, leaving %v", index, array)
-	}
-
-	log.Debugf("\tReturning array: %v\n", array)
-	return array
-}
-
-func deleteChildValue(child interface{}, remainingPaths []string) interface{} {
-	log.Debugf("deleteChildValue for %v for %v\n", remainingPaths, child)
-
-	idx, nextIndexErr := strconv.ParseInt(remainingPaths[0], 10, 64)
-	if nextIndexErr != nil {
-		// must be a map
-		log.Debugf("\tdetected a map, invoking deleteMap\n")
-		return deleteMap(child, remainingPaths)
-	}
-
-	log.Debugf("\tdetected an array, so traversing element with index %d\n", idx)
-	return deleteArray(child, remainingPaths, idx)
-}

data_navigator_test.go

@@ -1,387 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"sort"
-	"testing"
-
-	yaml "gopkg.in/mikefarah/yaml.v2"
-)
-
-func TestReadMap_simple(t *testing.T) {
-	var data = parseData(`
----
-b:
-  c: 2
-`)
-	got, _ := readMap(data, "b", []string{"c"})
-	assertResult(t, 2, got)
-}
-
-func TestReadMap_splat(t *testing.T) {
-	var data = parseData(`
----
-mapSplat:
-  item1: things
-  item2: whatever
-`)
-	res, _ := readMap(data, "mapSplat", []string{"*"})
-	result := res.([]interface{})
-	var actual = []string{result[0].(string), result[1].(string)}
-	sort.Strings(actual)
-	assertResult(t, "[things whatever]", fmt.Sprintf("%v", actual))
-}
-
-func TestReadMap_deep_splat(t *testing.T) {
-	var data = parseData(`
----
-mapSplatDeep:
-  item1:
-    cats: bananas
-  item2:
-    cats: apples
-`)
-
-	res, _ := readMap(data, "mapSplatDeep", []string{"*", "cats"})
-	result := res.([]interface{})
-	var actual = []string{result[0].(string), result[1].(string)}
-	sort.Strings(actual)
-	assertResult(t, "[apples bananas]", fmt.Sprintf("%v", actual))
-}
-
-func TestReadMap_key_doesnt_exist(t *testing.T) {
-	var data = parseData(`
----
-b:
-  c: 2
-`)
-	got, _ := readMap(data, "b.x.f", []string{"c"})
-	assertResult(t, nil, got)
-}
-
-func TestReadMap_recurse_against_string(t *testing.T) {
-	var data = parseData(`
----
-a: cat
-`)
-	got, _ := readMap(data, "a", []string{"b"})
-	assertResult(t, nil, got)
-}
-
-func TestReadMap_with_array(t *testing.T) {
-	var data = parseData(`
----
-b:
-  d:
-    - 3
-    - 4
-`)
-	got, _ := readMap(data, "b", []string{"d", "1"})
-	assertResult(t, 4, got)
-}
-
-func TestReadMap_with_array_and_bad_index(t *testing.T) {
-	var data = parseData(`
----
-b:
-  d:
-    - 3
-    - 4
-`)
-	_, err := readMap(data, "b", []string{"d", "x"})
-	if err == nil {
-		t.Fatal("Expected error due to invalid path")
-	}
-	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
-	assertResult(t, expectedOutput, err.Error())
-}
-
-func TestReadMap_with_mapsplat_array_and_bad_index(t *testing.T) {
-	var data = parseData(`
----
-b:
-  d:
-    e:
-      - 3
-      - 4
-    f:
-      - 1
-      - 2
-`)
-	_, err := readMap(data, "b", []string{"d", "*", "x"})
-	if err == nil {
-		t.Fatal("Expected error due to invalid path")
-	}
-	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
-	assertResult(t, expectedOutput, err.Error())
-}
-
-func TestReadMap_with_arraysplat_map_array_and_bad_index(t *testing.T) {
-	var data = parseData(`
----
-b:
-  d:
-    - names:
-        - fred
-        - smith
-    - names:
-        - sam
-        - bo
-`)
-	_, err := readMap(data, "b", []string{"d", "*", "names", "x"})
-	if err == nil {
-		t.Fatal("Expected error due to invalid path")
-	}
-	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
-	assertResult(t, expectedOutput, err.Error())
-}
-
-func TestReadMap_with_array_out_of_bounds(t *testing.T) {
-	var data = parseData(`
----
-b:
-  d:
-    - 3
-    - 4
-`)
-	got, _ := readMap(data, "b", []string{"d", "3"})
-	assertResult(t, nil, got)
-}
-
-func TestReadMap_with_array_out_of_bounds_by_1(t *testing.T) {
-	var data = parseData(`
----
-b:
-  d:
-    - 3
-    - 4
-`)
-	got, _ := readMap(data, "b", []string{"d", "2"})
-	assertResult(t, nil, got)
-}
-
-func TestReadMap_with_array_splat(t *testing.T) {
-	var data = parseData(`
-e:
-  -
-    name: Fred
-    thing: cat
-  -
-    name: Sam
-    thing: dog
-`)
-	got, _ := readMap(data, "e", []string{"*", "name"})
-	assertResult(t, "[Fred Sam]", fmt.Sprintf("%v", got))
-}
-
-func TestWrite_really_simple(t *testing.T) {
-	var data = parseData(`
-    b: 2
-`)
-
-	updated := writeMap(data, []string{"b"}, "4")
-	b := entryInSlice(updated, "b").Value
-	assertResult(t, "4", b)
-}
-
-func TestWrite_simple(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-
-	updated := writeMap(data, []string{"b", "c"}, "4")
-	b := entryInSlice(updated, "b").Value.(yaml.MapSlice)
-	c := entryInSlice(b, "c").Value
-	assertResult(t, "4", c)
-}
-
-func TestWrite_new(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-
-	updated := writeMap(data, []string{"b", "d"}, "4")
-	b := entryInSlice(updated, "b").Value.(yaml.MapSlice)
-	d := entryInSlice(b, "d").Value
-	assertResult(t, "4", d)
-}
-
-func TestWrite_new_deep(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-
-	updated := writeMap(data, []string{"b", "d", "f"}, "4")
-	got, _ := readMap(updated, "b", []string{"d", "f"})
-	assertResult(t, "4", got)
-}
-
-func TestWrite_array(t *testing.T) {
-	var data = parseData(`
-b:
-  - aa
-`)
-
-	updated := writeMap(data, []string{"b", "0"}, "bb")
-
-	b := entryInSlice(updated, "b").Value.([]interface{})
-	assertResult(t, "bb", b[0].(string))
-}
-
-func TestWrite_new_array(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-
-	updated := writeMap(data, []string{"b", "0"}, "4")
-	got, _ := readMap(updated, "b", []string{"0"})
-	assertResult(t, "4", got)
-}
-
-func TestWrite_new_array_deep(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-
-	var expected = `b:
-- c: "4"`
-
-	updated := writeMap(data, []string{"b", "0", "c"}, "4")
-	got, _ := yamlToString(updated)
-	assertResult(t, expected, got)
-}
-
-func TestWrite_new_map_array_deep(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-
-	updated := writeMap(data, []string{"b", "d", "0"}, "4")
-	got, _ := readMap(updated, "b", []string{"d", "0"})
-	assertResult(t, "4", got)
-}
-
-func TestWrite_add_to_array(t *testing.T) {
-	var data = parseData(`
-b:
-  - aa
-`)
-
-	var expected = `b:
-- aa
-- bb`
-
-	updated := writeMap(data, []string{"b", "1"}, "bb")
-	got, _ := yamlToString(updated)
-	assertResult(t, expected, got)
-}
-
-func TestWrite_with_no_tail(t *testing.T) {
-	var data = parseData(`
-b:
-  c: 2
-`)
-	updated := writeMap(data, []string{"b"}, "4")
-
-	b := entryInSlice(updated, "b").Value
-	assertResult(t, "4", fmt.Sprintf("%v", b))
-}
-
-func TestWriteMap_no_paths(t *testing.T) {
-	var data = parseData(`
-b: 5
-`)
-
-	result := writeMap(data, []string{}, 4)
-	assertResult(t, fmt.Sprintf("%v", data), fmt.Sprintf("%v", result))
-}
-
-func TestWriteArray_no_paths(t *testing.T) {
-	var data = make([]interface{}, 1)
-	data[0] = "mike"
-	result := writeArray(data, []string{}, 4)
-	assertResult(t, fmt.Sprintf("%v", data), fmt.Sprintf("%v", result))
-}
-
-func TestDelete_MapItem(t *testing.T) {
-	var data = parseData(`
-a: 123
-b: 456
-`)
-	var expected = parseData(`
-b: 456
-`)
-
-	result := deleteMap(data, []string{"a"})
-	assertResult(t, fmt.Sprintf("%v", expected), fmt.Sprintf("%v", result))
-}
-
-// Ensure deleting an index into a string does nothing
-func TestDelete_index_to_string(t *testing.T) {
-	var data = parseData(`
-a: mystring
-`)
-	result := deleteMap(data, []string{"a", "0"})
-	assertResult(t, fmt.Sprintf("%v", data), fmt.Sprintf("%v", result))
-}
-
-func TestDelete_list_index(t *testing.T) {
-	var data = parseData(`
-a: [3, 4]
-`)
-	var expected = parseData(`
-a: [3]
-`)
-	result := deleteMap(data, []string{"a", "1"})
-	assertResult(t, fmt.Sprintf("%v", expected), fmt.Sprintf("%v", result))
-}
-
-func TestDelete_list_index_beyond_bounds(t *testing.T) {
-	var data = parseData(`
-a: [3, 4]
-`)
-	result := deleteMap(data, []string{"a", "5"})
-	assertResult(t, fmt.Sprintf("%v", data), fmt.Sprintf("%v", result))
-}
-
-func TestDelete_list_index_out_of_bounds_by_1(t *testing.T) {
-	var data = parseData(`
-a: [3, 4]
-`)
-	result := deleteMap(data, []string{"a", "2"})
-	assertResult(t, fmt.Sprintf("%v", data), fmt.Sprintf("%v", result))
-}
-
-func TestDelete_no_paths(t *testing.T) {
-	var data = parseData(`
-a: [3, 4]
-b:
-  - name: test
-`)
-	result := deleteMap(data, []string{})
-	assertResult(t, fmt.Sprintf("%v", data), fmt.Sprintf("%v", result))
-}
-
-func TestDelete_array_map_item(t *testing.T) {
-	var data = parseData(`
-b:
-- name: fred
-  value: blah
-- name: john
-  value: test
-`)
-	var expected = parseData(`
-b:
-- value: blah
-- name: john
-  value: test
-`)
-	result := deleteMap(data, []string{"b", "0", "name"})
-	assertResult(t, fmt.Sprintf("%v", expected), fmt.Sprintf("%v", result))
-}

debian/changelog

@@ -1,3 +1,15 @@
+yq (2.2-1) bionic; urgency=medium
+
+  * Added Windows support for the "--inplace" command flag
+  * Prefix now supports arrays
+  * Add prefix command
+  * Bump Alpine version to 3.8
+  * Improved docker build process
+  * Lint fixes
+  * Build support for all linux architectures supported by gox
+
+ -- Roberto Mier Escandon <rmescandon@gmail.com>  Sat, 19 Jan 2019 15:50:47 +0100
+
 yq (2.1-0) bionic; urgency=medium
 
   * Ability to read multiple documents in a single file

debian/control

@@ -12,7 +12,7 @@ Vcs-Browser: https://github.com/mikefarah/yq.git
 Vcs-Git: https://github.com/mikefarah/yq.git
 
 Package: yq
-Architecture: all
+Architecture: any
 Built-Using: ${misc:Built-Using}
 Depends: ${shlibs:Depends},
          ${misc:Depends}

docs/404.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="/assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="/assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="/assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="/assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -108,22 +111,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -146,7 +146,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -157,20 +156,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -206,20 +203,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -253,6 +248,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="/path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="/write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -357,7 +364,6 @@
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="/assets/fonts/font-awesome.css">
     
@@ -367,20 +373,16 @@
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="/assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="/assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:"/"}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/assets/javascripts/lunr/lunr.ja.js

@@ -0,0 +1 @@
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(m){if(void 0===m)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===m.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var l="2"==m.version[0];m.ja=function(){this.pipeline.reset(),this.pipeline.add(m.ja.trimmer,m.ja.stopWordFilter,m.ja.stemmer),l?this.tokenizer=m.ja.tokenizer:(m.tokenizer&&(m.tokenizer=m.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=m.ja.tokenizer))};var j=new m.TinySegmenter;m.ja.tokenizer=function(e){var r,t,i,n,o,s,p,a,u;if(!arguments.length||null==e||null==e)return[];if(Array.isArray(e))return e.map(function(e){return l?new m.Token(e.toLowerCase()):e.toLowerCase()});for(r=(t=e.toString().toLowerCase().replace(/^\s+/,"")).length-1;0<=r;r--)if(/\S/.test(t.charAt(r))){t=t.substring(0,r+1);break}for(o=[],i=t.length,p=a=0;a<=i;a++)if(s=a-p,t.charAt(a).match(/\s/)||a==i){if(0<s)for(n=j.segment(t.slice(p,a)).filter(function(e){return!!e}),u=p,r=0;r<n.length;r++)l?o.push(new m.Token(n[r],{position:[u,n[r].length],index:o.length})):o.push(n[r]),u+=n[r].length;p=a+1}return o},m.ja.stemmer=function(e){return e},m.Pipeline.registerFunction(m.ja.stemmer,"stemmer-ja"),m.ja.wordCharacters="一二三四五六七八九十百千万億兆一-龠々〆ヵヶぁ-んァ-ヴーｱ-ﾝﾞa-zA-Zａ-ｚＡ-Ｚ0-9０-９",m.ja.trimmer=m.trimmerSupport.generateTrimmer(m.ja.wordCharacters),m.Pipeline.registerFunction(m.ja.trimmer,"trimmer-ja"),m.ja.stopWordFilter=m.generateStopWordFilter("これ それ あれ この その あの ここ そこ あそこ こちら どこ だれ なに なん 何 私 貴方 貴方方 我々 私達 あの人 あのかた 彼女 彼 です あります おります います は が の に を で え から まで より も どの と し それで しかし".split(" ")),m.Pipeline.registerFunction(m.ja.stopWordFilter,"stopWordFilter-ja"),m.jp=m.ja,m.Pipeline.registerFunction(m.jp.stemmer,"stemmer-jp"),m.Pipeline.registerFunction(m.jp.trimmer,"trimmer-jp"),m.Pipeline.registerFunction(m.jp.stopWordFilter,"stopWordFilter-jp")}});

docs/assets/javascripts/lunr/lunr.jp.js

@@ -1 +1 @@
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(n){if(void 0===n)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===n.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var i="2"==n.version[0];n.jp=function(){this.pipeline.reset(),this.pipeline.add(n.jp.stopWordFilter,n.jp.stemmer),i?this.tokenizer=n.jp.tokenizer:(n.tokenizer&&(n.tokenizer=n.jp.tokenizer),this.tokenizerFn&&(this.tokenizerFn=n.jp.tokenizer))};var o=new n.TinySegmenter;n.jp.tokenizer=function(e){if(!arguments.length||null==e||null==e)return[];if(Array.isArray(e))return e.map(function(e){return i?new n.Token(e.toLowerCase()):e.toLowerCase()});for(var r=e.toString().toLowerCase().replace(/^\s+/,""),t=r.length-1;0<=t;t--)if(/\S/.test(r.charAt(t))){r=r.substring(0,t+1);break}return o.segment(r).filter(function(e){return!!e}).map(function(e){return i?new n.Token(e):e})},n.jp.stemmer=function(e){return e},n.Pipeline.registerFunction(n.jp.stemmer,"stemmer-jp"),n.jp.wordCharacters="一二三四五六七八九十百千万億兆一-龠々〆ヵヶぁ-んァ-ヴーｱ-ﾝﾞa-zA-Zａ-ｚＡ-Ｚ0-9０-９",n.jp.stopWordFilter=function(e){if(-1===n.jp.stopWordFilter.stopWords.indexOf(i?e.toString():e))return e},n.jp.stopWordFilter=n.generateStopWordFilter("これ それ あれ この その あの ここ そこ あそこ こちら どこ だれ なに なん 何 私 貴方 貴方方 我々 私達 あの人 あのかた 彼女 彼 です あります おります います は が の に を で え から まで より も どの と し それで しかし".split(" ")),n.Pipeline.registerFunction(n.jp.stopWordFilter,"stopWordFilter-jp")}});
+module.exports=require("./lunr.ja");

docs/assets/javascripts/lunr/lunr.th.js

@@ -0,0 +1 @@
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(t){if(void 0===t)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===t.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var i="2"==t.version[0];t.th=function(){this.pipeline.reset(),this.pipeline.add(t.th.trimmer),i?this.tokenizer=t.th.tokenizer:(t.tokenizer&&(t.tokenizer=t.th.tokenizer),this.tokenizerFn&&(this.tokenizerFn=t.th.tokenizer))},t.th.wordCharacters="[฀-๿]",t.th.trimmer=t.trimmerSupport.generateTrimmer(t.th.wordCharacters),t.Pipeline.registerFunction(t.th.trimmer,"trimmer-th");var n=t.wordcut;n.init(),t.th.tokenizer=function(e){if(!arguments.length||null==e||null==e)return[];if(Array.isArray(e))return e.map(function(e){return i?new t.Token(e):e});var r=e.toString().replace(/^\s+/,"");return n.cut(r).split("|")}}});

docs/convert/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Convert
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Convert
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -257,6 +252,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="../write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -419,20 +426,37 @@
                   <h1>Convert</h1>
                 
                 <h3 id="yaml-to-json">Yaml to Json<a class="headerlink" href="#yaml-to-json" title="Permanent link">&para;</a></h3>
-<p>To convert output to json, use the --tojson (or -j) flag. This can only be used with the read command.</p>
+<p>To convert output to json, use the --tojson (or -j) flag. This is supported by all commands.</p>
+<p>Each matching yaml node will be converted to json and printed out on a separate line.</p>
 <p>Given a sample.yaml file of:</p>
 <pre><code class="yaml">b:
   c: 2
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yq r -j sample.yaml b.c
+<pre><code class="bash">yq r -j sample.yaml
 </code></pre>
 
 <p>will output</p>
 <pre><code class="json">{&quot;b&quot;:{&quot;c&quot;:2}}
 </code></pre>
 
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">bob:
+  c: 2
+bab:
+  c: 5
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq r -j sample.yaml b*
+</code></pre>
+
+<p>will output</p>
+<pre><code class="json">{&quot;c&quot;:2}
+{&quot;c&quot;:5}
+</code></pre>
+
 <h3 id="json-to-yaml">Json to Yaml<a class="headerlink" href="#json-to-yaml" title="Permanent link">&para;</a></h3>
 <p>To read in json, just pass in a json file instead of yaml, it will just work :)</p>
 <p>e.g given a json file</p>
@@ -514,7 +538,6 @@ b:
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -524,20 +547,16 @@ b:
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/create/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Create
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Create
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -257,6 +252,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="../write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -330,13 +337,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -404,13 +404,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -432,10 +425,11 @@
                 
                   <h1>Create</h1>
                 
-                <p>Yaml files can be created using the 'new' command. This works in the same way as the write command, but you don't pass in an existing Yaml file. Currently this does not support creating multiple documents in a single yaml file.</p>
-<pre><code>yq n &lt;path&gt; &lt;new value&gt;
+                <pre><code>yq n &lt;path_expression&gt; &lt;new value&gt;
 </code></pre>
 
+<p>Yaml files can be created using the 'new' command. This works in the same way as the write command, but you don't pass in an existing Yaml file. Currently this does not support creating multiple documents in a single yaml file.</p>
+<p>See docs for <a href="../path_expressions/">path expression</a></p>
 <h3 id="creating-a-simple-yaml-file">Creating a simple yaml file<a class="headerlink" href="#creating-a-simple-yaml-file" title="Permanent link">&para;</a></h3>
 <pre><code class="bash">yq n b.c cat
 </code></pre>
@@ -448,8 +442,11 @@
 <h3 id="creating-using-a-create-script">Creating using a create script<a class="headerlink" href="#creating-using-a-create-script" title="Permanent link">&para;</a></h3>
 <p>Create scripts follow the same format as the update scripts.</p>
 <p>Given a script create_instructions.yaml of:</p>
-<pre><code class="yaml">b.c: 3
-b.e[0].name: Howdy Partner
+<pre><code class="yaml">- command: update 
+  path: b.c
+  value:
+    #great 
+    things: frog # wow!
 </code></pre>
 
 <p>then</p>
@@ -458,29 +455,14 @@ b.e[0].name: Howdy Partner
 
 <p>will output:</p>
 <pre><code class="yaml">b:
-  c: 3
-  e:
-    - name: Howdy Partner
+  c:
+    #great
+    things: frog # wow!
 </code></pre>
 
 <p>You can also pipe the instructions in:</p>
 <pre><code class="bash">cat create_instructions.yaml | yq n -s -
 </code></pre>
-
-<h3 id="keys-with-dots">Keys with dots<a class="headerlink" href="#keys-with-dots" title="Permanent link">&para;</a></h3>
-<p>When specifying a key that has a dot use key lookup indicator.</p>
-<pre><code class="yaml">b:
-  foo.bar: 7
-</code></pre>
-
-<pre><code class="bash">yaml r sample.yaml 'b[foo.bar]'
-</code></pre>
-
-<pre><code class="bash">yaml w sample.yaml 'b[foo.bar]' 9
-</code></pre>
-
-<p>Any valid yaml key can be specified as part of a key lookup.</p>
-<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
                 
                   
                 
@@ -544,7 +526,6 @@ b.e[0].name: Howdy Partner
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -554,20 +535,16 @@ b.e[0].name: Howdy Partner
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/delete/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -91,7 +94,7 @@
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
     
-      <a href="#to-stdout" tabindex="1" class="md-skip">
+      <a href="#from-stdin" tabindex="1" class="md-skip">
         Skip to content
       </a>
     
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Delete
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Delete
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -257,6 +252,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="../write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -304,25 +311,11 @@
     <label class="md-nav__title" for="__toc">Table of contents</label>
     <ul class="md-nav__list" data-md-scrollfix>
       
-        <li class="md-nav__item">
-  <a href="#to-stdout" title="To Stdout" class="md-nav__link">
-    To Stdout
-  </a>
-  
-</li>
-      
         <li class="md-nav__item">
   <a href="#from-stdin" title="From STDIN" class="md-nav__link">
     From STDIN
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#deleting-array-elements" title="Deleting array elements" class="md-nav__link">
-    Deleting array elements
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -346,13 +339,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -418,25 +404,11 @@
     <label class="md-nav__title" for="__toc">Table of contents</label>
     <ul class="md-nav__list" data-md-scrollfix>
       
-        <li class="md-nav__item">
-  <a href="#to-stdout" title="To Stdout" class="md-nav__link">
-    To Stdout
-  </a>
-  
-</li>
-      
         <li class="md-nav__item">
   <a href="#from-stdin" title="From STDIN" class="md-nav__link">
     From STDIN
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#deleting-array-elements" title="Deleting array elements" class="md-nav__link">
-    Deleting array elements
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -460,13 +432,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -488,49 +453,16 @@
                 
                   <h1>Delete</h1>
                 
-                <pre><code>yq d &lt;yaml_file&gt; &lt;path_to_delete&gt;
-</code></pre>
-
-<h3 id="to-stdout">To Stdout<a class="headerlink" href="#to-stdout" title="Permanent link">&para;</a></h3>
-<p>Given a sample.yaml file of:</p>
-<pre><code class="yaml">b:
-  c: 2
-  apples: green
-</code></pre>
-
-<p>then</p>
-<pre><code class="bash">yq d sample.yaml b.c
-</code></pre>
-
-<p>will output:</p>
-<pre><code class="yaml">b:
-  apples: green
+                <pre><code>yq delete &lt;yaml_file|-&gt; &lt;path_expression&gt;
 </code></pre>
 
+<p>The delete command will delete all the matching nodes for the path expression in the given yaml input.</p>
+<p>See docs for <a href="../path_expressions/">path expression</a> for more details.</p>
 <h3 id="from-stdin">From STDIN<a class="headerlink" href="#from-stdin" title="Permanent link">&para;</a></h3>
+<p>Use "-" (without quotes) inplace of a file name if you wish to pipe in input from STDIN.</p>
 <pre><code class="bash">cat sample.yaml | yq d - b.c
 </code></pre>
 
-<h3 id="deleting-array-elements">Deleting array elements<a class="headerlink" href="#deleting-array-elements" title="Permanent link">&para;</a></h3>
-<p>Given a sample.yaml file of:</p>
-<pre><code class="yaml">b:
-  c: 
-    - 1
-    - 2
-    - 3
-</code></pre>
-
-<p>then</p>
-<pre><code class="bash">yq d sample.yaml 'b.c[1]'
-</code></pre>
-
-<p>will output:</p>
-<pre><code class="yaml">b:
-  c:
-  - 1
-  - 3
-</code></pre>
-
 <h3 id="deleting-nodes-in-place">Deleting nodes in-place<a class="headerlink" href="#deleting-nodes-in-place" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
 <pre><code class="yaml">b:
@@ -587,20 +519,6 @@ b:
 </code></pre>
 
 <p>Note that '*' is in quotes to avoid being interpreted by your shell.</p>
-<h3 id="keys-with-dots">Keys with dots<a class="headerlink" href="#keys-with-dots" title="Permanent link">&para;</a></h3>
-<p>When specifying a key that has a dot use key lookup indicator.</p>
-<pre><code class="yaml">b:
-  foo.bar: 7
-</code></pre>
-
-<pre><code class="bash">yaml r sample.yaml 'b[foo.bar]'
-</code></pre>
-
-<pre><code class="bash">yaml w sample.yaml 'b[foo.bar]' 9
-</code></pre>
-
-<p>Any valid yaml key can be specified as part of a key lookup.</p>
-<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
                 
                   
                 
@@ -664,7 +582,6 @@ b:
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -674,20 +591,16 @@ b:
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Install
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Install
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -295,6 +290,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -427,7 +434,7 @@ sudo apt install yq -y
 </code></pre>
 
 <p>or, <a href="https://github.com/mikefarah/yq/releases/latest">Download latest binary</a> or alternatively:</p>
-<pre><code>go get gopkg.in/mikefarah/yq.v2
+<pre><code>GO111MODULE=on go get github.com/mikefarah/yq/v3
 </code></pre>
 
 <p><a href="https://github.com/mikefarah/yq">View on GitHub</a></p>
@@ -480,7 +487,6 @@ sudo apt install yq -y
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="assets/fonts/font-awesome.css">
     
@@ -490,20 +496,16 @@ sudo apt install yq -y
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:"."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/merge/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Merge
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Merge
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -257,6 +252,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="../write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -613,7 +620,6 @@ d: hi
 </code></pre>
 
 <p>Note that the 'b' array has concatenated the values from the second data file. Also note that other map keys are not overridden (field a).</p>
-<p>Append cannot be used with overwrite, if both flags are given then append is ignored.</p>
 <h3 id="multiple-documents-merge-into-single-document">Multiple Documents - merge into single document<a class="headerlink" href="#multiple-documents-merge-into-single-document" title="Permanent link">&para;</a></h3>
 <p>Currently yq only has multi-document support for the <em>first</em> document being merged into. The remaining yaml files will have their first document selected.</p>
 <p>Given a data1.yaml file of:</p>
@@ -711,7 +717,6 @@ b: dog
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -721,20 +726,16 @@ b: dog
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/path_expressions/index.html

@@ -0,0 +1,862 @@
+
+
+
+
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+    
+      <meta charset="utf-8">
+      <meta name="viewport" content="width=device-width,initial-scale=1">
+      <meta http-equiv="x-ua-compatible" content="ie=edge">
+      
+      
+      
+      
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
+      
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <meta name="lang:search.pipeline.stopwords" content="True">
+      
+        <meta name="lang:search.pipeline.trimmer" content="True">
+      
+        <meta name="lang:search.result.none" content="No matching documents">
+      
+        <meta name="lang:search.result.one" content="1 matching document">
+      
+        <meta name="lang:search.result.other" content="# matching documents">
+      
+        <meta name="lang:search.tokenizer" content="[\s\-]+">
+      
+      <link rel="shortcut icon" href="../assets/images/favicon.png">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
+    
+    
+      
+        <title>Path Expressions - Yq</title>
+      
+    
+    
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
+      
+      
+    
+    
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
+    
+    
+      
+        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
+        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+      
+    
+    <link rel="stylesheet" href="../assets/fonts/material-icons.css">
+    
+    
+    
+      
+    
+    
+  </head>
+  
+    <body dir="ltr">
+  
+    <svg class="md-svg">
+      <defs>
+        
+        
+          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
+    viewBox="0 0 416 448" id="__github">
+  <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
+        8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
+        18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
+        19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
+        18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
+        304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
+        2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
+        38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
+        37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
+        82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
+        1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
+        0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
+        30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
+        46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
+        99.5z" />
+</svg>
+        
+      </defs>
+    </svg>
+    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
+    
+      <a href="#simple-expressions" tabindex="1" class="md-skip">
+        Skip to content
+      </a>
+    
+    
+      <header class="md-header" data-md-component="header">
+  <nav class="md-header-nav md-grid">
+    <div class="md-flex">
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <a href=".." title="Yq" class="md-header-nav__button md-logo">
+          
+            <i class="md-icon"></i>
+          
+        </a>
+      </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
+      </div>
+      <div class="md-flex__cell md-flex__cell--stretch">
+        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
+          
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Path Expressions
+            </span>
+          
+        </div>
+      </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+        
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
+          
+<div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
+      <label class="md-icon md-search__icon" for="__search"></label>
+      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
+        &#xE5CD;
+      </button>
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="result">
+          <div class="md-search-result__meta">
+            Type to start searching
+          </div>
+          <ol class="md-search-result__list"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+        
+      </div>
+      
+        <div class="md-flex__cell md-flex__cell--shrink">
+          <div class="md-header-nav__source">
+            
+
+
+  
+
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
+    </div>
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
+          </div>
+        </div>
+      
+    </div>
+  </nav>
+</header>
+    
+    <div class="md-container">
+      
+        
+      
+      
+      <main class="md-main">
+        <div class="md-main__inner md-grid" data-md-component="container">
+          
+            
+              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    <nav class="md-nav md-nav--primary" data-md-level="0">
+  <label class="md-nav__title md-nav__title--site" for="__drawer">
+    <a href=".." title="Yq" class="md-nav__button md-logo">
+      
+        <i class="md-icon"></i>
+      
+    </a>
+    Yq
+  </label>
+  
+    <div class="md-nav__source">
+      
+
+
+  
+
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
+    </div>
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
+    </div>
+  
+  <ul class="md-nav__list" data-md-scrollfix>
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href=".." title="Install" class="md-nav__link">
+      Install
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../read/" title="Read" class="md-nav__link">
+      Read
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+  
+
+
+  <li class="md-nav__item md-nav__item--active">
+    
+    <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+    
+    
+      <label class="md-nav__link md-nav__link--active" for="__toc">
+        Path Expressions
+      </label>
+    
+    <a href="./" title="Path Expressions" class="md-nav__link md-nav__link--active">
+      Path Expressions
+    </a>
+    
+      
+<nav class="md-nav md-nav--secondary">
+  
+  
+  
+    <label class="md-nav__title" for="__toc">Table of contents</label>
+    <ul class="md-nav__list" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#simple-expressions" title="Simple expressions" class="md-nav__link">
+    Simple expressions
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#maps" title="Maps" class="md-nav__link">
+    Maps
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#arrays" title="Arrays" class="md-nav__link">
+    Arrays
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#appending-to-arrays" title="Appending to arrays" class="md-nav__link">
+    Appending to arrays
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#splat" title="Splat" class="md-nav__link">
+    Splat
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#maps_1" title="Maps" class="md-nav__link">
+    Maps
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#arrays_1" title="Arrays" class="md-nav__link">
+    Arrays
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#deep-splat" title="Deep Splat" class="md-nav__link">
+    Deep Splat
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#finding-parents-with-particular-children-nodes" title="Finding parents with particular children nodes" class="md-nav__link">
+    Finding parents with particular children nodes
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#with-prefixes" title="With prefixes" class="md-nav__link">
+    With prefixes
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#special-characters" title="Special Characters" class="md-nav__link">
+    Special Characters
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#keys-and-values-with-leading-dashes" title="Keys (and values) with leading dashes" class="md-nav__link">
+    Keys (and values) with leading dashes
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+      
+      
+      
+      
+    </ul>
+  
+</nav>
+    
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../write/" title="Write/Update" class="md-nav__link">
+      Write/Update
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../prefix/" title="Prefix" class="md-nav__link">
+      Prefix
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../delete/" title="Delete" class="md-nav__link">
+      Delete
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../create/" title="Create" class="md-nav__link">
+      Create
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../convert/" title="Convert" class="md-nav__link">
+      Convert
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
+  </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+            
+            
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    
+<nav class="md-nav md-nav--secondary">
+  
+  
+  
+    <label class="md-nav__title" for="__toc">Table of contents</label>
+    <ul class="md-nav__list" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#simple-expressions" title="Simple expressions" class="md-nav__link">
+    Simple expressions
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#maps" title="Maps" class="md-nav__link">
+    Maps
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#arrays" title="Arrays" class="md-nav__link">
+    Arrays
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#appending-to-arrays" title="Appending to arrays" class="md-nav__link">
+    Appending to arrays
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#splat" title="Splat" class="md-nav__link">
+    Splat
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#maps_1" title="Maps" class="md-nav__link">
+    Maps
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#arrays_1" title="Arrays" class="md-nav__link">
+    Arrays
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#deep-splat" title="Deep Splat" class="md-nav__link">
+    Deep Splat
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#finding-parents-with-particular-children-nodes" title="Finding parents with particular children nodes" class="md-nav__link">
+    Finding parents with particular children nodes
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#with-prefixes" title="With prefixes" class="md-nav__link">
+    With prefixes
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#special-characters" title="Special Characters" class="md-nav__link">
+    Special Characters
+  </a>
+  
+    <nav class="md-nav">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#keys-and-values-with-leading-dashes" title="Keys (and values) with leading dashes" class="md-nav__link">
+    Keys (and values) with leading dashes
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
+      
+      
+      
+      
+    </ul>
+  
+</nav>
+                  </div>
+                </div>
+              </div>
+            
+          
+          <div class="md-content">
+            <article class="md-content__inner md-typeset">
+              
+                
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/path_expressions.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
+                
+                  <h1>Path Expressions</h1>
+                
+                <p>Path expressions are used to deeply navigate and match particular yaml nodes.</p>
+<p><em>As a general rule, you should wrap paths in quotes in the CLI to prevent your interpreter from processing '*, []' and other special characters.</em></p>
+<h2 id="simple-expressions">Simple expressions<a class="headerlink" href="#simple-expressions" title="Permanent link">&para;</a></h2>
+<h3 id="maps">Maps<a class="headerlink" href="#maps" title="Permanent link">&para;</a></h3>
+<p>a.b.c</p>
+<pre><code class="yaml">a:
+  b:
+    c: thing # MATCHES
+</code></pre>
+
+<h3 id="arrays">Arrays<a class="headerlink" href="#arrays" title="Permanent link">&para;</a></h3>
+<p>a.b[1].c</p>
+<pre><code class="yaml">a:
+  b:
+  - c: thing0 
+  - c: thing1 # MATCHES
+  - c: thing2
+</code></pre>
+
+<h4 id="appending-to-arrays">Appending to arrays<a class="headerlink" href="#appending-to-arrays" title="Permanent link">&para;</a></h4>
+<p>(e.g. when using the write command)</p>
+<p>a.b[+].c</p>
+<pre><code class="yaml">a:
+  b:
+  - c: thing0 
+</code></pre>
+
+<p>Will add a new entry:</p>
+<pre><code class="yaml">a:
+  b:
+  - c: thing0 
+  - c: thing1 # NEW entry from [+] on B array.
+</code></pre>
+
+<h2 id="splat">Splat<a class="headerlink" href="#splat" title="Permanent link">&para;</a></h2>
+<h3 id="maps_1">Maps<a class="headerlink" href="#maps_1" title="Permanent link">&para;</a></h3>
+<p>a.*.c</p>
+<pre><code class="yaml">a:
+  b1:
+    c: thing # MATCHES
+  b2:
+    c: thing # MATCHES
+</code></pre>
+
+<h3 id="arrays_1">Arrays<a class="headerlink" href="#arrays_1" title="Permanent link">&para;</a></h3>
+<p>a.b[*].c</p>
+<pre><code class="yaml">a:
+  b:
+  - c: thing0 # MATCHES
+  - c: thing1 # MATCHES
+  - c: thing2 # MATCHES
+</code></pre>
+
+<h2 id="deep-splat">Deep Splat<a class="headerlink" href="#deep-splat" title="Permanent link">&para;</a></h2>
+<p>'**' will match arbitrary nodes for both maps and arrays:</p>
+<p>a.**.c</p>
+<pre><code class="yaml">a:
+  b1:
+    c: thing1 # MATCHES
+  b2:
+    c: thing2 # MATCHES
+  b3:
+    d:
+    - f:
+        c: thing3 # MATCHES
+    - f:
+        g:
+          c: thing4 # MATCHES
+</code></pre>
+
+<h2 id="finding-parents-with-particular-children-nodes">Finding parents with particular children nodes<a class="headerlink" href="#finding-parents-with-particular-children-nodes" title="Permanent link">&para;</a></h2>
+<p>a.(b.d==cat).b.c</p>
+<pre><code class="yaml">a:
+  - b:
+      c: thing0
+      d: leopard
+    ba: fast
+  - b:
+      c: thing1 # MATCHES
+      d: cat
+    ba: meowy
+  - b:
+      c: thing2
+      d: caterpillar
+    ba: icky
+  - b:
+      c: thing3 # MATCHES
+      d: cat
+    ba: also meowy
+</code></pre>
+
+<h3 id="with-prefixes">With prefixes<a class="headerlink" href="#with-prefixes" title="Permanent link">&para;</a></h3>
+<p>a.(b.d==cat*).c</p>
+<pre><code class="yaml">a:
+  - b:
+      c: thing0
+      d: leopard
+    ba: fast
+  - b:
+      c: thing1 # MATCHES
+      d: cat
+    ba: meowy
+  - b:
+      c: thing2 # MATCHES
+      d: caterpillar
+    ba: icky
+  - b:
+      c: thing3 # MATCHES
+      d: cat
+    ba: also meowy
+</code></pre>
+
+<h2 id="special-characters">Special Characters<a class="headerlink" href="#special-characters" title="Permanent link">&para;</a></h2>
+<h3 id="keys-with-dots">Keys with dots<a class="headerlink" href="#keys-with-dots" title="Permanent link">&para;</a></h3>
+<p>When specifying a key that has a dot use key lookup indicator.</p>
+<pre><code class="yaml">b:
+  foo.bar: 7
+</code></pre>
+
+<pre><code class="bash">yaml r sample.yaml 'b[foo.bar]'
+</code></pre>
+
+<pre><code class="bash">yaml w sample.yaml 'b[foo.bar]' 9
+</code></pre>
+
+<p>Any valid yaml key can be specified as part of a key lookup.</p>
+<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
+<h3 id="keys-and-values-with-leading-dashes">Keys (and values) with leading dashes<a class="headerlink" href="#keys-and-values-with-leading-dashes" title="Permanent link">&para;</a></h3>
+<p>If a key or value has leading dashes, yq won't know that you are passing a value as opposed to a flag (and you will get a 'bad flag syntax' error).</p>
+<p>To fix that, you will need to tell it to stop processing flags by adding '--' after the last flag like so:</p>
+<pre><code class="bash">yq n -t -- --key --value
+</code></pre>
+
+<p>Will result in</p>
+<pre><code>--key: --value
+</code></pre>
+                
+                  
+                
+              
+              
+                
+
+
+              
+            </article>
+          </div>
+        </div>
+      </main>
+      
+        
+<footer class="md-footer">
+  
+    <div class="md-footer-nav">
+      <nav class="md-footer-nav__inner md-grid">
+        
+          <a href="../read/" title="Read" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
+            <div class="md-flex__cell md-flex__cell--shrink">
+              <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
+            </div>
+            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
+              <span class="md-flex__ellipsis">
+                <span class="md-footer-nav__direction">
+                  Previous
+                </span>
+                Read
+              </span>
+            </div>
+          </a>
+        
+        
+          <a href="../write/" title="Write/Update" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
+            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
+              <span class="md-flex__ellipsis">
+                <span class="md-footer-nav__direction">
+                  Next
+                </span>
+                Write/Update
+              </span>
+            </div>
+            <div class="md-flex__cell md-flex__cell--shrink">
+              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
+            </div>
+          </a>
+        
+      </nav>
+    </div>
+  
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-footer-copyright">
+        
+        powered by
+        <a href="https://www.mkdocs.org">MkDocs</a>
+        and
+        <a href="https://squidfunk.github.io/mkdocs-material/">
+          Material for MkDocs</a>
+      </div>
+      
+  <div class="md-footer-social">
+    <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
+    
+      <a href="https://github.com/mikefarah" class="md-footer-social__link fa fa-github"></a>
+    
+      <a href="https://www.linkedin.com/in/mike-farah-b5a75b2/" class="md-footer-social__link fa fa-linkedin"></a>
+    
+  </div>
+
+    </div>
+  </div>
+</footer>
+      
+    </div>
+    
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
+      
+      <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
+      
+    
+  </body>
+</html>

docs/prefix/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Prefix
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Prefix
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -257,6 +252,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="../write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -460,11 +467,11 @@
                 
                   <h1>Prefix</h1>
                 
-                <p>Paths can be prefixed using the 'prefix' command.
-The complete yaml content will be nested inside the new prefix path.</p>
-<pre><code>yq p &lt;yaml_file&gt; &lt;path&gt;
+                <pre><code>yq p &lt;yaml_file&gt; &lt;path&gt;
 </code></pre>
 
+<p>Prefixes a yaml document with the given path expression. The complete yaml content will be nested inside the new prefix path.</p>
+<p>See docs for <a href="../path_expressions/">path expression</a> for more details.</p>
 <h3 id="to-stdout">To Stdout<a class="headerlink" href="#to-stdout" title="Permanent link">&para;</a></h3>
 <p>Given a data1.yaml file of:</p>
 <pre><code class="yaml">a: simple
@@ -612,7 +619,6 @@ c:
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -622,20 +628,16 @@ c:
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/read/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Read
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Read
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -287,6 +282,13 @@
     Splat
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#prefix-splat" title="Prefix Splat" class="md-nav__link">
+    Prefix Splat
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -317,13 +319,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -340,6 +335,18 @@
       
 
 
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
   <li class="md-nav__item">
     <a href="../write/" title="Write/Update" class="md-nav__link">
       Write/Update
@@ -444,6 +451,13 @@
     Splat
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#prefix-splat" title="Prefix Splat" class="md-nav__link">
+    Prefix Splat
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -474,13 +488,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -502,10 +509,11 @@
                 
                   <h1>Read</h1>
                 
-                <pre><code>yq r &lt;yaml_file|json_file&gt; &lt;path&gt;
+                <pre><code>yq r &lt;yaml_file|json_file&gt; &lt;path_expression&gt;
 </code></pre>
 
-<p>This command can take a json file as input too, and will output yaml unless specified to export as json (-j)</p>
+<p>Returns the matching nodes of the path expression for the given yaml file (or STDIN).</p>
+<p>See docs for <a href="../path_expressions/">path expression</a> for more details.</p>
 <h3 id="basic">Basic<a class="headerlink" href="#basic" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
 <pre><code class="yaml">b:
@@ -531,12 +539,36 @@ bob:
     cats: bananas
   item2:
     cats: apples
+  thing:
+    cats: oranges
 </code></pre>
 
 <p>then</p>
 <pre><code class="bash">yq r sample.yaml bob.*.cats
 </code></pre>
 
+<p>will output</p>
+<pre><code class="yaml">- bananas
+- apples
+- oranges
+</code></pre>
+
+<h3 id="prefix-splat">Prefix Splat<a class="headerlink" href="#prefix-splat" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">---
+bob:
+  item1:
+    cats: bananas
+  item2:
+    cats: apples
+  thing:
+    cats: oranges
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq r sample.yaml bob.item*.cats
+</code></pre>
+
 <p>will output</p>
 <pre><code class="yaml">- bananas
 - apples
@@ -615,20 +647,6 @@ e.g.: given a sample file of</p>
 </code></pre>
 
 <p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
-<h3 id="keys-with-dots">Keys with dots<a class="headerlink" href="#keys-with-dots" title="Permanent link">&para;</a></h3>
-<p>When specifying a key that has a dot use key lookup indicator.</p>
-<pre><code class="yaml">b:
-  foo.bar: 7
-</code></pre>
-
-<pre><code class="bash">yaml r sample.yaml 'b[foo.bar]'
-</code></pre>
-
-<pre><code class="bash">yaml w sample.yaml 'b[foo.bar]' 9
-</code></pre>
-
-<p>Any valid yaml key can be specified as part of a key lookup.</p>
-<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
                 
                   
                 
@@ -664,13 +682,13 @@ e.g.: given a sample file of</p>
           </a>
         
         
-          <a href="../write/" title="Write/Update" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
+          <a href="../path_expressions/" title="Path Expressions" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <span class="md-flex__ellipsis">
                 <span class="md-footer-nav__direction">
                   Next
                 </span>
-                Write/Update
+                Path Expressions
               </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink">
@@ -692,7 +710,6 @@ e.g.: given a sample file of</p>
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -702,20 +719,16 @@ e.g.: given a sample file of</p>
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

docs/sitemap.xml

@@ -2,42 +2,47 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-11-19</lastmod>
+     <lastmod>2020-01-13</lastmod>
+     <changefreq>daily</changefreq>
+    </url>
+    <url>
+     <loc>None</loc>
+     <lastmod>2020-01-13</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>

docs/snippets/keys_with_dots/index.html

@@ -1,441 +0,0 @@
-
-
-
-
-<!DOCTYPE html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta http-equiv="x-ua-compatible" content="ie=edge">
-      
-      
-      
-      
-        <meta name="lang:clipboard.copy" content="Copy to clipboard">
-      
-        <meta name="lang:clipboard.copied" content="Copied to clipboard">
-      
-        <meta name="lang:search.language" content="en">
-      
-        <meta name="lang:search.pipeline.stopwords" content="True">
-      
-        <meta name="lang:search.pipeline.trimmer" content="True">
-      
-        <meta name="lang:search.result.none" content="No matching documents">
-      
-        <meta name="lang:search.result.one" content="1 matching document">
-      
-        <meta name="lang:search.result.other" content="# matching documents">
-      
-        <meta name="lang:search.tokenizer" content="[\s\-]+">
-      
-      <link rel="shortcut icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
-    
-    
-      
-        <title>Keys with dots - Yq</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../assets/stylesheets/application.11e41852.css">
-      
-      
-    
-    
-      <script src="../../assets/javascripts/modernizr.20ef595d.js"></script>
-    
-    
-      
-        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
-        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
-      
-    
-    <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
-    
-    
-    
-  </head>
-  
-    <body dir="ltr">
-  
-    <svg class="md-svg">
-      <defs>
-        
-        
-          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
-    viewBox="0 0 416 448" id="__github">
-  <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
-        8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
-        18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
-        19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
-        18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
-        304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
-        2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
-        38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
-        37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
-        82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
-        1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
-        0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
-        30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
-        46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
-        99.5z" />
-</svg>
-        
-      </defs>
-    </svg>
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-    
-      <a href="#keys-with-dots" tabindex="1" class="md-skip">
-        Skip to content
-      </a>
-    
-    
-      <header class="md-header" data-md-component="header">
-  <nav class="md-header-nav md-grid">
-    <div class="md-flex">
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="../.." title="Yq" class="md-header-nav__button md-logo">
-          
-            <i class="md-icon"></i>
-          
-        </a>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
-      </div>
-      <div class="md-flex__cell md-flex__cell--stretch">
-        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-          
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Keys with dots
-              </span>
-            
-          
-        </div>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        
-          
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
-<div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
-      <label class="md-icon md-search__icon" for="__search"></label>
-      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
-        &#xE5CD;
-      </button>
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result">
-          <div class="md-search-result__meta">
-            Type to start searching
-          </div>
-          <ol class="md-search-result__list"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-          
-        
-      </div>
-      
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-            
-
-
-  
-
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
-    </div>
-  </a>
-
-          </div>
-        </div>
-      
-    </div>
-  </nav>
-</header>
-    
-    <div class="md-container">
-      
-        
-      
-      
-      <main class="md-main">
-        <div class="md-main__inner md-grid" data-md-component="container">
-          
-            
-              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    <nav class="md-nav md-nav--primary" data-md-level="0">
-  <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="../.." title="Yq" class="md-nav__button md-logo">
-      
-        <i class="md-icon"></i>
-      
-    </a>
-    Yq
-  </label>
-  
-    <div class="md-nav__source">
-      
-
-
-  
-
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
-    </div>
-  </a>
-
-    </div>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../.." title="Install" class="md-nav__link">
-      Install
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../read/" title="Read" class="md-nav__link">
-      Read
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../write/" title="Write/Update" class="md-nav__link">
-      Write/Update
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../prefix/" title="Prefix" class="md-nav__link">
-      Prefix
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../delete/" title="Delete" class="md-nav__link">
-      Delete
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../create/" title="Create" class="md-nav__link">
-      Create
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../convert/" title="Convert" class="md-nav__link">
-      Convert
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../merge/" title="Merge" class="md-nav__link">
-      Merge
-    </a>
-  </li>
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-<nav class="md-nav md-nav--secondary">
-  
-  
-  
-    <label class="md-nav__title" for="__toc">Table of contents</label>
-    <ul class="md-nav__list" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
-      
-      
-      
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
-              
-                
-                  <a href="https://github.com/mikefarah/yq/edit/master/docs/snippets/keys_with_dots.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
-                
-                
-                  <h1>Keys with dots</h1>
-                
-                <h3 id="keys-with-dots">Keys with dots<a class="headerlink" href="#keys-with-dots" title="Permanent link">&para;</a></h3>
-<p>When specifying a key that has a dot use key lookup indicator.</p>
-<pre><code class="yaml">b:
-  foo.bar: 7
-</code></pre>
-
-<pre><code class="bash">yaml r sample.yaml 'b[foo.bar]'
-</code></pre>
-
-<pre><code class="bash">yaml w sample.yaml 'b[foo.bar]' 9
-</code></pre>
-
-<p>Any valid yaml key can be specified as part of a key lookup.</p>
-<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
-                
-                  
-                
-              
-              
-                
-
-
-              
-            </article>
-          </div>
-        </div>
-      </main>
-      
-        
-<footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-        
-        powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
-        and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
-          Material for MkDocs</a>
-      </div>
-      
-        
-  <div class="md-footer-social">
-    <link rel="stylesheet" href="../../assets/fonts/font-awesome.css">
-    
-      <a href="https://github.com/mikefarah" class="md-footer-social__link fa fa-github"></a>
-    
-      <a href="https://www.linkedin.com/in/mike-farah-b5a75b2/" class="md-footer-social__link fa fa-linkedin"></a>
-    
-  </div>
-
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    
-      <script src="../../assets/javascripts/application.9e1f3b71.js"></script>
-      
-      <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
-      
-    
-    
-      
-    
-  </body>
-</html>

docs/snippets/works_with_json/index.html

@@ -1,395 +0,0 @@
-
-
-
-
-<!DOCTYPE html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta http-equiv="x-ua-compatible" content="ie=edge">
-      
-      
-      
-      
-        <meta name="lang:clipboard.copy" content="Copy to clipboard">
-      
-        <meta name="lang:clipboard.copied" content="Copied to clipboard">
-      
-        <meta name="lang:search.language" content="en">
-      
-        <meta name="lang:search.pipeline.stopwords" content="True">
-      
-        <meta name="lang:search.pipeline.trimmer" content="True">
-      
-        <meta name="lang:search.result.none" content="No matching documents">
-      
-        <meta name="lang:search.result.one" content="1 matching document">
-      
-        <meta name="lang:search.result.other" content="# matching documents">
-      
-        <meta name="lang:search.tokenizer" content="[\s\-]+">
-      
-      <link rel="shortcut icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
-    
-    
-      
-        <title>Works with json - Yq</title>
-      
-    
-    
-      <link rel="stylesheet" href="../../assets/stylesheets/application.11e41852.css">
-      
-      
-    
-    
-      <script src="../../assets/javascripts/modernizr.20ef595d.js"></script>
-    
-    
-      
-        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
-        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
-      
-    
-    <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
-    
-    
-    
-  </head>
-  
-    <body dir="ltr">
-  
-    <svg class="md-svg">
-      <defs>
-        
-        
-          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
-    viewBox="0 0 416 448" id="__github">
-  <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
-        8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
-        18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
-        19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
-        18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
-        304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
-        2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
-        38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
-        37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
-        82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
-        1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
-        0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
-        30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
-        46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
-        99.5z" />
-</svg>
-        
-      </defs>
-    </svg>
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-    
-    
-      <header class="md-header" data-md-component="header">
-  <nav class="md-header-nav md-grid">
-    <div class="md-flex">
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="../.." title="Yq" class="md-header-nav__button md-logo">
-          
-            <i class="md-icon"></i>
-          
-        </a>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
-      </div>
-      <div class="md-flex__cell md-flex__cell--stretch">
-        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-          
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Works with json
-              </span>
-            
-          
-        </div>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        
-          
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
-<div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
-      <label class="md-icon md-search__icon" for="__search"></label>
-      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
-        &#xE5CD;
-      </button>
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result">
-          <div class="md-search-result__meta">
-            Type to start searching
-          </div>
-          <ol class="md-search-result__list"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-          
-        
-      </div>
-      
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-            
-
-
-  
-
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
-    </div>
-  </a>
-
-          </div>
-        </div>
-      
-    </div>
-  </nav>
-</header>
-    
-    <div class="md-container">
-      
-        
-      
-      
-      <main class="md-main">
-        <div class="md-main__inner md-grid" data-md-component="container">
-          
-            
-              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    <nav class="md-nav md-nav--primary" data-md-level="0">
-  <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="../.." title="Yq" class="md-nav__button md-logo">
-      
-        <i class="md-icon"></i>
-      
-    </a>
-    Yq
-  </label>
-  
-    <div class="md-nav__source">
-      
-
-
-  
-
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
-    </div>
-  </a>
-
-    </div>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../.." title="Install" class="md-nav__link">
-      Install
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../read/" title="Read" class="md-nav__link">
-      Read
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../write/" title="Write/Update" class="md-nav__link">
-      Write/Update
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../prefix/" title="Prefix" class="md-nav__link">
-      Prefix
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../delete/" title="Delete" class="md-nav__link">
-      Delete
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../create/" title="Create" class="md-nav__link">
-      Create
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../convert/" title="Convert" class="md-nav__link">
-      Convert
-    </a>
-  </li>
-
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="../../merge/" title="Merge" class="md-nav__link">
-      Merge
-    </a>
-  </li>
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-          
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
-              
-                
-                  <a href="https://github.com/mikefarah/yq/edit/master/docs/snippets/works_with_json.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
-                
-                
-                  <h1>Works with json</h1>
-                
-                <p>This command can take a json file as input too, and will output yaml unless specified to export as json (-j)</p>
-                
-                  
-                
-              
-              
-                
-
-
-              
-            </article>
-          </div>
-        </div>
-      </main>
-      
-        
-<footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-        
-        powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
-        and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
-          Material for MkDocs</a>
-      </div>
-      
-        
-  <div class="md-footer-social">
-    <link rel="stylesheet" href="../../assets/fonts/font-awesome.css">
-    
-      <a href="https://github.com/mikefarah" class="md-footer-social__link fa fa-github"></a>
-    
-      <a href="https://www.linkedin.com/in/mike-farah-b5a75b2/" class="md-footer-social__link fa fa-linkedin"></a>
-    
-  </div>
-
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    
-      <script src="../../assets/javascripts/application.9e1f3b71.js"></script>
-      
-      <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
-      
-    
-    
-      
-    
-  </body>
-</html>

docs/write/index.html

@@ -2,7 +2,7 @@
 
 
 
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en" class="no-js">
   <head>
     
@@ -32,7 +32,7 @@
         <meta name="lang:search.tokenizer" content="[\s\-]+">
       
       <link rel="shortcut icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.1.0">
+      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.2.0">
     
     
       
@@ -40,12 +40,12 @@
       
     
     
-      <link rel="stylesheet" href="../assets/stylesheets/application.11e41852.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.750b69bd.css">
       
       
     
     
-      <script src="../assets/javascripts/modernizr.20ef595d.js"></script>
+      <script src="../assets/javascripts/modernizr.74668098.js"></script>
     
     
       
@@ -58,6 +58,9 @@
     
     
     
+      
+    
+    
   </head>
   
     <body dir="ltr">
@@ -112,22 +115,19 @@
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
-            
-              <span class="md-header-nav__topic">
-                Yq
-              </span>
-              <span class="md-header-nav__topic">
-                Write/Update
-              </span>
-            
+            <span class="md-header-nav__topic">
+              Yq
+            </span>
+            <span class="md-header-nav__topic">
+              Write/Update
+            </span>
           
         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         
+          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
           
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-            
 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
@@ -150,7 +150,6 @@
     </div>
   </div>
 </div>
-          
         
       </div>
       
@@ -161,20 +160,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
           </div>
         </div>
       
@@ -210,20 +207,18 @@
 
   
 
-
-  <a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-    
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    
-    <div class="md-source__repository">
-      mikefarah/yq
+<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
+  
+    <div class="md-source__icon">
+      <svg viewBox="0 0 24 24" width="24" height="24">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
     </div>
-  </a>
-
+  
+  <div class="md-source__repository">
+    mikefarah/yq
+  </div>
+</a>
     </div>
   
   <ul class="md-nav__list" data-md-scrollfix>
@@ -256,6 +251,18 @@
       
       
 
+
+  <li class="md-nav__item">
+    <a href="../path_expressions/" title="Path Expressions" class="md-nav__link">
+      Path Expressions
+    </a>
+  </li>
+
+    
+      
+      
+      
+
   
 
 
@@ -299,6 +306,27 @@
     Adding new fields
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#splat" title="Splat" class="md-nav__link">
+    Splat
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#prefix-splat" title="Prefix Splat" class="md-nav__link">
+    Prefix Splat
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#array-splat" title="Array Splat" class="md-nav__link">
+    Array Splat
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -343,13 +371,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -458,6 +479,27 @@
     Adding new fields
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#splat" title="Splat" class="md-nav__link">
+    Splat
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#prefix-splat" title="Prefix Splat" class="md-nav__link">
+    Prefix Splat
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#array-splat" title="Array Splat" class="md-nav__link">
+    Array Splat
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -502,13 +544,6 @@
   
 </li>
       
-        <li class="md-nav__item">
-  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
-    Keys with dots
-  </a>
-  
-</li>
-      
       
       
       
@@ -530,9 +565,11 @@
                 
                   <h1>Write/Update</h1>
                 
-                <pre><code>yq w &lt;yaml_file&gt; &lt;path&gt; &lt;new value&gt;
+                <pre><code>yq w &lt;yaml_file&gt; &lt;path_expression&gt; &lt;new value&gt;
 </code></pre>
 
+<p>Updates all the matching nodes of path expression to the supplied value.</p>
+<p>See docs for <a href="../path_expressions/">path expression</a> for more details.</p>
 <h3 id="to-stdout">To Stdout<a class="headerlink" href="#to-stdout" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
 <pre><code class="yaml">b:
@@ -560,7 +597,7 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yq w sample.yaml b.d[0] &quot;new thing&quot;
+<pre><code class="bash">yq w sample.yaml b.d[+] &quot;new thing&quot;
 </code></pre>
 
 <p>will output:</p>
@@ -570,6 +607,81 @@
     - new thing
 </code></pre>
 
+<h3 id="splat">Splat<a class="headerlink" href="#splat" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">---
+bob:
+  item1:
+    cats: bananas
+  item2:
+    cats: apples
+  thing:
+    cats: oranges
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w sample.yaml bob.*.cats meow
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">---
+bob:
+  item1:
+    cats: meow
+  item2:
+    cats: meow
+  thing:
+    cats: meow
+</code></pre>
+
+<h3 id="prefix-splat">Prefix Splat<a class="headerlink" href="#prefix-splat" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">---
+bob:
+  item1:
+    cats: bananas
+  item2:
+    cats: apples
+  thing:
+    cats: oranges
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w sample.yaml bob.item*.cats meow
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">---
+bob:
+  item1:
+    cats: meow
+  item2:
+    cats: meow
+  thing:
+    cats: oranges
+</code></pre>
+
+<h3 id="array-splat">Array Splat<a class="headerlink" href="#array-splat" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">---
+bob:
+- cats: bananas
+- cats: apples
+- cats: oranges
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w sample.yaml bob[*].cats meow
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">---
+bob:
+- cats: meow
+- cats: meow
+- cats: meow
+</code></pre>
+
 <h3 id="appending-value-to-an-array-field">Appending value to an array field<a class="headerlink" href="#appending-value-to-an-array-field" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
 <pre><code class="yaml">b:
@@ -655,7 +767,7 @@ b:
 
 <p>and a script update_instructions.yaml of:</p>
 <pre><code class="yaml">b.c: 3
-b.e[0].name: Howdy Partner
+b.e[+].name: Howdy Partner
 </code></pre>
 
 <p>then</p>
@@ -682,21 +794,6 @@ b.e[0].name: Howdy Partner
 <pre><code class="yaml">my:
   path: -3
 </code></pre>
-
-<h3 id="keys-with-dots">Keys with dots<a class="headerlink" href="#keys-with-dots" title="Permanent link">&para;</a></h3>
-<p>When specifying a key that has a dot use key lookup indicator.</p>
-<pre><code class="yaml">b:
-  foo.bar: 7
-</code></pre>
-
-<pre><code class="bash">yaml r sample.yaml 'b[foo.bar]'
-</code></pre>
-
-<pre><code class="bash">yaml w sample.yaml 'b[foo.bar]' 9
-</code></pre>
-
-<p>Any valid yaml key can be specified as part of a key lookup.</p>
-<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
                 
                   
                 
@@ -717,7 +814,7 @@ b.e[0].name: Howdy Partner
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
         
-          <a href="../read/" title="Read" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
+          <a href="../path_expressions/" title="Path Expressions" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
             <div class="md-flex__cell md-flex__cell--shrink">
               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
             </div>
@@ -726,7 +823,7 @@ b.e[0].name: Howdy Partner
                 <span class="md-footer-nav__direction">
                   Previous
                 </span>
-                Read
+                Path Expressions
               </span>
             </div>
           </a>
@@ -760,7 +857,6 @@ b.e[0].name: Howdy Partner
           Material for MkDocs</a>
       </div>
       
-        
   <div class="md-footer-social">
     <link rel="stylesheet" href="../assets/fonts/font-awesome.css">
     
@@ -770,20 +866,16 @@ b.e[0].name: Howdy Partner
     
   </div>
 
-      
     </div>
   </div>
 </footer>
       
     </div>
     
-      <script src="../assets/javascripts/application.9e1f3b71.js"></script>
+      <script src="../assets/javascripts/application.39abc4af.js"></script>
       
       <script>app.initialize({version:"1.0.4",url:{base:".."}})</script>
       
     
-    
-      
-    
   </body>
 </html>

examples/array.yaml

@@ -7,3 +7,5 @@
     - lala
     - land
   serial: 1
+- become: false
+  gather_facts: true

examples/data1.yaml

@@ -1,2 +1,4 @@
-a: simple
+a: simple # just the best
 b: [1, 2]
+c:
+  test: 1

examples/data2.yaml

@@ -1,4 +1,7 @@
-a: other
+a: other # better than the original
 b: [3, 4]
 c:
+  toast: leave
   test: 1
+  tell: 1
+  taco: cool

examples/data3.yaml

@@ -1 +1,14 @@
-b: dog
+deep1:
+   hostA:
+      value: 1234
+   notRelevant:
+      value: bananas
+   hostB:
+      value: 5678
+deep2:
+   hostC:
+      value: 1234
+   notRelevant:
+      value: bananas
+   hostD:
+      value: 5678

examples/empty.yaml

@@ -0,0 +1,2 @@
+# a: apple
+# b: cat

examples/instruction_sample.yaml

@@ -1,2 +1,7 @@
-b.c: cat
-b.e[0].name: Mike Farah
+- command: update 
+  path: b.c
+  value:
+    #great 
+    things: frog # wow!
+- command: delete
+  path: b.d

examples/merge-anchor.yaml

@@ -0,0 +1,19 @@
+foo: &foo
+  a: original
+  thing: coolasdf
+  thirsty: yep
+
+bar: &bar
+  b: 2
+  thing: coconut
+  c: oldbar
+
+foobarList:
+  <<: [*foo,*bar]
+  c: newbar
+
+foobar:
+  <<: *foo
+  thirty: well beyond
+  thing: ice
+  c: 3

examples/numbered_keys.yml

@@ -0,0 +1,2 @@
+5:
+  6: camel!

examples/sample.yaml

@@ -1,9 +1,13 @@
-a: Easy! as one two three
-b:
-  c: 2
-  d: [3, 4]
-  e:
-    - name: fred
-      value: 3
-    - name: sam
-      value: 4
+bob:
+  item:
+    cats: bananas
+  something:
+    cats: lemons
+  itemThing:
+    cats: bananas
+  item2:
+    cats: apples
+  thing:
+    cats: oranges
+my:
+  path: -3

examples/sample2.yaml

@@ -1,9 +1,2 @@
-a: Easy! as one two three
 b:
-  c: things
-  d: whatever
-things:
- thing1:
-  cat: 'fred'
- thing2:
-  cat: 'sam'
+  c: things

examples/sample_array_2.yaml

@@ -1 +1,2 @@
-[4,5]
+- 4
+- 5

examples/simple-anchor.yaml

@@ -0,0 +1,4 @@
+foo: &foo
+  a: 1
+
+foobar: *foo

go.mod

@@ -0,0 +1,13 @@
+module github.com/mikefarah/yq/v3
+
+require (
+	github.com/mikefarah/yaml/v2 v2.4.0 // indirect
+	github.com/pkg/errors v0.8.1
+	github.com/spf13/cobra v0.0.5
+	golang.org/x/tools v0.0.0-20191213221258-04c2e8eff935 // indirect
+	gopkg.in/imdario/mergo.v0 v0.3.7 // indirect
+	gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473
+	gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2
+)
+
+go 1.13

go.sum

@@ -0,0 +1,62 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
+github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
+github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
+github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
+github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
+github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
+github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
+github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
+github.com/mikefarah/yaml v2.1.0+incompatible h1:nu2cqmzk4WlWJNgnevY88faMcdrDzYGcsUjYFxEpB7Y=
+github.com/mikefarah/yaml/v2 v2.4.0 h1:eYqfooY0BnvKTJxr7+ABJs13n3dg9n347GScDaU2Lww=
+github.com/mikefarah/yaml/v2 v2.4.0/go.mod h1:ahVqZF4n1W4NqwvVnZzC4es67xsW9uR/RRf2RRxieJU=
+github.com/mikefarah/yq v2.4.0+incompatible h1:oBxbWy8R9hI3BIUUxEf0CzikWa2AgnGrGhvGQt5jgjk=
+github.com/mikefarah/yq/v2 v2.4.1 h1:tajDonaFK6WqitSZExB6fKlWQy/yCkptqxh2AXEe3N4=
+github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
+github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
+github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
+github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
+github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
+github.com/spf13/cobra v0.0.5 h1:f0B+LkLX6DtmRH1isoNA9VTtNUK9K8xYd28JNNfOv/s=
+github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
+github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
+github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
+github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
+github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
+golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
+golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/tools v0.0.0-20191030203535-5e247c9ad0a0 h1:s5lp4ug7qHzUccgyFdjsX7OZDzHXRaePrF3B3vmUiuM=
+golang.org/x/tools v0.0.0-20191030203535-5e247c9ad0a0/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/tools v0.0.0-20191213221258-04c2e8eff935 h1:kJQZhwFzSwJS2BxboKjdZzWczQOZx8VuH7Y8hhuGUtM=
+golang.org/x/tools v0.0.0-20191213221258-04c2e8eff935/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/imdario/mergo.v0 v0.3.7 h1:QDotlIZtaO/p+Um0ok18HRTpq5i5/SAk/qprsor+9c8=
+gopkg.in/imdario/mergo.v0 v0.3.7/go.mod h1:9qPP6AGrlC1G2PTNXko614FwGZvorN7MiBU0Eppok+U=
+gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473 h1:6D+BvnJ/j6e222UW8s2qTSe3wGBtvo0MbVQG/c5k8RE=
+gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473/go.mod h1:N1eN2tsCx0Ydtgjl4cqmbRCsY4/+z4cYDeqwZTk6zog=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2 h1:XZx7nhd5GMaZpmDaEHFVafUZC7ya0fuo7cSJ3UCKYmM=
+gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

json_converter.go

@@ -1,44 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"fmt"
-	"strconv"
-
-	yaml "gopkg.in/mikefarah/yaml.v2"
-)
-
-func jsonToString(context interface{}) (string, error) {
-	out, err := json.Marshal(toJSON(context))
-	if err != nil {
-		return "", fmt.Errorf("error printing yaml as json: %v", err)
-	}
-	return string(out), nil
-}
-
-func toJSON(context interface{}) interface{} {
-	switch context.(type) {
-	case []interface{}:
-		oldArray := context.([]interface{})
-		newArray := make([]interface{}, len(oldArray))
-		for index, value := range oldArray {
-			newArray[index] = toJSON(value)
-		}
-		return newArray
-	case yaml.MapSlice:
-		oldMap := context.(yaml.MapSlice)
-		newMap := make(map[string]interface{})
-		for _, entry := range oldMap {
-			if str, ok := entry.Key.(string); ok {
-				newMap[str] = toJSON(entry.Value)
-			} else if i, ok := entry.Key.(int); ok {
-				newMap[strconv.Itoa(i)] = toJSON(entry.Value)
-			} else if b, ok := entry.Key.(bool); ok {
-				newMap[strconv.FormatBool(b)] = toJSON(entry.Value)
-			}
-		}
-		return newMap
-	default:
-		return context
-	}
-}

json_converter_test.go

@@ -1,46 +0,0 @@
-package main
-
-import (
-	"testing"
-)
-
-func TestJsonToString(t *testing.T) {
-	var data = parseData(`
----
-b:
-  c: 2
-`)
-	got, _ := jsonToString(data)
-	assertResult(t, "{\"b\":{\"c\":2}}", got)
-}
-
-func TestJsonToString_withIntKey(t *testing.T) {
-	var data = parseData(`
----
-b:
-  2: c
-`)
-	got, _ := jsonToString(data)
-	assertResult(t, `{"b":{"2":"c"}}`, got)
-}
-
-func TestJsonToString_withBoolKey(t *testing.T) {
-	var data = parseData(`
----
-b:
-  false: c
-`)
-	got, _ := jsonToString(data)
-	assertResult(t, `{"b":{"false":"c"}}`, got)
-}
-
-func TestJsonToString_withArray(t *testing.T) {
-	var data = parseData(`
----
-b:
-  - item: one
-  - item: two
-`)
-	got, _ := jsonToString(data)
-	assertResult(t, "{\"b\":[{\"item\":\"one\"},{\"item\":\"two\"}]}", got)
-}

merge.go

@@ -1,12 +0,0 @@
-package main
-
-import "gopkg.in/imdario/mergo.v0"
-
-func merge(dst interface{}, src interface{}, overwrite bool, append bool) error {
-	if overwrite {
-		return mergo.Merge(dst, src, mergo.WithOverride)
-	} else if append {
-		return mergo.Merge(dst, src, mergo.WithAppendSlice)
-	}
-	return mergo.Merge(dst, src)
-}

mkdocs.yml

@@ -5,6 +5,7 @@ theme: 'material'
 pages:
     - Install: index.md
     - Read: read.md
+    - Path Expressions: path_expressions.md
     - Write/Update: write.md
     - Prefix: prefix.md
     - Delete: delete.md

mkdocs/convert.md

@@ -1,5 +1,7 @@
-### Yaml to Json
-To convert output to json, use the --tojson (or -j) flag. This can only be used with the read command.
+## Yaml to Json
+To convert output to json, use the --tojson (or -j) flag. This is supported by all commands.
+
+Each matching yaml node will be converted to json and printed out on a separate line.
 
 Given a sample.yaml file of:
 ```yaml
@@ -8,7 +10,7 @@ b:
 ```
 then
 ```bash
-yq r -j sample.yaml b.c
+yq r -j sample.yaml
 ```
 
 will output
@@ -16,7 +18,25 @@ will output
 {"b":{"c":2}}
 ```
 
-### Json to Yaml
+Given a sample.yaml file of:
+```yaml
+bob:
+  c: 2
+bab:
+  c: 5
+```
+then
+```bash
+yq r -j sample.yaml b*
+```
+
+will output
+```json
+{"c":2}
+{"c":5}
+```
+
+## Json to Yaml
 To read in json, just pass in a json file instead of yaml, it will just work :)
 
 e.g given a json file

mkdocs/create.md

@@ -1,10 +1,12 @@
+```
+yq n <path_expression> <new value>
+```
+
 Yaml files can be created using the 'new' command. This works in the same way as the write command, but you don't pass in an existing Yaml file. Currently this does not support creating multiple documents in a single yaml file.
 
-```
-yq n <path> <new value>
-```
+See docs for [path expression](path_expressions.md)
 
-### Creating a simple yaml file
+## Creating a simple yaml file
 ```bash
 yq n b.c cat
 ```
@@ -14,13 +16,16 @@ b:
   c: cat
 ```
 
-### Creating using a create script
+## Creating using a create script
 Create scripts follow the same format as the update scripts.
 
 Given a script create_instructions.yaml of:
 ```yaml
-b.c: 3
-b.e[0].name: Howdy Partner
+- command: update 
+  path: b.c
+  value:
+    #great 
+    things: frog # wow!
 ```
 then
 
@@ -30,15 +35,13 @@ yq n -s create_instructions.yaml
 will output:
 ```yaml
 b:
-  c: 3
-  e:
-    - name: Howdy Partner
+  c:
+    #great
+    things: frog # wow!
 ```
 
 You can also pipe the instructions in:
 
 ```bash
 cat create_instructions.yaml | yq n -s -
-```
-
-{!snippets/keys_with_dots.md!}
+```

mkdocs/delete.md

@@ -1,8 +1,13 @@
 ```
-yq d <yaml_file> <path_to_delete>
+yq delete <yaml_file|-> <path_expression>
 ```
 
-### To Stdout
+The delete command will delete all the matching nodes for the path expression in the given yaml input.
+
+See docs for [path expression](path_expressions.md) for more details.
+
+
+## Deleting from a simple document
 Given a sample.yaml file of:
 ```yaml
 b:
@@ -13,54 +18,29 @@ then
 ```bash
 yq d sample.yaml b.c
 ```
-will output:
+will output
 ```yaml
 b:
   apples: green
 ```
 
-### From STDIN
+## From STDIN
+Use "-" (without quotes) in-place of a file name if you wish to pipe in input from STDIN.
+
 ```bash
 cat sample.yaml | yq d - b.c
 ```
 
-### Deleting array elements
-Given a sample.yaml file of:
-```yaml
-b:
-  c: 
-    - 1
-    - 2
-    - 3
-```
-then
-```bash
-yq d sample.yaml 'b.c[1]'
-```
-will output:
-```yaml
-b:
-  c:
-  - 1
-  - 3
-```
-
-### Deleting nodes in-place
-Given a sample.yaml file of:
-```yaml
-b:
-  c: 2
-  apples: green
-```
-then
+## Deleting in-place
 ```bash
 yq d -i sample.yaml b.c
 ```
 will update the sample.yaml file so that the 'c' node is deleted
 
 
+## Multiple Documents
 
-### Multiple Documents - delete from single document
+### Delete from single document
 Given a sample.yaml file of:
 ```yaml
 something: else
@@ -83,7 +63,7 @@ b:
   c: 2
 ```
 
-### Multiple Documents - delete from all documents
+### Delete from all documents
 Given a sample.yaml file of:
 ```yaml
 something: else
@@ -104,7 +84,3 @@ something: else
 b:
   c: 2
 ```
-
-Note that '*' is in quotes to avoid being interpreted by your shell.
-
-{!snippets/keys_with_dots.md!}

mkdocs/index.md

@@ -20,7 +20,7 @@ sudo apt install yq -y
 ```
 or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
 ```
-go get gopkg.in/mikefarah/yq.v2
+GO111MODULE=on go get github.com/mikefarah/yq/v3
 ```
 
 [View on GitHub](https://github.com/mikefarah/yq)

mkdocs/merge.md

@@ -6,7 +6,7 @@ yq m <yaml_file> <path>...
 ```
 
 
-### To Stdout
+## Merge example
 Given a data1.yaml file of:
 ```yaml
 a: simple
@@ -30,25 +30,13 @@ c:
   test: 1
 ```
 
-### Updating files in-place
-Given a data1.yaml file of:
-```yaml
-a: simple
-b: [1, 2]
-```
-and data2.yaml file of:
-```yaml
-a: other
-c:
-  test: 1
-```
-then
+## Updating files in-place
 ```bash
 yq m -i data1.yaml data2.yaml
 ```
-will update the data1.yaml file so that the value of 'c' is 'test: 1'.
+will update the data1.yaml file with the merged result.
 
-### Overwrite values
+## Overwrite values
 Given a data1.yaml file of:
 ```yaml
 a: simple
@@ -102,7 +90,7 @@ d: false
 
 Notice that 'b' does not result in the merging of the values within an array. 
 
-### Append values with arrays
+## Append values with arrays
 Given a data1.yaml file of:
 ```yaml
 a: simple
@@ -133,9 +121,8 @@ d: hi
 
 Note that the 'b' array has concatenated the values from the second data file. Also note that other map keys are not overridden (field a).
 
-Append cannot be used with overwrite, if both flags are given then append is ignored.
-
-### Multiple Documents - merge into single document
+## Multiple Documents
+### Merge into single document
 Currently yq only has multi-document support for the _first_ document being merged into. The remaining yaml files will have their first document selected.
 
 Given a data1.yaml file of:
@@ -161,7 +148,7 @@ a: simple
 b: dog
 ```
 
-### Multiple Documents - merge into all documents
+### Merge into all documents
 Currently yq only has multi-document support for the _first_ document being merged into. The remaining yaml files will have their first document selected.
 
 Given a data1.yaml file of:

mkdocs/path_expressions.md

@@ -0,0 +1,208 @@
+Path expressions are used to deeply navigate and match particular yaml nodes.
+
+_As a general rule, you should wrap paths in quotes to prevent your CLI from processing '*, []' and other special characters._
+
+## Simple expressions
+
+### Maps
+
+a.b.c
+
+```yaml
+a:
+  b:
+    c: thing # MATCHES
+```
+
+### Arrays
+
+a.b[1].c
+
+```yaml
+a:
+  b:
+  - c: thing0 
+  - c: thing1 # MATCHES
+  - c: thing2
+```
+
+#### Appending to arrays
+(e.g. when using the write command)
+
+a.b[+].c
+
+
+```yaml
+a:
+  b:
+  - c: thing0 
+```
+
+Will add a new entry:
+
+```yaml
+a:
+  b:
+  - c: thing0 
+  - c: thing1 # NEW entry from [+] on B array.
+```
+
+
+## Splat
+
+### Maps
+a.*.c
+
+```yaml
+a:
+  b1:
+    c: thing # MATCHES
+    d: whatever
+  b2:
+    c: thing # MATCHES
+    f: something irrelevant
+```
+
+#### Prefix splat
+
+bob.item*.cats
+
+```yaml
+bob:
+  item:
+    cats: bananas # MATCHES
+  something:
+    cats: lemons
+  itemThing:
+    cats: more bananas # MATCHES
+  item2:
+    cats: apples # MATCHES
+  thing:
+    cats: oranges
+```
+
+### Arrays
+a.b[*].c
+
+```yaml
+a:
+  b:
+  - c: thing0 # MATCHES
+    d: what..ever
+  - c: thing1 # MATCHES
+    d: blarh
+  - c: thing2 # MATCHES
+    f: thingamabob
+```
+
+## Deep Splat
+
+'**' will match arbitrary nodes for both maps and arrays:
+
+a.**.c
+
+```yaml
+a:
+  b1:
+    c: thing1 # MATCHES
+    d: cat cat
+  b2:
+    c: thing2 # MATCHES
+    d: dog dog
+  b3:
+    d:
+    - f:
+        c: thing3 # MATCHES
+        d: beep
+    - f:
+        g:
+          c: thing4 # MATCHES
+          d: boop
+    - d: mooo
+```
+
+
+## Search by children nodes
+
+a.(b.d==cat).b.c
+
+```yaml
+a:
+  - b:
+      c: thing0
+      d: leopard
+    ba: fast
+  - b:
+      c: thing1 # MATCHES
+      d: cat
+    ba: meowy
+  - b:
+      c: thing2
+      d: caterpillar
+    ba: icky
+  - b:
+      c: thing3 # MATCHES
+      d: cat
+    ba: also meowy
+```
+
+### With prefixes
+
+a.(b.d==cat*).c
+
+```yaml
+a:
+  - b:
+      c: thing0
+      d: leopard
+    ba: fast
+  - b:
+      c: thing1 # MATCHES
+      d: cat
+    ba: meowy
+  - b:
+      c: thing2 # MATCHES
+      d: caterpillar
+    ba: icky
+  - b:
+      c: thing3 # MATCHES
+      d: cat
+    ba: also meowy
+```
+
+
+## Special Characters
+
+
+### Keys with dots
+When specifying a key that has a dot use key lookup indicator.
+
+```yaml
+b:
+  foo.bar: 7
+```
+
+```bash
+yaml r sample.yaml 'b[foo.bar]'
+```
+
+```bash
+yaml w sample.yaml 'b[foo.bar]' 9
+```
+
+Any valid yaml key can be specified as part of a key lookup.
+
+Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
+
+### Keys (and values) with leading dashes
+The flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags, if they start if a dash.
+
+```bash
+yq n -j -- --key --value
+```
+
+Will result in
+
+```
+--key: --value
+```

mkdocs/prefix.md

@@ -1,28 +1,12 @@
-Paths can be prefixed using the 'prefix' command.
-The complete yaml content will be nested inside the new prefix path.
-
 ```
 yq p <yaml_file> <path>
 ```
 
-### To Stdout
-Given a data1.yaml file of:
-```yaml
-a: simple
-b: [1, 2]
-```
-then
-```bash
-yq p data1.yaml c
-```
-will output:
-```yaml
-c:
-  a: simple
-  b: [1, 2]
-```
+Prefixes a yaml document with the given path expression. The complete yaml content will be nested inside the new prefix path.
 
-### Arbitrary depth
+See docs for [path expression](path_expressions.md) for more details.
+
+## Prefix a document
 Given a data1.yaml file of:
 ```yaml
 a:
@@ -40,19 +24,14 @@ c:
       b: [1, 2]
 ```
 
-### Updating files in-place
-Given a data1.yaml file of:
-```yaml
-a: simple
-b: [1, 2]
-```
-then
+## Updating files in-place
 ```bash
 yq p -i data1.yaml c
 ```
-will update the data1.yaml file so that the path 'c' is prefixed to all other paths.
+will update the data1.yaml file so that the path 'c' prefixes the document.
 
-### Multiple Documents - prefix a single document
+## Multiple Documents
+### Prefix a single document
 Given a data1.yaml file of:
 ```yaml
 something: else
@@ -73,7 +52,7 @@ c:
   b: cat
 ```
 
-### Multiple Documents - prefix all documents
+### Prefix all documents
 Given a data1.yaml file of:
 ```yaml
 something: else

mkdocs/read.md

@@ -1,10 +1,14 @@
 ```
-yq r <yaml_file|json_file> <path>
+yq r <yaml_file|json_file> <path_expression>
 ```
 
-{!snippets/works_with_json.md!}
+TALK PRINTING ABOUT KEYS AND VALUES
 
-### Basic
+Returns the matching nodes of the path expression for the given yaml file (or STDIN).
+
+See docs for [path expression](path_expressions.md) for more details.
+
+## Basic
 Given a sample.yaml file of:
 ```yaml
 b:
@@ -16,34 +20,16 @@ yq r sample.yaml b.c
 ```
 will output the value of '2'.
 
-### From Stdin
+## From Stdin
 Given a sample.yaml file of:
 ```bash
 cat sample.yaml | yq r - b.c
 ```
 will output the value of '2'.
 
-### Splat
-Given a sample.yaml file of:
-```yaml
----
-bob:
-  item1:
-    cats: bananas
-  item2:
-    cats: apples
-```
-then
-```bash
-yq r sample.yaml bob.*.cats
-```
-will output
-```yaml
-- bananas
-- apples
-```
 
-### Multiple Documents - specify a single document
+## Multiple Documents
+### Reading from a single document
 Given a sample.yaml file of:
 ```yaml
 something: else
@@ -57,7 +43,7 @@ yq r -d1 sample.yaml b.c
 ```
 will output the value of '2'.
 
-### Multiple Documents - read all documents
+### Read from all documents
 Reading all documents will return the result as an array. This can be converted to json using the '-j' flag if desired.
 
 Given a sample.yaml file of:
@@ -80,46 +66,4 @@ will output:
 - Fred
 - Stella
 - Android
-```
-
-### Arrays
-You can give an index to access a specific element:
-e.g.: given a sample file of
-```yaml
-b:
-  e:
-    - name: fred
-      value: 3
-    - name: sam
-      value: 4
-```
-then
-```
-yq r sample.yaml 'b.e[1].name'
-```
-will output 'sam'
-
-Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
-
-### Array Splat
-e.g.: given a sample file of
-```yaml
-b:
-  e:
-    - name: fred
-      value: 3
-    - name: sam
-      value: 4
-```
-then
-```
-yq r sample.yaml 'b.e[*].name'
-```
-will output:
-```
-- fred
-- sam
-```
-Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
-
-{!snippets/keys_with_dots.md!}
+```

mkdocs/snippets/keys_with_dots.md

@@ -1,19 +0,0 @@
-### Keys with dots
-When specifying a key that has a dot use key lookup indicator.
-
-```yaml
-b:
-  foo.bar: 7
-```
-
-```bash
-yaml r sample.yaml 'b[foo.bar]'
-```
-
-```bash
-yaml w sample.yaml 'b[foo.bar]' 9
-```
-
-Any valid yaml key can be specified as part of a key lookup.
-
-Note that the path is in quotes to avoid the square brackets being interpreted by your shell.

mkdocs/snippets/works_with_json.md

@@ -1 +0,0 @@
-This command can take a json file as input too, and will output yaml unless specified to export as json (-j)

mkdocs/write.md

@@ -1,8 +1,12 @@
 ```
-yq w <yaml_file> <path> <new value>
+yq w <yaml_file> <path_expression> <new value>
 ```
 
-### To Stdout
+Updates all the matching nodes of path expression to the supplied value.
+
+See docs for [path expression](path_expressions.md) for more details.
+
+## Basic
 Given a sample.yaml file of:
 ```yaml
 b:
@@ -18,12 +22,18 @@ b:
   c: cat
 ```
 
-### From STDIN
+### Updating files in-place
+```bash
+yq w -i sample.yaml b.c cat
+```
+will update the sample.yaml file so that the value of 'c' is cat.
+
+## From STDIN
 ```bash
 cat sample.yaml | yq w - b.c blah
 ```
 
-### Adding new fields
+## Adding new fields
 Any missing fields in the path will be created on the fly.
 
 Given a sample.yaml file of:
@@ -33,7 +43,7 @@ b:
 ```
 then
 ```bash
-yq w sample.yaml b.d[0] "new thing"
+yq w sample.yaml b.d[+] "new thing"
 ```
 will output:
 ```yaml
@@ -43,7 +53,7 @@ b:
     - new thing
 ```
 
-### Appending value to an array field
+## Appending value to an array field
 Given a sample.yaml file of:
 ```yaml
 b:
@@ -68,7 +78,8 @@ b:
 
 Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
 
-### Multiple Documents - update a single document
+## Multiple Documents 
+### Update a single document
 Given a sample.yaml file of:
 ```yaml
 something: else
@@ -88,7 +99,7 @@ b:
   c: 5
 ```
 
-### Multiple Documents - update all documents
+### Update all documents
 Given a sample.yaml file of:
 ```yaml
 something: else
@@ -110,22 +121,11 @@ b:
   c: 5
 ```
 
-Note that '*' is in quotes to avoid being interpreted by your shell.
+UPDATE THIS
+UPDATE THIS 
+INCLUDE DELETE EXAMPLE
 
-### Updating files in-place
-Given a sample.yaml file of:
-```yaml
-b:
-  c: 2
-```
-then
-```bash
-yq w -i sample.yaml b.c cat
-```
-will update the sample.yaml file so that the value of 'c' is cat.
-
-
-### Updating multiple values with a script
+## Updating multiple values with a script 
 Given a sample.yaml file of:
 ```yaml
 b:
@@ -136,7 +136,7 @@ b:
 and a script update_instructions.yaml of:
 ```yaml
 b.c: 3
-b.e[0].name: Howdy Partner
+b.e[+].name: Howdy Partner
 ```
 then
 
@@ -155,18 +155,3 @@ And, of course, you can pipe the instructions in using '-':
 ```bash
 cat update_instructions.yaml | yq w -s - sample.yaml
 ```
-
-### Values starting with a hyphen (or dash)
-The flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags:
-
-```
-yq w -- my.path -3
-```
-
-will output
-```yaml
-my:
-  path: -3
-```
-
-{!snippets/keys_with_dots.md!}

path_parser.go

@@ -1,55 +0,0 @@
-package main
-
-func parsePath(path string) []string {
-	return parsePathAccum([]string{}, path)
-}
-
-func parsePathAccum(paths []string, remaining string) []string {
-	head, tail := nextYamlPath(remaining)
-	if tail == "" {
-		return append(paths, head)
-	}
-	return parsePathAccum(append(paths, head), tail)
-}
-
-func nextYamlPath(path string) (pathElement string, remaining string) {
-	switch path[0] {
-	case '[':
-		// e.g [0].blah.cat -> we need to return "0" and "blah.cat"
-		return search(path[1:], []uint8{']'}, true)
-	case '"':
-		// e.g "a.b".blah.cat -> we need to return "a.b" and "blah.cat"
-		return search(path[1:], []uint8{'"'}, true)
-	default:
-		// e.g "a.blah.cat" -> return "a" and "blah.cat"
-		return search(path[0:], []uint8{'.', '['}, false)
-	}
-}
-
-func search(path string, matchingChars []uint8, skipNext bool) (pathElement string, remaining string) {
-	for i := 0; i < len(path); i++ {
-		var char = path[i]
-		if contains(matchingChars, char) {
-			var remainingStart = i + 1
-			if skipNext {
-				remainingStart = remainingStart + 1
-			} else if !skipNext && char != '.' {
-				remainingStart = i
-			}
-			if remainingStart > len(path) {
-				remainingStart = len(path)
-			}
-			return path[0:i], path[remainingStart:]
-		}
-	}
-	return path, ""
-}
-
-func contains(matchingChars []uint8, candidate uint8) bool {
-	for _, a := range matchingChars {
-		if a == candidate {
-			return true
-		}
-	}
-	return false
-}

path_parser_test.go

@@ -1,43 +0,0 @@
-package main
-
-import (
-	"testing"
-)
-
-var parsePathsTests = []struct {
-	path          string
-	expectedPaths []string
-}{
-	{"a.b", []string{"a", "b"}},
-	{"a.b[0]", []string{"a", "b", "0"}},
-	{"a.b.d[+]", []string{"a", "b", "d", "+"}},
-}
-
-func TestParsePath(t *testing.T) {
-	for _, tt := range parsePathsTests {
-		assertResultComplex(t, tt.expectedPaths, parsePath(tt.path))
-	}
-}
-
-var nextYamlPathTests = []struct {
-	path              string
-	expectedElement   string
-	expectedRemaining string
-}{
-	{"a.b", "a", "b"},
-	{"a", "a", ""},
-	{"a.b.c", "a", "b.c"},
-	{"\"a.b\".c", "a.b", "c"},
-	{"a.\"b.c\".d", "a", "\"b.c\".d"},
-	{"[1].a.d", "1", "a.d"},
-	{"a[0].c", "a", "[0].c"},
-	{"[0]", "0", ""},
-}
-
-func TestNextYamlPath(t *testing.T) {
-	for _, tt := range nextYamlPathTests {
-		var element, remaining = nextYamlPath(tt.path)
-		assertResultWithContext(t, tt.expectedElement, element, tt)
-		assertResultWithContext(t, tt.expectedRemaining, remaining, tt)
-	}
-}

pkg/yqlib/data_navigator.go

@@ -0,0 +1,249 @@
+package yqlib
+
+import (
+	"strconv"
+
+	errors "github.com/pkg/errors"
+	yaml "gopkg.in/yaml.v3"
+)
+
+type DataNavigator interface {
+	Traverse(value *yaml.Node, path []string) error
+}
+
+type navigator struct {
+	navigationStrategy NavigationStrategy
+}
+
+func NewDataNavigator(NavigationStrategy NavigationStrategy) DataNavigator {
+	return &navigator{
+		navigationStrategy: NavigationStrategy,
+	}
+}
+
+func (n *navigator) Traverse(value *yaml.Node, path []string) error {
+	realValue := value
+	emptyArray := make([]interface{}, 0)
+	if realValue.Kind == yaml.DocumentNode {
+		log.Debugf("its a document! returning the first child")
+		return n.doTraverse(value.Content[0], "", path, emptyArray)
+	}
+	return n.doTraverse(value, "", path, emptyArray)
+}
+
+func (n *navigator) doTraverse(value *yaml.Node, head string, tail []string, pathStack []interface{}) error {
+	log.Debug("head %v", head)
+	DebugNode(value)
+	var errorDeepSplatting error
+	if head == "**" && value.Kind != yaml.ScalarNode {
+		errorDeepSplatting = n.recurse(value, head, tail, pathStack)
+		// ignore errors here, we are deep splatting so we may accidently give a string key
+		// to an array sequence
+		if len(tail) > 0 {
+			_ = n.recurse(value, tail[0], tail[1:], pathStack)
+		}
+		return errorDeepSplatting
+	}
+
+	if len(tail) > 0 {
+		log.Debugf("diving into %v", tail[0])
+		DebugNode(value)
+		return n.recurse(value, tail[0], tail[1:], pathStack)
+	}
+	return n.navigationStrategy.Visit(NewNodeContext(value, head, tail, pathStack))
+}
+
+func (n *navigator) getOrReplace(original *yaml.Node, expectedKind yaml.Kind) *yaml.Node {
+	if original.Kind != expectedKind {
+		log.Debug("wanted %v but it was %v, overriding", expectedKind, original.Kind)
+		return &yaml.Node{Kind: expectedKind}
+	}
+	return original
+}
+
+func (n *navigator) recurse(value *yaml.Node, head string, tail []string, pathStack []interface{}) error {
+	log.Debug("recursing, processing %v", head)
+	switch value.Kind {
+	case yaml.MappingNode:
+		log.Debug("its a map with %v entries", len(value.Content)/2)
+		return n.recurseMap(value, head, tail, pathStack)
+	case yaml.SequenceNode:
+		log.Debug("its a sequence of %v things!", len(value.Content))
+		if n.navigationStrategy.GetPathParser().IsPathExpression(head) {
+			return n.splatArray(value, head, tail, pathStack)
+		} else if head == "+" {
+			return n.appendArray(value, head, tail, pathStack)
+		}
+		return n.recurseArray(value, head, tail, pathStack)
+	case yaml.AliasNode:
+		log.Debug("its an alias!")
+		DebugNode(value.Alias)
+		if n.navigationStrategy.FollowAlias(NewNodeContext(value, head, tail, pathStack)) {
+			log.Debug("following the alias")
+			return n.recurse(value.Alias, head, tail, pathStack)
+		}
+		return nil
+	default:
+		return nil
+	}
+}
+
+func (n *navigator) recurseMap(value *yaml.Node, head string, tail []string, pathStack []interface{}) error {
+	traversedEntry := false
+	errorVisiting := n.visitMatchingEntries(value, head, tail, pathStack, func(contents []*yaml.Node, indexInMap int) error {
+		log.Debug("recurseMap: visitMatchingEntries")
+		n.navigationStrategy.DebugVisitedNodes()
+		newPathStack := append(pathStack, contents[indexInMap].Value)
+		log.Debug("appended %v", contents[indexInMap].Value)
+		n.navigationStrategy.DebugVisitedNodes()
+		log.Debug("should I traverse? head: %v, path: %v", head, pathStackToString(newPathStack))
+		DebugNode(value)
+		if n.navigationStrategy.ShouldTraverse(NewNodeContext(contents[indexInMap+1], head, tail, newPathStack), contents[indexInMap].Value) {
+			log.Debug("recurseMap: Going to traverse")
+			traversedEntry = true
+			// contents[indexInMap+1] = n.getOrReplace(contents[indexInMap+1], guessKind(head, tail, contents[indexInMap+1].Kind))
+			errorTraversing := n.doTraverse(contents[indexInMap+1], head, tail, newPathStack)
+			log.Debug("recurseMap: Finished traversing")
+			n.navigationStrategy.DebugVisitedNodes()
+			return errorTraversing
+		} else {
+			log.Debug("nope not traversing")
+		}
+		return nil
+	})
+
+	if errorVisiting != nil {
+		return errorVisiting
+	}
+
+	if traversedEntry || n.navigationStrategy.GetPathParser().IsPathExpression(head) || !n.navigationStrategy.AutoCreateMap(NewNodeContext(value, head, tail, pathStack)) {
+		return nil
+	}
+
+	mapEntryKey := yaml.Node{Value: head, Kind: yaml.ScalarNode}
+	value.Content = append(value.Content, &mapEntryKey)
+	mapEntryValue := yaml.Node{Kind: guessKind(head, tail, 0)}
+	value.Content = append(value.Content, &mapEntryValue)
+	log.Debug("adding new node %v", head)
+	return n.doTraverse(&mapEntryValue, head, tail, append(pathStack, head))
+}
+
+// need to pass the node in, as it may be aliased
+type mapVisitorFn func(contents []*yaml.Node, index int) error
+
+func (n *navigator) visitDirectMatchingEntries(node *yaml.Node, head string, tail []string, pathStack []interface{}, visit mapVisitorFn) error {
+	var contents = node.Content
+	for index := 0; index < len(contents); index = index + 2 {
+		content := contents[index]
+
+		log.Debug("index %v, checking %v, %v", index, content.Value, content.Tag)
+		n.navigationStrategy.DebugVisitedNodes()
+		errorVisiting := visit(contents, index)
+		if errorVisiting != nil {
+			return errorVisiting
+		}
+	}
+	return nil
+}
+
+func (n *navigator) visitMatchingEntries(node *yaml.Node, head string, tail []string, pathStack []interface{}, visit mapVisitorFn) error {
+	var contents = node.Content
+	log.Debug("visitMatchingEntries %v", head)
+	DebugNode(node)
+	// value.Content is a concatenated array of key, value,
+	// so keys are in the even indexes, values in odd.
+	// merge aliases are defined first, but we only want to traverse them
+	// if we don't find a match directly on this node first.
+	errorVisitedDirectEntries := n.visitDirectMatchingEntries(node, head, tail, pathStack, visit)
+
+	if errorVisitedDirectEntries != nil || !n.navigationStrategy.FollowAlias(NewNodeContext(node, head, tail, pathStack)) {
+		return errorVisitedDirectEntries
+	}
+	return n.visitAliases(contents, head, tail, pathStack, visit)
+}
+
+func (n *navigator) visitAliases(contents []*yaml.Node, head string, tail []string, pathStack []interface{}, visit mapVisitorFn) error {
+	// merge aliases are defined first, but we only want to traverse them
+	// if we don't find a match on this node first.
+	// traverse them backwards so that the last alias overrides the preceding.
+	// a node can either be
+	// an alias to one other node (e.g. <<: *blah)
+	// or a sequence of aliases   (e.g. <<: [*blah, *foo])
+	log.Debug("checking for aliases")
+	for index := len(contents) - 2; index >= 0; index = index - 2 {
+
+		if contents[index+1].Kind == yaml.AliasNode {
+			valueNode := contents[index+1]
+			log.Debug("found an alias")
+			DebugNode(contents[index])
+			DebugNode(valueNode)
+
+			errorInAlias := n.visitMatchingEntries(valueNode.Alias, head, tail, pathStack, visit)
+			if errorInAlias != nil {
+				return errorInAlias
+			}
+		} else if contents[index+1].Kind == yaml.SequenceNode {
+			// could be an array of aliases...
+			errorVisitingAliasSeq := n.visitAliasSequence(contents[index+1].Content, head, tail, pathStack, visit)
+			if errorVisitingAliasSeq != nil {
+				return errorVisitingAliasSeq
+			}
+		}
+	}
+	return nil
+}
+
+func (n *navigator) visitAliasSequence(possibleAliasArray []*yaml.Node, head string, tail []string, pathStack []interface{}, visit mapVisitorFn) error {
+	// need to search this backwards too, so that aliases defined last override the preceding.
+	for aliasIndex := len(possibleAliasArray) - 1; aliasIndex >= 0; aliasIndex = aliasIndex - 1 {
+		child := possibleAliasArray[aliasIndex]
+		if child.Kind == yaml.AliasNode {
+			log.Debug("found an alias")
+			DebugNode(child)
+			errorInAlias := n.visitMatchingEntries(child.Alias, head, tail, pathStack, visit)
+			if errorInAlias != nil {
+				return errorInAlias
+			}
+		}
+	}
+	return nil
+}
+
+func (n *navigator) splatArray(value *yaml.Node, head string, tail []string, pathStack []interface{}) error {
+	for index, childValue := range value.Content {
+		log.Debug("processing")
+		DebugNode(childValue)
+		childValue = n.getOrReplace(childValue, guessKind(head, tail, childValue.Kind))
+
+		newPathStack := append(pathStack, index)
+		if n.navigationStrategy.ShouldTraverse(NewNodeContext(childValue, head, tail, newPathStack), childValue.Value) {
+			var err = n.doTraverse(childValue, head, tail, newPathStack)
+			if err != nil {
+				return err
+			}
+		}
+	}
+	return nil
+}
+
+func (n *navigator) appendArray(value *yaml.Node, head string, tail []string, pathStack []interface{}) error {
+	var newNode = yaml.Node{Kind: guessKind(head, tail, 0)}
+	value.Content = append(value.Content, &newNode)
+	log.Debug("appending a new node, %v", value.Content)
+	return n.doTraverse(&newNode, head, tail, append(pathStack, len(value.Content)-1))
+}
+
+func (n *navigator) recurseArray(value *yaml.Node, head string, tail []string, pathStack []interface{}) error {
+	var index, err = strconv.ParseInt(head, 10, 64) // nolint
+	if err != nil {
+		return errors.Wrapf(err, "Error parsing array index '%v' for '%v'", head, pathStackToString(pathStack))
+	}
+
+	for int64(len(value.Content)) <= index {
+		value.Content = append(value.Content, &yaml.Node{Kind: guessKind(head, tail, 0)})
+	}
+
+	value.Content[index] = n.getOrReplace(value.Content[index], guessKind(head, tail, value.Content[index].Kind))
+
+	return n.doTraverse(value.Content[index], head, tail, append(pathStack, index))
+}

pkg/yqlib/data_navigator_test.go

@@ -0,0 +1 @@
+package yqlib

pkg/yqlib/delete_navigation_strategy.go

@@ -0,0 +1,67 @@
+package yqlib
+
+import (
+	"strconv"
+
+	yaml "gopkg.in/yaml.v3"
+)
+
+func DeleteNavigationStrategy(pathElementToDelete string) NavigationStrategy {
+	parser := NewPathParser()
+	return &NavigationStrategyImpl{
+		visitedNodes: []*NodeContext{},
+		pathParser:   parser,
+		followAlias: func(nodeContext NodeContext) bool {
+			return false
+		},
+		autoCreateMap: func(nodeContext NodeContext) bool {
+			return true
+		},
+		visit: func(nodeContext NodeContext) error {
+			node := nodeContext.Node
+			log.Debug("need to find and delete %v in here", pathElementToDelete)
+			DebugNode(node)
+			if node.Kind == yaml.SequenceNode {
+				newContent, errorDeleting := deleteFromArray(node.Content, pathElementToDelete)
+				if errorDeleting != nil {
+					return errorDeleting
+				}
+				node.Content = newContent
+			} else if node.Kind == yaml.MappingNode {
+				node.Content = deleteFromMap(parser, node.Content, nodeContext.PathStack, pathElementToDelete)
+			}
+			return nil
+		},
+	}
+}
+func deleteFromMap(pathParser PathParser, contents []*yaml.Node, pathStack []interface{}, pathElementToDelete string) []*yaml.Node {
+	newContents := make([]*yaml.Node, 0)
+	for index := 0; index < len(contents); index = index + 2 {
+		keyNode := contents[index]
+		valueNode := contents[index+1]
+		if !pathParser.MatchesNextPathElement(NewNodeContext(keyNode, pathElementToDelete, []string{}, pathStack), keyNode.Value) {
+			log.Debug("adding node %v", keyNode.Value)
+			newContents = append(newContents, keyNode, valueNode)
+		} else {
+			log.Debug("skipping node %v", keyNode.Value)
+		}
+	}
+	return newContents
+}
+
+func deleteFromArray(content []*yaml.Node, pathElementToDelete string) ([]*yaml.Node, error) {
+
+	if pathElementToDelete == "*" {
+		return make([]*yaml.Node, 0), nil
+	}
+
+	var index, err = strconv.ParseInt(pathElementToDelete, 10, 64) // nolint
+	if err != nil {
+		return content, err
+	}
+	if index >= int64(len(content)) {
+		log.Debug("index %v is greater than content length %v", index, len(content))
+		return content, nil
+	}
+	return append(content[:index], content[index+1:]...), nil
+}

pkg/yqlib/encoder.go

@@ -0,0 +1,44 @@
+package yqlib
+
+import (
+	"encoding/json"
+	"io"
+
+	yaml "gopkg.in/yaml.v3"
+)
+
+type Encoder interface {
+	Encode(node *yaml.Node) error
+}
+
+type yamlEncoder struct {
+	encoder *yaml.Encoder
+}
+
+func NewYamlEncoder(destination io.Writer) Encoder {
+	var encoder = yaml.NewEncoder(destination)
+	encoder.SetIndent(2)
+	return &yamlEncoder{encoder}
+}
+
+func (ye *yamlEncoder) Encode(node *yaml.Node) error {
+	return ye.encoder.Encode(node)
+}
+
+type jsonEncoder struct {
+	encoder *json.Encoder
+}
+
+func NewJsonEncoder(destination io.Writer) Encoder {
+	var encoder = json.NewEncoder(destination)
+	return &jsonEncoder{encoder}
+}
+
+func (je *jsonEncoder) Encode(node *yaml.Node) error {
+	var dataBucket interface{}
+	errorDecoding := node.Decode(&dataBucket)
+	if errorDecoding != nil {
+		return errorDecoding
+	}
+	return je.encoder.Encode(dataBucket)
+}

pkg/yqlib/filter_matching_node_navigation_strategy.go

@@ -0,0 +1,21 @@
+package yqlib
+
+func FilterMatchingNodesNavigationStrategy(value string) NavigationStrategy {
+	return &NavigationStrategyImpl{
+		visitedNodes: []*NodeContext{},
+		pathParser:   NewPathParser(),
+		followAlias: func(nodeContext NodeContext) bool {
+			return true
+		},
+		autoCreateMap: func(nodeContext NodeContext) bool {
+			return false
+		},
+		visit: func(nodeContext NodeContext) error {
+			return nil
+		},
+		shouldVisitExtraFn: func(nodeContext NodeContext) bool {
+			log.Debug("does %v match %v ? %v", nodeContext.Node.Value, value, nodeContext.Node.Value == value)
+			return matchesString(value, nodeContext.Node.Value)
+		},
+	}
+}

pkg/yqlib/lib.go

@@ -0,0 +1,149 @@
+package yqlib
+
+import (
+	"bytes"
+	"fmt"
+	"strconv"
+	"strings"
+
+	logging "gopkg.in/op/go-logging.v1"
+	yaml "gopkg.in/yaml.v3"
+)
+
+var log = logging.MustGetLogger("yq")
+
+type UpdateCommand struct {
+	Command   string
+	Path      string
+	Value     *yaml.Node
+	Overwrite bool
+}
+
+func DebugNode(value *yaml.Node) {
+	if value == nil {
+		log.Debug("-- node is nil --")
+	} else if log.IsEnabledFor(logging.DEBUG) {
+		buf := new(bytes.Buffer)
+		encoder := yaml.NewEncoder(buf)
+		errorEncoding := encoder.Encode(value)
+		if errorEncoding != nil {
+			log.Error("Error debugging node, %v", errorEncoding.Error())
+		}
+		encoder.Close()
+		log.Debug("Tag: %v", value.Tag)
+		log.Debug("%v", buf.String())
+	}
+}
+
+func pathStackToString(pathStack []interface{}) string {
+	return mergePathStackToString(pathStack, false)
+}
+
+func mergePathStackToString(pathStack []interface{}, appendArrays bool) string {
+	var sb strings.Builder
+	for index, path := range pathStack {
+		switch path.(type) {
+		case int:
+			if appendArrays {
+				sb.WriteString("[+]")
+			} else {
+				sb.WriteString(fmt.Sprintf("[%v]", path))
+			}
+
+		default:
+			sb.WriteString(fmt.Sprintf("%v", path))
+		}
+
+		if index < len(pathStack)-1 {
+			sb.WriteString(".")
+		}
+	}
+	return sb.String()
+}
+
+func guessKind(head string, tail []string, guess yaml.Kind) yaml.Kind {
+	log.Debug("tail %v", tail)
+	if len(tail) == 0 && guess == 0 {
+		log.Debug("end of path, must be a scalar")
+		return yaml.ScalarNode
+	} else if len(tail) == 0 {
+		return guess
+	}
+
+	var _, errorParsingInt = strconv.ParseInt(tail[0], 10, 64)
+	if tail[0] == "+" || errorParsingInt == nil {
+		return yaml.SequenceNode
+	}
+	pathParser := NewPathParser()
+	if (pathParser.IsPathExpression(tail[0]) || head == "**") && (guess == yaml.SequenceNode || guess == yaml.MappingNode) {
+		return guess
+	}
+	if guess == yaml.AliasNode {
+		log.Debug("guess was an alias, okey doke.")
+		return guess
+	}
+	log.Debug("forcing a mapping node")
+	log.Debug("yaml.SequenceNode %v", guess == yaml.SequenceNode)
+	log.Debug("yaml.ScalarNode %v", guess == yaml.ScalarNode)
+	return yaml.MappingNode
+}
+
+type YqLib interface {
+	Get(rootNode *yaml.Node, path string) ([]*NodeContext, error)
+	Update(rootNode *yaml.Node, updateCommand UpdateCommand, autoCreate bool) error
+	New(path string) yaml.Node
+
+	PathStackToString(pathStack []interface{}) string
+	MergePathStackToString(pathStack []interface{}, appendArrays bool) string
+}
+
+type lib struct {
+	parser PathParser
+}
+
+func NewYqLib() YqLib {
+	return &lib{
+		parser: NewPathParser(),
+	}
+}
+
+func (l *lib) Get(rootNode *yaml.Node, path string) ([]*NodeContext, error) {
+	var paths = l.parser.ParsePath(path)
+	navigationStrategy := ReadNavigationStrategy()
+	navigator := NewDataNavigator(navigationStrategy)
+	error := navigator.Traverse(rootNode, paths)
+	return navigationStrategy.GetVisitedNodes(), error
+
+}
+
+func (l *lib) PathStackToString(pathStack []interface{}) string {
+	return pathStackToString(pathStack)
+}
+
+func (l *lib) MergePathStackToString(pathStack []interface{}, appendArrays bool) string {
+	return mergePathStackToString(pathStack, appendArrays)
+}
+
+func (l *lib) New(path string) yaml.Node {
+	var paths = l.parser.ParsePath(path)
+	newNode := yaml.Node{Kind: guessKind("", paths, 0)}
+	return newNode
+}
+
+func (l *lib) Update(rootNode *yaml.Node, updateCommand UpdateCommand, autoCreate bool) error {
+	log.Debugf("%v to %v", updateCommand.Command, updateCommand.Path)
+	switch updateCommand.Command {
+	case "update":
+		var paths = l.parser.ParsePath(updateCommand.Path)
+		navigator := NewDataNavigator(UpdateNavigationStrategy(updateCommand, autoCreate))
+		return navigator.Traverse(rootNode, paths)
+	case "delete":
+		var paths = l.parser.ParsePath(updateCommand.Path)
+		lastBit, newTail := paths[len(paths)-1], paths[:len(paths)-1]
+		navigator := NewDataNavigator(DeleteNavigationStrategy(lastBit))
+		return navigator.Traverse(rootNode, newTail)
+	default:
+		return fmt.Errorf("Unknown command %v", updateCommand.Command)
+	}
+
+}

pkg/yqlib/lib_test.go

@@ -0,0 +1,176 @@
+package yqlib
+
+import (
+	"testing"
+
+	"github.com/mikefarah/yq/v3/test"
+)
+
+func TestLib(t *testing.T) {
+
+	subject := NewYqLib()
+
+	t.Run("PathStackToString_Empty", func(t *testing.T) {
+		emptyArray := make([]interface{}, 0)
+		got := subject.PathStackToString(emptyArray)
+		test.AssertResult(t, ``, got)
+	})
+
+	t.Run("PathStackToString", func(t *testing.T) {
+		array := make([]interface{}, 3)
+		array[0] = "a"
+		array[1] = 0
+		array[2] = "b"
+		got := subject.PathStackToString(array)
+		test.AssertResult(t, `a.[0].b`, got)
+	})
+
+	t.Run("MergePathStackToString", func(t *testing.T) {
+		array := make([]interface{}, 3)
+		array[0] = "a"
+		array[1] = 0
+		array[2] = "b"
+		got := subject.MergePathStackToString(array, true)
+		test.AssertResult(t, `a.[+].b`, got)
+	})
+
+	// 	t.Run("TestReadPath_WithError", func(t *testing.T) {
+	// 		var data = test.ParseData(`
+	// ---
+	// b:
+	//   - c
+	// `)
+
+	// 		_, err := subject.ReadPath(data, "b.[a]")
+	// 		if err == nil {
+	// 			t.Fatal("Expected error due to invalid path")
+	// 		}
+	// 	})
+
+	// 	t.Run("TestWritePath", func(t *testing.T) {
+	// 		var data = test.ParseData(`
+	// ---
+	// b:
+	//   2: c
+	// `)
+
+	// 		got := subject.WritePath(data, "b.3", "a")
+	// 		test.AssertResult(t, `[{b [{2 c} {3 a}]}]`, fmt.Sprintf("%v", got))
+	// 	})
+
+	// 	t.Run("TestPrefixPath", func(t *testing.T) {
+	// 		var data = test.ParseData(`
+	// ---
+	// b:
+	//   2: c
+	// `)
+
+	// 		got := subject.PrefixPath(data, "a.d")
+	// 		test.AssertResult(t, `[{a [{d [{b [{2 c}]}]}]}]`, fmt.Sprintf("%v", got))
+	// 	})
+
+	// 	t.Run("TestDeletePath", func(t *testing.T) {
+	// 		var data = test.ParseData(`
+	// ---
+	// b:
+	//   2: c
+	//   3: a
+	// `)
+
+	// 		got, _ := subject.DeletePath(data, "b.2")
+	// 		test.AssertResult(t, `[{b [{3 a}]}]`, fmt.Sprintf("%v", got))
+	// 	})
+
+	// 	t.Run("TestDeletePath_WithError", func(t *testing.T) {
+	// 		var data = test.ParseData(`
+	// ---
+	// b:
+	//   - c
+	// `)
+
+	// 		_, err := subject.DeletePath(data, "b.[a]")
+	// 		if err == nil {
+	// 			t.Fatal("Expected error due to invalid path")
+	// 		}
+	// 	})
+
+	// 	t.Run("TestMerge", func(t *testing.T) {
+	// 		var dst = test.ParseData(`
+	// ---
+	// a: b
+	// c: d
+	// `)
+	// 		var src = test.ParseData(`
+	// ---
+	// a: 1
+	// b: 2
+	// `)
+
+	// 		var mergedData = make(map[interface{}]interface{})
+	// 		mergedData["root"] = dst
+	// 		var mapDataBucket = make(map[interface{}]interface{})
+	// 		mapDataBucket["root"] = src
+
+	// 		err := subject.Merge(&mergedData, mapDataBucket, false, false)
+	// 		if err != nil {
+	// 			t.Fatal("Unexpected error")
+	// 		}
+	// 		test.AssertResult(t, `[{a b} {c d}]`, fmt.Sprintf("%v", mergedData["root"]))
+	// 	})
+
+	// 	t.Run("TestMerge_WithOverwrite", func(t *testing.T) {
+	// 		var dst = test.ParseData(`
+	// ---
+	// a: b
+	// c: d
+	// `)
+	// 		var src = test.ParseData(`
+	// ---
+	// a: 1
+	// b: 2
+	// `)
+
+	// 		var mergedData = make(map[interface{}]interface{})
+	// 		mergedData["root"] = dst
+	// 		var mapDataBucket = make(map[interface{}]interface{})
+	// 		mapDataBucket["root"] = src
+
+	// 		err := subject.Merge(&mergedData, mapDataBucket, true, false)
+	// 		if err != nil {
+	// 			t.Fatal("Unexpected error")
+	// 		}
+	// 		test.AssertResult(t, `[{a 1} {b 2}]`, fmt.Sprintf("%v", mergedData["root"]))
+	// 	})
+
+	// 	t.Run("TestMerge_WithAppend", func(t *testing.T) {
+	// 		var dst = test.ParseData(`
+	// ---
+	// a: b
+	// c: d
+	// `)
+	// 		var src = test.ParseData(`
+	// ---
+	// a: 1
+	// b: 2
+	// `)
+
+	// 		var mergedData = make(map[interface{}]interface{})
+	// 		mergedData["root"] = dst
+	// 		var mapDataBucket = make(map[interface{}]interface{})
+	// 		mapDataBucket["root"] = src
+
+	// 		err := subject.Merge(&mergedData, mapDataBucket, false, true)
+	// 		if err != nil {
+	// 			t.Fatal("Unexpected error")
+	// 		}
+	// 		test.AssertResult(t, `[{a b} {c d} {a 1} {b 2}]`, fmt.Sprintf("%v", mergedData["root"]))
+	// 	})
+
+	// 	t.Run("TestMerge_WithError", func(t *testing.T) {
+	// 		err := subject.Merge(nil, nil, false, false)
+	// 		if err == nil {
+	// 			t.Fatal("Expected error due to nil")
+	// 		}
+	// 	})
+
+}

pkg/yqlib/navigation_strategy.go

@@ -0,0 +1,152 @@
+package yqlib
+
+import (
+	"fmt"
+
+	yaml "gopkg.in/yaml.v3"
+)
+
+type NodeContext struct {
+	Node      *yaml.Node
+	Head      string
+	Tail      []string
+	PathStack []interface{}
+}
+
+func NewNodeContext(node *yaml.Node, head string, tail []string, pathStack []interface{}) NodeContext {
+	newTail := make([]string, len(tail))
+	copy(newTail, tail)
+
+	newPathStack := make([]interface{}, len(pathStack))
+	copy(newPathStack, pathStack)
+	return NodeContext{
+		Node:      node,
+		Head:      head,
+		Tail:      newTail,
+		PathStack: newPathStack,
+	}
+}
+
+type NavigationStrategy interface {
+	FollowAlias(nodeContext NodeContext) bool
+	AutoCreateMap(nodeContext NodeContext) bool
+	Visit(nodeContext NodeContext) error
+	// node key is the string value of the last element in the path stack
+	// we use it to match against the pathExpression in head.
+	ShouldTraverse(nodeContext NodeContext, nodeKey string) bool
+	GetVisitedNodes() []*NodeContext
+	DebugVisitedNodes()
+	GetPathParser() PathParser
+}
+
+type NavigationStrategyImpl struct {
+	followAlias        func(nodeContext NodeContext) bool
+	autoCreateMap      func(nodeContext NodeContext) bool
+	visit              func(nodeContext NodeContext) error
+	shouldVisitExtraFn func(nodeContext NodeContext) bool
+	visitedNodes       []*NodeContext
+	pathParser         PathParser
+}
+
+func (ns *NavigationStrategyImpl) GetPathParser() PathParser {
+	return ns.pathParser
+}
+
+func (ns *NavigationStrategyImpl) GetVisitedNodes() []*NodeContext {
+	return ns.visitedNodes
+}
+
+func (ns *NavigationStrategyImpl) FollowAlias(nodeContext NodeContext) bool {
+	return ns.followAlias(nodeContext)
+}
+
+func (ns *NavigationStrategyImpl) AutoCreateMap(nodeContext NodeContext) bool {
+	return ns.autoCreateMap(nodeContext)
+}
+
+func (ns *NavigationStrategyImpl) ShouldTraverse(nodeContext NodeContext, nodeKey string) bool {
+	// we should traverse aliases (if enabled), but not visit them :/
+	if len(nodeContext.PathStack) == 0 {
+		return true
+	}
+
+	if ns.alreadyVisited(nodeContext.PathStack) {
+		return false
+	}
+
+	return (nodeKey == "<<" && ns.FollowAlias(nodeContext)) || (nodeKey != "<<" &&
+		ns.pathParser.MatchesNextPathElement(nodeContext, nodeKey))
+}
+
+func (ns *NavigationStrategyImpl) shouldVisit(nodeContext NodeContext) bool {
+	pathStack := nodeContext.PathStack
+	if len(pathStack) == 0 {
+		return true
+	}
+	log.Debug("tail len %v", len(nodeContext.Tail))
+	// SOMETHING HERE!
+
+	if ns.alreadyVisited(pathStack) || len(nodeContext.Tail) != 0 {
+		return false
+	}
+
+	nodeKey := fmt.Sprintf("%v", pathStack[len(pathStack)-1])
+	log.Debug("nodeKey: %v, nodeContext.Head: %v", nodeKey, nodeContext.Head)
+
+	// only visit aliases if its an exact match
+	return ((nodeKey == "<<" && nodeContext.Head == "<<") || (nodeKey != "<<" &&
+		ns.pathParser.MatchesNextPathElement(nodeContext, nodeKey))) && (ns.shouldVisitExtraFn == nil || ns.shouldVisitExtraFn(nodeContext))
+}
+
+func (ns *NavigationStrategyImpl) Visit(nodeContext NodeContext) error {
+	log.Debug("Visit?, %v, %v", nodeContext.Head, pathStackToString(nodeContext.PathStack))
+	DebugNode(nodeContext.Node)
+	if ns.shouldVisit(nodeContext) {
+		log.Debug("yep, visiting")
+		//  pathStack array must be
+		// copied, as append() may sometimes reuse and modify the array
+		ns.visitedNodes = append(ns.visitedNodes, &nodeContext)
+		ns.DebugVisitedNodes()
+		return ns.visit(nodeContext)
+	}
+	log.Debug("nope, skip it")
+	return nil
+}
+
+func (ns *NavigationStrategyImpl) DebugVisitedNodes() {
+	log.Debug("Visited Nodes:")
+	for _, candidate := range ns.visitedNodes {
+		log.Debug(" - %v", pathStackToString(candidate.PathStack))
+	}
+}
+
+func (ns *NavigationStrategyImpl) alreadyVisited(pathStack []interface{}) bool {
+	log.Debug("checking already visited pathStack: %v", pathStackToString(pathStack))
+	for _, candidate := range ns.visitedNodes {
+		candidatePathStack := candidate.PathStack
+		if patchStacksMatch(candidatePathStack, pathStack) {
+			log.Debug("paths match, already seen it")
+			return true
+		}
+
+	}
+	log.Debug("never seen it before!")
+	return false
+}
+
+func patchStacksMatch(path1 []interface{}, path2 []interface{}) bool {
+	log.Debug("checking against path: %v", pathStackToString(path1))
+
+	if len(path1) != len(path2) {
+		return false
+	}
+	for index, p1Value := range path1 {
+
+		p2Value := path2[index]
+		if p1Value != p2Value {
+			return false
+		}
+	}
+	return true
+
+}

pkg/yqlib/path_parser.go

@@ -0,0 +1,134 @@
+package yqlib
+
+import (
+	"strconv"
+	"strings"
+)
+
+type PathParser interface {
+	ParsePath(path string) []string
+	MatchesNextPathElement(nodeContext NodeContext, nodeKey string) bool
+	IsPathExpression(pathElement string) bool
+}
+
+type pathParser struct{}
+
+func NewPathParser() PathParser {
+	return &pathParser{}
+}
+
+func matchesString(expression string, value string) bool {
+	var prefixMatch = strings.TrimSuffix(expression, "*")
+	if prefixMatch != expression {
+		log.Debug("prefix match, %v", strings.HasPrefix(value, prefixMatch))
+		return strings.HasPrefix(value, prefixMatch)
+	}
+	return value == expression
+}
+
+func (p *pathParser) IsPathExpression(pathElement string) bool {
+	return pathElement == "*" || pathElement == "**" || strings.Contains(pathElement, "==")
+}
+
+/**
+ * node: node that we may traverse/visit
+ * head: path element expression to match against
+ * tail: remaining path element expressions
+ * pathStack: stack of actual paths we've matched to get to node
+ * nodeKey: actual value of this nodes 'key' or index.
+ */
+func (p *pathParser) MatchesNextPathElement(nodeContext NodeContext, nodeKey string) bool {
+	head := nodeContext.Head
+	if head == "**" || head == "*" {
+		return true
+	}
+	if strings.Contains(head, "==") {
+		log.Debug("ooh deep recursion time")
+		result := strings.SplitN(head, "==", 2)
+		path := strings.TrimSpace(result[0])
+		value := strings.TrimSpace(result[1])
+		log.Debug("path %v", path)
+		log.Debug("value %v", value)
+		DebugNode(nodeContext.Node)
+		navigationStrategy := FilterMatchingNodesNavigationStrategy(value)
+
+		navigator := NewDataNavigator(navigationStrategy)
+		err := navigator.Traverse(nodeContext.Node, p.ParsePath(path))
+		if err != nil {
+			log.Error(err.Error())
+		}
+		//crap handle error
+		log.Debug("done deep recursing, found %v matches", len(navigationStrategy.GetVisitedNodes()))
+		return len(navigationStrategy.GetVisitedNodes()) > 0
+	}
+
+	if head == "+" {
+		log.Debug("head is +, nodeKey is %v", nodeKey)
+		var _, err = strconv.ParseInt(nodeKey, 10, 64) // nolint
+		if err == nil {
+			return true
+		}
+	}
+
+	return matchesString(head, nodeKey)
+}
+
+func (p *pathParser) ParsePath(path string) []string {
+	if path == "" {
+		return []string{}
+	}
+	return p.parsePathAccum([]string{}, path)
+}
+
+func (p *pathParser) parsePathAccum(paths []string, remaining string) []string {
+	head, tail := p.nextYamlPath(remaining)
+	if tail == "" {
+		return append(paths, head)
+	}
+	return p.parsePathAccum(append(paths, head), tail)
+}
+
+func (p *pathParser) nextYamlPath(path string) (pathElement string, remaining string) {
+	switch path[0] {
+	case '[':
+		// e.g [0].blah.cat -> we need to return "0" and "blah.cat"
+		return p.search(path[1:], []uint8{']'}, true)
+	case '"':
+		// e.g "a.b".blah.cat -> we need to return "a.b" and "blah.cat"
+		return p.search(path[1:], []uint8{'"'}, true)
+	case '(':
+		// e.g "a.b".blah.cat -> we need to return "a.b" and "blah.cat"
+		return p.search(path[1:], []uint8{')'}, true)
+	default:
+		// e.g "a.blah.cat" -> return "a" and "blah.cat"
+		return p.search(path[0:], []uint8{'.', '[', '"', '('}, false)
+	}
+}
+
+func (p *pathParser) search(path string, matchingChars []uint8, skipNext bool) (pathElement string, remaining string) {
+	for i := 0; i < len(path); i++ {
+		var char = path[i]
+		if p.contains(matchingChars, char) {
+			var remainingStart = i + 1
+			if skipNext {
+				remainingStart = remainingStart + 1
+			} else if !skipNext && char != '.' {
+				remainingStart = i
+			}
+			if remainingStart > len(path) {
+				remainingStart = len(path)
+			}
+			return path[0:i], path[remainingStart:]
+		}
+	}
+	return path, ""
+}
+
+func (p *pathParser) contains(matchingChars []uint8, candidate uint8) bool {
+	for _, a := range matchingChars {
+		if a == candidate {
+			return true
+		}
+	}
+	return false
+}

pkg/yqlib/path_parser_test.go

@@ -0,0 +1,78 @@
+package yqlib
+
+import (
+	"testing"
+
+	"github.com/mikefarah/yq/v3/test"
+)
+
+var parser = NewPathParser()
+
+var parsePathsTests = []struct {
+	path          string
+	expectedPaths []string
+}{
+	{"a.b", []string{"a", "b"}},
+	{"a.b.**", []string{"a", "b", "**"}},
+	{"a.b.*", []string{"a", "b", "*"}},
+	{"a.b[0]", []string{"a", "b", "0"}},
+	{"a.b.d[+]", []string{"a", "b", "d", "+"}},
+	{"a", []string{"a"}},
+	{"a.b.c", []string{"a", "b", "c"}},
+	{"\"a.b\".c", []string{"a.b", "c"}},
+	{"a.\"b.c\".d", []string{"a", "b.c", "d"}},
+	{"[1].a.d", []string{"1", "a", "d"}},
+	{"a[0].c", []string{"a", "0", "c"}},
+	{"[0]", []string{"0"}},
+}
+
+func TestPathParserParsePath(t *testing.T) {
+	for _, tt := range parsePathsTests {
+		test.AssertResultComplex(t, tt.expectedPaths, parser.ParsePath(tt.path))
+	}
+}
+
+func TestPathParserMatchesNextPathElementSplat(t *testing.T) {
+	var node = NodeContext{Head: "*"}
+	test.AssertResult(t, true, parser.MatchesNextPathElement(node, ""))
+}
+
+func TestPathParserMatchesNextPathElementDeepSplat(t *testing.T) {
+	var node = NodeContext{Head: "**"}
+	test.AssertResult(t, true, parser.MatchesNextPathElement(node, ""))
+}
+
+func TestPathParserMatchesNextPathElementAppendArrayValid(t *testing.T) {
+	var node = NodeContext{Head: "+"}
+	test.AssertResult(t, true, parser.MatchesNextPathElement(node, "3"))
+}
+
+func TestPathParserMatchesNextPathElementAppendArrayInvalid(t *testing.T) {
+	var node = NodeContext{Head: "+"}
+	test.AssertResult(t, false, parser.MatchesNextPathElement(node, "cat"))
+}
+
+func TestPathParserMatchesNextPathElementPrefixMatchesWhole(t *testing.T) {
+	var node = NodeContext{Head: "cat*"}
+	test.AssertResult(t, true, parser.MatchesNextPathElement(node, "cat"))
+}
+
+func TestPathParserMatchesNextPathElementPrefixMatchesStart(t *testing.T) {
+	var node = NodeContext{Head: "cat*"}
+	test.AssertResult(t, true, parser.MatchesNextPathElement(node, "caterpillar"))
+}
+
+func TestPathParserMatchesNextPathElementPrefixMismatch(t *testing.T) {
+	var node = NodeContext{Head: "cat*"}
+	test.AssertResult(t, false, parser.MatchesNextPathElement(node, "dog"))
+}
+
+func TestPathParserMatchesNextPathElementExactMatch(t *testing.T) {
+	var node = NodeContext{Head: "farahtek"}
+	test.AssertResult(t, true, parser.MatchesNextPathElement(node, "farahtek"))
+}
+
+func TestPathParserMatchesNextPathElementExactMismatch(t *testing.T) {
+	var node = NodeContext{Head: "farahtek"}
+	test.AssertResult(t, false, parser.MatchesNextPathElement(node, "othertek"))
+}

pkg/yqlib/read_navigation_strategy.go

@@ -0,0 +1,17 @@
+package yqlib
+
+func ReadNavigationStrategy() NavigationStrategy {
+	return &NavigationStrategyImpl{
+		visitedNodes: []*NodeContext{},
+		pathParser:   NewPathParser(),
+		followAlias: func(nodeContext NodeContext) bool {
+			return true
+		},
+		autoCreateMap: func(nodeContext NodeContext) bool {
+			return false
+		},
+		visit: func(nodeContext NodeContext) error {
+			return nil
+		},
+	}
+}

pkg/yqlib/update_navigation_strategy.go

@@ -0,0 +1,35 @@
+package yqlib
+
+func UpdateNavigationStrategy(updateCommand UpdateCommand, autoCreate bool) NavigationStrategy {
+	return &NavigationStrategyImpl{
+		visitedNodes: []*NodeContext{},
+		pathParser:   NewPathParser(),
+		followAlias: func(nodeContext NodeContext) bool {
+			return false
+		},
+		autoCreateMap: func(nodeContext NodeContext) bool {
+			return autoCreate
+		},
+		visit: func(nodeContext NodeContext) error {
+			node := nodeContext.Node
+			changesToApply := updateCommand.Value
+			if updateCommand.Overwrite || node.Value == "" {
+				log.Debug("going to update")
+				DebugNode(node)
+				log.Debug("with")
+				DebugNode(changesToApply)
+				node.Value = changesToApply.Value
+				node.Tag = changesToApply.Tag
+				node.Kind = changesToApply.Kind
+				node.Style = changesToApply.Style
+				node.Content = changesToApply.Content
+				node.HeadComment = changesToApply.HeadComment
+				node.LineComment = changesToApply.LineComment
+				node.FootComment = changesToApply.FootComment
+			} else {
+				log.Debug("skipping update as node already has value %v and overwriteFlag is ", node.Value, updateCommand.Overwrite)
+			}
+			return nil
+		},
+	}
+}

pkg/yqlib/value_parser.go

@@ -0,0 +1,47 @@
+package yqlib
+
+import (
+	"strconv"
+
+	yaml "gopkg.in/yaml.v3"
+)
+
+type ValueParser interface {
+	Parse(argument string, customTag string) *yaml.Node
+}
+
+type valueParser struct {
+}
+
+func NewValueParser() ValueParser {
+	return &valueParser{}
+}
+
+func (v *valueParser) Parse(argument string, customTag string) *yaml.Node {
+	var err interface{}
+	var tag = customTag
+
+	if tag == "" {
+		_, err = strconv.ParseBool(argument)
+		if err == nil {
+			tag = "!!bool"
+		}
+		_, err = strconv.ParseFloat(argument, 64)
+		if err == nil {
+			tag = "!!float"
+		}
+		_, err = strconv.ParseInt(argument, 10, 64)
+		if err == nil {
+			tag = "!!int"
+		}
+
+		if argument == "null" {
+			tag = "!!null"
+		}
+		if argument == "[]" {
+			return &yaml.Node{Tag: "!!seq", Kind: yaml.SequenceNode}
+		}
+	}
+	log.Debugf("parsed value '%v', tag: '%v'", argument, tag)
+	return &yaml.Node{Value: argument, Tag: tag, Kind: yaml.ScalarNode}
+}

pkg/yqlib/value_parser_test.go

@@ -0,0 +1,38 @@
+package yqlib
+
+import (
+	"testing"
+
+	"github.com/mikefarah/yq/v3/test"
+	yaml "gopkg.in/yaml.v3"
+)
+
+var parseValueTests = []struct {
+	argument        string
+	customTag       string
+	expectedTag     string
+	testDescription string
+}{
+	{"true", "", "!!bool", "boolean"},
+	{"true", "!!str", "!!str", "boolean forced as string"},
+	{"3.4", "", "!!float", "float"},
+	{"1212121", "", "!!int", "big number"},
+	{"1212121.1", "", "!!float", "big float number"},
+	{"3", "", "!!int", "int"},
+	{"null", "", "!!null", "null"},
+}
+
+func TestValueParserParse(t *testing.T) {
+	for _, tt := range parseValueTests {
+		actual := NewValueParser().Parse(tt.argument, tt.customTag)
+		test.AssertResultWithContext(t, tt.argument, actual.Value, tt.testDescription)
+		test.AssertResultWithContext(t, tt.expectedTag, actual.Tag, tt.testDescription)
+		test.AssertResult(t, yaml.ScalarNode, actual.Kind)
+	}
+}
+
+func TestValueParserParseEmptyArray(t *testing.T) {
+	actual := NewValueParser().Parse("[]", "")
+	test.AssertResult(t, "!!seq", actual.Tag)
+	test.AssertResult(t, yaml.SequenceNode, actual.Kind)
+}

release_instructions.txt

@@ -20,9 +20,14 @@
   
   then use the UI (https://snapcraft.io/yq/release)
 
+- go get
+  - update the readme instructions
 
 - brew
   - brew bump-formula-pr --url=https://github.com/mikefarah/yq/archive/2.2.0.tar.gz yq
+  - if that fails with random ruby errors try:
+    - clearing out the gems rm -rf .gem/ruby/2.3.0
+    - export HOMEBREW_FORCE_VENDOR_RUBY=1
 
 - docker
   - build and push latest and new version tag

scripts/acceptance.sh

@@ -6,7 +6,7 @@ set -e
 X=$(./yq w ./examples/sample.yaml b.c 3 | ./yq r - b.c)
 
 if [[ $X != 3 ]]; then
-  echo "Failed acceptance test: expected 2 but was $X"
+  echo "Failed acceptance test: expected 3 but was $X"
   exit 1
 fi
 echo "acceptance tests passed"

scripts/check.sh

@@ -3,24 +3,14 @@
 set -o errexit
 set -o pipefail
 
-gometalinter \
-  --skip=examples \
-  --tests \
-  --vendor \
-  --disable=aligncheck \
-  --disable=gotype \
-  --disable=goconst \
-  --cyclo-over=20 \
-  --deadline=300s \
-  ./...
+./bin/golangci-lint run
 
-gometalinter \
-  --skip=examples \
-  --tests \
-  --vendor \
-  --disable=aligncheck \
-  --disable=gotype \
-  --disable=goconst \
-  --disable=gocyclo \
-  --deadline=300s \
-  ./...
+# ./bin/golangci-lint \
+#   --tests \
+#   --vendor \
+#   --disable=aligncheck \
+#   --disable=gotype \
+#   --disable=goconst \
+#   --disable=gocyclo \
+#   --deadline=300s \
+#   ./...

scripts/coverage.sh

@@ -2,5 +2,5 @@
 
 set -e
 
-go test -coverprofile=coverage.out
-go tool cover -html=coverage.out -o cover/coverage.html
+go test -coverprofile=coverage.out -v $(go list ./... | grep -v -E 'examples' | grep -v -E 'test')
+go tool cover -html=coverage.out -o coverage.html

scripts/devtools.sh

@@ -1,10 +1,4 @@
 #!/bin/sh
-
-go get -u github.com/alecthomas/gometalinter
-go get -u golang.org/x/tools/cmd/goimports
-go get -u github.com/mitchellh/gox
-go get -u github.com/kardianos/govendor
-go get -u github.com/aktau/github-release
-
-# install all the linters
-gometalinter --install --update
+set -e
+wget -O - -q https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.21.0
+go get golang.org/x/tools/cmd/goimports

scripts/doctools.sh

@@ -1,4 +1,4 @@
-#!/bin.bash
+#!/bin/bash
 
 brew install mkdocs libyaml
 pip3 install markdown-include

scripts/publish.sh

@@ -10,11 +10,13 @@ REPO="yq"
 release() {
     github-release release \
         --user "$OWNER" \
+        --draft \
         --repo "$REPO" \
         --tag "$CURRENT"
 }
 
 upload() {
+    mkdir -p ./build-done
     while IFS=  read -r -d $'\0'; do
         file=$REPLY
         BINARY=$(basename "${file}")
@@ -26,8 +28,9 @@ upload() {
             --tag "$CURRENT" \
             --name "${BINARY}" \
             --file "$file"
+        mv "$file" "./build-done/${BINARY}"
     done < <(find ./build -mindepth 1 -maxdepth 1 -print0)
 }
 
-release
+# release
 upload

scripts/test.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-go test -v $(go list ./... | grep -v -E 'vendor|examples')
+go test -v $(go list ./... | grep -v -E 'examples' | grep -v -E 'test')

scripts/xcompile.sh

@@ -3,7 +3,7 @@
 # This assumes that gonative and gox is installed as per the 'one time setup' instructions
 # at https://github.com/inconshreveable/gonative
 
-gox -ldflags "${LDFLAGS}" -output="build/{{.Dir}}_{{.OS}}_{{.Arch}}"
+gox -ldflags "${LDFLAGS}" -output="build/yq_{{.OS}}_{{.Arch}}"
 # include non-default linux builds too
-gox -ldflags "${LDFLAGS}" -os=linux  -output="build/{{.Dir}}_{{.OS}}_{{.Arch}}"
+gox -ldflags "${LDFLAGS}" -os=linux  -output="build/yq_{{.OS}}_{{.Arch}}"
 

snap/snapcraft.yaml

@@ -1,5 +1,5 @@
 name: yq
-version: '2.2.1'
+version: '3.0.0-beta'
 summary: A lightweight and portable command-line YAML processor
 description: |
   The aim of the project is to be the jq or sed of yaml files.
@@ -19,4 +19,4 @@ parts:
     go-importpath: github.com/mikefarah/yq
     after: [go]
   go:
-    source-tag: go1.9.4
+    source-tag: go1.11

test.yml

@@ -1,2 +1,3 @@
-a: apple
-c: cat
+b:
+  c: thing
+  d: another thing

test/utils.go

@@ -1,4 +1,4 @@
-package main
+package test
 
 import (
 	"bytes"
@@ -9,8 +9,8 @@ import (
 	"strings"
 	"testing"
 
-	yaml "gopkg.in/mikefarah/yaml.v2"
-	"gopkg.in/spf13/cobra.v0"
+	"github.com/spf13/cobra"
+	yaml "gopkg.in/yaml.v3"
 )
 
 type resulter struct {
@@ -19,7 +19,7 @@ type resulter struct {
 	Command *cobra.Command
 }
 
-func runCmd(c *cobra.Command, input string) resulter {
+func RunCmd(c *cobra.Command, input string) resulter {
 	buf := new(bytes.Buffer)
 	c.SetOutput(buf)
 	c.SetArgs(strings.Split(input, " "))
@@ -30,8 +30,8 @@ func runCmd(c *cobra.Command, input string) resulter {
 	return resulter{err, output, c}
 }
 
-func parseData(rawData string) yaml.MapSlice {
-	var parsedData yaml.MapSlice
+func ParseData(rawData string) yaml.Node {
+	var parsedData yaml.Node
 	err := yaml.Unmarshal([]byte(rawData), &parsedData)
 	if err != nil {
 		fmt.Printf("Error parsing yaml: %v\n", err)
@@ -40,21 +40,21 @@ func parseData(rawData string) yaml.MapSlice {
 	return parsedData
 }
 
-func assertResult(t *testing.T, expectedValue interface{}, actualValue interface{}) {
+func AssertResult(t *testing.T, expectedValue interface{}, actualValue interface{}) {
 	t.Helper()
 	if expectedValue != actualValue {
 		t.Error("Expected <", expectedValue, "> but got <", actualValue, ">", fmt.Sprintf("%T", actualValue))
 	}
 }
 
-func assertResultComplex(t *testing.T, expectedValue interface{}, actualValue interface{}) {
+func AssertResultComplex(t *testing.T, expectedValue interface{}, actualValue interface{}) {
 	t.Helper()
 	if !reflect.DeepEqual(expectedValue, actualValue) {
 		t.Error("Expected <", expectedValue, "> but got <", actualValue, ">", fmt.Sprintf("%T", actualValue))
 	}
 }
 
-func assertResultWithContext(t *testing.T, expectedValue interface{}, actualValue interface{}, context interface{}) {
+func AssertResultWithContext(t *testing.T, expectedValue interface{}, actualValue interface{}, context interface{}) {
 	t.Helper()
 	if expectedValue != actualValue {
 		t.Error(context)
@@ -62,7 +62,7 @@ func assertResultWithContext(t *testing.T, expectedValue interface{}, actualValu
 	}
 }
 
-func writeTempYamlFile(content string) string {
+func WriteTempYamlFile(content string) string {
 	tmpfile, _ := ioutil.TempFile("", "testyaml")
 	defer func() {
 		_ = tmpfile.Close()
@@ -72,11 +72,11 @@ func writeTempYamlFile(content string) string {
 	return tmpfile.Name()
 }
 
-func readTempYamlFile(name string) string {
+func ReadTempYamlFile(name string) string {
 	content, _ := ioutil.ReadFile(name)
 	return string(content)
 }
 
-func removeTempYamlFile(name string) {
+func RemoveTempYamlFile(name string) {
 	_ = os.Remove(name)
 }