Fixed help length to prevent horizontal scroll in README

The delete (short option "d") will delete the YAML subtree at the
provided path in the specified file (or STDIN), if it the node exists.

More complex support is currently omitted, for example:

  - specify nodes to delete using an external script
  - deleting common elements from all elements of an array

.gitignore

@@ -29,3 +29,10 @@ yaml
 vendor/*/
 tmp/
 cover/
+yq
+
+# snapcraft
+parts/
+prime/
+.snapcraft/
+yq*.snap

.travis.yml

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

Dockerfile

@@ -0,0 +1,24 @@
+FROM golang:1.9 as builder
+
+WORKDIR /go/src/mikefarah/yq
+
+# cache devtools
+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
+
+# Choose alpine as a base image to make this useful for CI, as many
+# CI tools expect an interactive shell inside the container
+FROM alpine:3.7
+
+COPY --from=builder /go/src/mikefarah/yq/yq /usr/bin/yq
+RUN chmod +x /usr/bin/yq
+
+WORKDIR /workdir

Dockerfile.dev

@@ -1,4 +1,4 @@
-FROM golang:1.7
+FROM golang:1.9
 
 COPY scripts/devtools.sh /opt/devtools.sh
 
@@ -14,6 +14,8 @@ RUN set -ex \
     && apt-get update && apt-get install -y --no-install-recommends \
         $buildDeps \
         python2.7 \
+        python-setuptools \
+        python-wheel \
         python-pip \
     && pip install --upgrade \
         pip \
@@ -25,4 +27,4 @@ RUN set -ex \
     && rm -rf /var/lib/apt/lists/*
 
 ENV CGO_ENABLED 0
-ENV GOPATH /go:/yaml
+ENV GOPATH /go:/yq

Makefile

@@ -11,9 +11,10 @@ help:
 	@echo
 	@echo 'Usage:'
 	@echo '  ## Develop / Test Commands'
-	@echo '    make build           Build yaml binary.'
-	@echo '    make install         Install yaml.'
-	@echo '    make xcompile        Build cross-compiled binaries of yaml.'
+	@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 format          Run code formatter.'
 	@echo '    make check           Run static code analysis (lint).'
@@ -30,10 +31,6 @@ help:
 clean:
 	@rm -rf bin build cover *.out
 
-veryclean: clean
-	rm -rf tmp
-	find vendor/* -maxdepth 0 -ignore_readdir_race -type d -exec rm -rf {} \;
-
 ## prefix before other make targets to run in your local dev environment
 local: | quiet
 	@$(eval DOCKRUN= )
@@ -57,7 +54,7 @@ build: build/dev
 .PHONY: build/dev
 build/dev: test *.go
 	@mkdir -p bin/
-	${DOCKRUN} go build -o bin/yaml --ldflags "$(LDFLAGS)"
+	${DOCKRUN} go build --ldflags "$(LDFLAGS)"
 	${DOCKRUN} bash ./scripts/acceptance.sh
 
 ## Compile the project for multiple OS and Architectures.
@@ -68,6 +65,10 @@ 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
@@ -75,7 +76,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} bash ./scripts/vendor.sh
+	${DOCKRUN} govendor sync
 	@chmod 664 vendor/vendor.json
 
 # ----------------------------------------------

Makefile.variables

@@ -1,4 +1,4 @@
-export PROJECT = yaml
+export PROJECT = yq
 IMPORT_PATH := github.com/mikefarah/${PROJECT}
 
 export GIT_COMMIT = $(shell git rev-parse --short HEAD)

README.md

@@ -1,12 +1,40 @@
-# yaml [![Build Status](https://travis-ci.org/mikefarah/yaml.svg?branch=master)](https://travis-ci.org/mikefarah/yaml)
-yaml is a lightweight and portable command-line YAML processor
+# yq [![Build Status](https://travis-ci.org/mikefarah/yq.svg?branch=master)](https://travis-ci.org/mikefarah/yq)
+a lightweight and portable command-line YAML processor
 
 The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
 
 ## Install
-[Download latest binary](https://github.com/mikefarah/yaml/releases/latest) or alternatively:
+On MacOS:
 ```
-go get github.com/mikefarah/yaml
+brew install yq
+```
+On Ubuntu and other Linux distros supporting `snap` packages:
+```
+snap install yq
+```
+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:
+```
+go get gopkg.in/mikefarah/yq.v2
+```
+
+## Run with Docker
+
+Oneshot use:
+
+```bash
+docker run -v ${PWD}:/workdir mikefarah/yq yq [flags] <command> FILE...
+```
+
+Run commands interactively:
+
+```bash
+docker run -it -v ${PWD}:/workdir mikefarah/yq sh
 ```
 
 ## Features
@@ -22,36 +50,41 @@ go get github.com/mikefarah/yaml
 - Pipe data in by using '-'
 - Merge multiple yaml files where each additional file sets values for missing or null value keys.
 - Merge multiple yaml files with overwrite to support overriding previous values.
+- Supports multiple documents in a single yaml file
 
-## [Usage](http://mikefarah.github.io/yaml/)
+## [Usage](http://mikefarah.github.io/yq/)
 
-Check out the [documentation](http://mikefarah.github.io/yaml/) for more detailed and advanced usage.
+Check out the [documentation](http://mikefarah.github.io/yq/) for more detailed and advanced usage.
 
 ```
 Usage:
-  yaml [flags]
-  yaml [command]
+  yq [flags]
+  yq [command]
 
 Available Commands:
+  delete      yq d [--inplace/-i] [--doc/-d index] sample.yaml a.b.c
   help        Help about any command
-  merge       yaml m [--inplace/-i] [--overwrite/-x] sample.yaml sample2.yaml
-  new         yaml n [--script/-s script_file] a.b.c newValueForC
-  read        yaml r sample.yaml a.b.c
-  write       yaml w [--inplace/-i] [--script/-s script_file] sample.yaml a.b.c newValueForC
+  merge       yq m [--inplace/-i] [--doc/-d index] [--overwrite/-x] sample.yaml sample2.yaml
+  new         yq n [--script/-s script_file] a.b.c newValue
+  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
 
 Flags:
-  -h, --help      help for yaml
-  -j, --tojson    output as json
+  -h, --help      help for yq
   -t, --trim      trim yaml output (default true)
   -v, --verbose   verbose mode
   -V, --version   Print version information and quit
 
-Use "yaml [command] --help" for more information about a command.
+Use "yq [command] --help" for more information about a command.
 ```
 
 ## Contribute
-1. `make vendor` OR run `govendor sync` [link](https://github.com/kardianos/govendor)
+1. `make [local] vendor`
 2. add unit tests
-3. apply changes
-4. `make`
-5. profit
+3. apply changes (use govendor with a preference to [gopkg](https://gopkg.in/) for package dependencies)
+4. `make [local] build`
+5. 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 
+6. profit

commands_test.go

@@ -5,7 +5,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/spf13/cobra"
+	"gopkg.in/spf13/cobra.v0"
 )
 
 func getRootCommand() *cobra.Command {
@@ -73,37 +73,13 @@ func TestRootCmd_TrimShort(t *testing.T) {
 	}
 }
 
-func TestRootCmd_ToJsonLong(t *testing.T) {
-	cmd := getRootCommand()
-	result := runCmd(cmd, "--tojson")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	if !outputToJSON {
-		t.Error("Expected outputToJSON to be true")
-	}
-}
-
-func TestRootCmd_ToJsonShort(t *testing.T) {
-	cmd := getRootCommand()
-	result := runCmd(cmd, "-j")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	if !outputToJSON {
-		t.Error("Expected outputToJSON to be true")
-	}
-}
-
 func TestRootCmd_VersionShort(t *testing.T) {
 	cmd := getRootCommand()
 	result := runCmd(cmd, "-V")
 	if result.Error != nil {
 		t.Error(result.Error)
 	}
-	if !strings.Contains(result.Output, "yaml version") {
+	if !strings.Contains(result.Output, "yq version") {
 		t.Error("expected version message to be printed out, but the message was not found.")
 	}
 }
@@ -114,7 +90,7 @@ func TestRootCmd_VersionLong(t *testing.T) {
 	if result.Error != nil {
 		t.Error(result.Error)
 	}
-	if !strings.Contains(result.Output, "yaml version") {
+	if !strings.Contains(result.Output, "yq version") {
 		t.Error("expected version message to be printed out, but the message was not found.")
 	}
 }
@@ -128,6 +104,15 @@ func TestReadCmd(t *testing.T) {
 	assertResult(t, "2\n", result.Output)
 }
 
+func TestReadMultiCmd(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read -d 1 examples/multiple_docs.yaml another.document")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "here\n", result.Output)
+}
+
 func TestReadCmd_ArrayYaml(t *testing.T) {
 	cmd := getRootCommand()
 	result := runCmd(cmd, "read examples/array.yaml [0].gather_facts")
@@ -293,7 +278,16 @@ func TestReadCmd_NoTrim(t *testing.T) {
 
 func TestReadCmd_ToJson(t *testing.T) {
 	cmd := getRootCommand()
-	result := runCmd(cmd, "-j read examples/sample.yaml b.c")
+	result := runCmd(cmd, "read -j examples/sample.yaml b.c")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "2\n", result.Output)
+}
+
+func TestReadCmd_ToJsonLong(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read --tojson examples/sample.yaml b.c")
 	if result.Error != nil {
 		t.Error(result.Error)
 	}
@@ -334,17 +328,6 @@ func TestNewCmd_Verbose(t *testing.T) {
 	assertResult(t, expectedOutput, result.Output)
 }
 
-func TestNewCmd_ToJson(t *testing.T) {
-	cmd := getRootCommand()
-	result := runCmd(cmd, "-j new b.c 3")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `{"b":{"c":3}}
-`
-	assertResult(t, expectedOutput, result.Output)
-}
-
 func TestWriteCmd(t *testing.T) {
 	content := `b:
   c: 3
@@ -363,6 +346,50 @@ func TestWriteCmd(t *testing.T) {
 	assertResult(t, expectedOutput, result.Output)
 }
 
+func TestWriteMultiCmd(t *testing.T) {
+	content := `b:
+  c: 3
+---
+apples: great
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write %s -d 1 apples ok", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 3
+---
+apples: ok
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestWriteMultiAllCmd(t *testing.T) {
+	content := `b:
+  c: 3
+---
+apples: great
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write %s -d * apples ok", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 3
+apples: ok
+---
+apples: ok`
+	assertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
+}
+
 func TestWriteCmd_EmptyArray(t *testing.T) {
 	content := `b: 3`
 	filename := writeTempYamlFile(content)
@@ -432,7 +459,7 @@ func TestWriteCmd_Inplace(t *testing.T) {
 	gotOutput := readTempYamlFile(filename)
 	expectedOutput := `b:
   c: 7`
-	assertResult(t, expectedOutput, gotOutput)
+	assertResult(t, expectedOutput, strings.Trim(gotOutput, "\n "))
 }
 
 func TestWriteCmd_Append(t *testing.T) {
@@ -454,6 +481,113 @@ func TestWriteCmd_Append(t *testing.T) {
 	assertResult(t, expectedOutput, result.Output)
 }
 
+func TestWriteCmd_AppendEmptyArray(t *testing.T) {
+	content := `a: 2
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write %s b[+] v", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `a: 2
+b:
+- v
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestDeleteYaml(t *testing.T) {
+	content := `a: 2
+b:
+  c: things
+  d: something else
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("delete %s b.c", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := `a: 2
+b:
+  d: something else
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestDeleteYamlArray(t *testing.T) {
+	content := `- 1
+- 2
+- 3	
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("delete %s [1]", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := `- 1
+- 3
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestDeleteYamlMulti(t *testing.T) {
+	content := `apples: great
+---
+- 1
+- 2
+- 3
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("delete -d 1 %s [1]", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := `apples: great
+---
+- 1
+- 3
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestDeleteYamlMultiAllCmd(t *testing.T) {
+	content := `b:
+  c: 3
+apples: great
+---
+apples: great
+something: else
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("delete %s -d * apples", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 3
+---
+something: else`
+	assertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
+}
+
 func TestMergeCmd(t *testing.T) {
 	cmd := getRootCommand()
 	result := runCmd(cmd, "merge examples/data1.yaml examples/data2.yaml")
@@ -470,6 +604,99 @@ c:
 	assertResult(t, expectedOutput, result.Output)
 }
 
+func TestMergeOverwriteCmd(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "merge --overwrite examples/data1.yaml examples/data2.yaml")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `a: other
+b:
+- 1
+- 2
+c:
+  test: 1
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestMergeCmd_Multi(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "merge -d1 examples/multiple_docs_small.yaml examples/data2.yaml")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `a: Easy! as one two three
+---
+a: other
+another:
+  document: here
+c:
+  test: 1
+---
+- 1
+- 2`
+	assertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
+}
+
+func TestMergeYamlMultiAllCmd(t *testing.T) {
+	content := `b:
+  c: 3
+apples: green
+---
+something: else`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	mergeContent := `apples: red
+something: good`
+	mergeFilename := writeTempYamlFile(mergeContent)
+	defer removeTempYamlFile(mergeFilename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("merge -d* %s %s", filename, mergeFilename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `apples: green
+b:
+  c: 3
+something: good
+---
+apples: red
+something: else`
+	assertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
+}
+
+func TestMergeYamlMultiAllOverwriteCmd(t *testing.T) {
+	content := `b:
+  c: 3
+apples: green
+---
+something: else`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	mergeContent := `apples: red
+something: good`
+	mergeFilename := writeTempYamlFile(mergeContent)
+	defer removeTempYamlFile(mergeFilename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("merge --overwrite -d* %s %s", filename, mergeFilename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `apples: red
+b:
+  c: 3
+something: good
+---
+apples: red
+something: good`
+	assertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
+}
+
 func TestMergeCmd_Error(t *testing.T) {
 	cmd := getRootCommand()
 	result := runCmd(cmd, "merge examples/data1.yaml")
@@ -486,7 +713,7 @@ func TestMergeCmd_ErrorUnreadableFile(t *testing.T) {
 	if result.Error == nil {
 		t.Error("Expected command to fail due to unknown file")
 	}
-	expectedOutput := `open fake-unknown: no such file or directory`
+	expectedOutput := `Error updating document at index 0: open fake-unknown: no such file or directory`
 	assertResult(t, expectedOutput, result.Error.Error())
 }
 
@@ -522,5 +749,5 @@ b:
 - 2
 c:
   test: 1`
-	assertResult(t, expectedOutput, gotOutput)
+	assertResult(t, expectedOutput, strings.Trim(gotOutput, "\n "))
 }

data_navigator.go

@@ -2,10 +2,9 @@ package main
 
 import (
 	"fmt"
-	"sort"
 	"strconv"
 
-	"gopkg.in/yaml.v2"
+	yaml "gopkg.in/mikefarah/yaml.v2"
 )
 
 func entryInSlice(context yaml.MapSlice, key interface{}) *yaml.MapItem {
@@ -18,9 +17,7 @@ func entryInSlice(context yaml.MapSlice, key interface{}) *yaml.MapItem {
 	return nil
 }
 
-func writeMap(context interface{}, paths []string, value interface{}) yaml.MapSlice {
-	log.Debugf("writeMap for %v for %v with value %v\n", paths, context, value)
-
+func getMapSlice(context interface{}) yaml.MapSlice {
 	var mapSlice yaml.MapSlice
 	switch context.(type) {
 	case yaml.MapSlice:
@@ -28,6 +25,25 @@ func writeMap(context interface{}, paths []string, value interface{}) yaml.MapSl
 	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
@@ -66,13 +82,7 @@ func updatedChildValue(child interface{}, remainingPaths []string, value interfa
 
 func writeArray(context interface{}, paths []string, value interface{}) []interface{} {
 	log.Debugf("writeArray for %v for %v with value %v\n", paths, context, value)
-	var array []interface{}
-	switch context.(type) {
-	case []interface{}:
-		array = context.([]interface{})
-	default:
-		array = make([]interface{}, 1)
-	}
+	array, _ := getArray(context)
 
 	if len(paths) == 0 {
 		return array
@@ -183,37 +193,92 @@ func calculateValue(value interface{}, tail []string) (interface{}, error) {
 	return value, nil
 }
 
-func mapToMapSlice(data map[interface{}]interface{}) yaml.MapSlice {
-	var mapSlice yaml.MapSlice
+func deleteMap(context interface{}, paths []string) yaml.MapSlice {
+	log.Debugf("deleteMap for %v for %v\n", paths, context)
 
-	for k, v := range data {
-		if mv, ok := v.(map[interface{}]interface{}); ok {
-			v = mapToMapSlice(mv)
-		}
-		item := yaml.MapItem{Key: k, Value: v}
-		mapSlice = append(mapSlice, item)
+	mapSlice := getMapSlice(context)
+
+	if len(paths) == 0 {
+		return mapSlice
 	}
 
-	// because the parsing of the yaml was done via a map the order will be inconsistent
-	// apply order to allow a consistent output
-	// Only available in Go 1.8+
-	// sort.SliceStable(mapSlice, func(i, j int) bool { return mapSlice[i].Key < mapSlice[j].Key })
-	sort.Sort(sortMap{mapSlice})
-	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
 }
 
-type sortMap struct {
-	ms yaml.MapSlice
+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 (m sortMap) Len() int {
-	return len(m.ms)
-}
+func deleteChildValue(child interface{}, remainingPaths []string) interface{} {
+	log.Debugf("deleteChildValue for %v for %v\n", remainingPaths, child)
 
-func (m sortMap) Less(i, j int) bool {
-	return m.ms[i].Key.(string) < m.ms[j].Key.(string)
-}
+	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)
+	}
 
-func (m sortMap) Swap(i, j int) {
-	m.ms[i], m.ms[j] = m.ms[j], m.ms[i]
+	log.Debugf("\tdetected an array, so traversing element with index %d\n", idx)
+	return deleteArray(child, remainingPaths, idx)
 }

data_navigator_test.go

@@ -5,7 +5,7 @@ import (
 	"sort"
 	"testing"
 
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/mikefarah/yaml.v2"
 )
 
 func TestReadMap_simple(t *testing.T) {
@@ -308,3 +308,80 @@ func TestWriteArray_no_paths(t *testing.T) {
 	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

@@ -0,0 +1,12 @@
+yq (2.0-0) bionic; urgency=medium
+
+  * Release 2.0.0
+
+ -- Roberto Mier Escandón <rmescandon@gmail.com>  Wed, 20 Jun 2018 10:29:53 +0200
+
+yq (1.15-0) bionic; urgency=medium
+
+  * Release 1.15
+
+ -- Roberto Mier Escandón <rmescandon@gmail.com>  Wed, 06 Jun 2018 11:32:03 +0200
+

debian/compat

@@ -0,0 +1 @@
+9

debian/control

@@ -0,0 +1,22 @@
+Source: yq
+Section: devel
+Priority: extra
+Maintainer: Roberto Mier Escandón <rmescandon@gmail.com>
+Build-Depends: debhelper (>= 9),
+               dh-golang,
+               golang-1.10-go,
+               rsync
+Standards-Version: 3.9.6
+Homepage: https://github.com/mikefarah/yq.git
+Vcs-Browser: https://github.com/mikefarah/yq.git
+Vcs-Git: https://github.com/mikefarah/yq.git
+
+Package: yq
+Architecture: all
+Built-Using: ${misc:Built-Using}
+Depends: ${shlibs:Depends},
+         ${misc:Depends}
+Description:
+ 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.

debian/copyright

@@ -0,0 +1,7 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: yq
+Source: https://github.com/mikefarah/yq.git
+
+Files: *
+Copyright: 2017 Mike Farah Ltd. All rights reserved
+License: Proprietary

debian/gbp.conf

@@ -0,0 +1,2 @@
+[DEFAULT]
+pristine-tar = True

debian/rules

@@ -0,0 +1,59 @@
+#!/usr/bin/make -f
+#
+# Copyright (C) 2018 Roberto Mier Escandón <rmescandon@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+PROJECT := yq
+OWNER := mikefarah
+REPO := github.com
+GOVERSION := 1.10
+export DH_OPTIONS
+export DH_GOPKG := ${REPO}/${OWNER}/${PROJECT}
+export GOROOT := /usr/lib/go-${GOVERSION}
+export GOPATH := ${CURDIR}/_build
+export GOBIN := ${GOPATH}/bin
+export PATH := ${GOROOT}/bin:${GOBIN}:${PATH}
+BLDPATH := $(shell dpkg-architecture -qDEB_BUILD_GNU_TYPE)
+SRCDIR := ${CURDIR}/_build/src/${DH_GOPKG}
+DESTDIR := ${CURDIR}/debian/${PROJECT}
+BINDIR := /usr/bin
+ASSETSDIR := /usr/share/${PROJECT}
+
+%:
+	dh $@ --buildsystem=golang --with=golang
+
+override_dh_auto_build:
+	mkdir -p ${SRCDIR}
+	mkdir -p ${GOBIN}
+	# copy project to local srcdir to build from there
+	rsync -avz --progress --exclude=obj-${BLDPATH} --exclude=debian . $(SRCDIR)
+	# build go code
+	(cd ${SRCDIR} && go install ./...)
+
+override_dh_auto_test:
+	(cd ${SRCDIR} && go test -v ./...)
+
+override_dh_auto_install:
+	mkdir -p ${DESTDIR}/${BINDIR}
+	mkdir -p ${DESTDIR}/${ASSETSDIR}
+	cp ${CURDIR}/_build/bin/yq ${DESTDIR}/${BINDIR}
+	cp -rf ${SRCDIR}/LICENSE ${DESTDIR}/${ASSETSDIR}
+	cp -rf ${SRCDIR}/README.md ${DESTDIR}/${PLUGINSDIR}
+	chmod a+x ${DESTDIR}/${BINDIR}/yq
+
+override_dh_auto_clean:
+	dh_clean
+	rm -rf ${CURDIR}/obj-${BLDPATH}
+	rm -rf ${CURDIR}/_build

debian/source/format

@@ -0,0 +1 @@
+3.0 (native)

docs/404.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="/assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Yaml</title>
+        <title>Yq</title>
       
     
     
-      <script src="/assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="/assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="/assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="/assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="/" title="Yaml" class="md-header-nav__button md-logo">
+        <a href="/" title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,17 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
           
             
-            Yaml
+              <span class="md-header-nav__topic">
+                Yq
+              </span>
+              <span class="md-header-nav__topic">
+                
+              </span>
+            
           
-        </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">
@@ -92,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -102,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -113,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -122,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -135,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -145,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -160,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -169,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -218,6 +238,18 @@
       
 
 
+  <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
@@ -278,9 +310,9 @@
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -302,10 +334,9 @@
       
     </div>
     
-      <script src="/assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="/assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:""}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:""}})</script>
       
     
     

docs/assets/javascripts/lunr/lunr.da.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(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.da=function(){this.pipeline.reset(),this.pipeline.add(e.da.trimmer,e.da.stopWordFilter,e.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.da.stemmer))},e.da.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.da.trimmer=e.trimmerSupport.generateTrimmer(e.da.wordCharacters),e.Pipeline.registerFunction(e.da.trimmer,"trimmer-da"),e.da.stemmer=function(){var r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){function e(){var e,r=f.cursor+3;if(d=f.limit,0<=r&&r<=f.limit){for(a=r;;){if(e=f.cursor,f.in_grouping(w,97,248)){f.cursor=e;break}if(f.cursor=e,e>=f.limit)return;f.cursor++}for(;!f.out_grouping(w,97,248);){if(f.cursor>=f.limit)return;f.cursor++}(d=f.cursor)<a&&(d=a)}}function n(){var e,r;if(f.cursor>=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(c,32),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del();break;case 2:f.in_grouping_b(p,97,229)&&f.slice_del()}}function t(){var e,r=f.limit-f.cursor;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.find_among_b(l,4)?(f.bra=f.cursor,f.limit_backward=e,f.cursor=f.limit-r,f.cursor>f.limit_backward&&(f.cursor--,f.bra=f.cursor,f.slice_del())):f.limit_backward=e)}function s(){var e,r,i,n=f.limit-f.cursor;if(f.ket=f.cursor,f.eq_s_b(2,"st")&&(f.bra=f.cursor,f.eq_s_b(2,"ig")&&f.slice_del()),f.cursor=f.limit-n,f.cursor>=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(m,5),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del(),i=f.limit-f.cursor,t(),f.cursor=f.limit-i;break;case 2:f.slice_from("løs")}}function o(){var e;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.out_grouping_b(w,97,248)?(f.bra=f.cursor,u=f.slice_to(u),f.limit_backward=e,f.eq_v_b(u)&&f.slice_del()):f.limit_backward=e)}var a,d,u,c=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],l=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],w=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],p=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],f=new i;this.setCurrent=function(e){f.setCurrent(e)},this.getCurrent=function(){return f.getCurrent()},this.stem=function(){var r=f.cursor;return e(),f.limit_backward=r,f.cursor=f.limit,n(),f.cursor=f.limit,t(),f.cursor=f.limit,s(),f.cursor=f.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}});
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.da=function(){this.pipeline.reset(),this.pipeline.add(e.da.trimmer,e.da.stopWordFilter,e.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.da.stemmer))},e.da.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.da.trimmer=e.trimmerSupport.generateTrimmer(e.da.wordCharacters),e.Pipeline.registerFunction(e.da.trimmer,"trimmer-da"),e.da.stemmer=function(){var r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){function e(){var e,r=l.limit-l.cursor;l.cursor>=t&&(e=l.limit_backward,l.limit_backward=t,l.ket=l.cursor,l.find_among_b(a,4)?(l.bra=l.cursor,l.limit_backward=e,l.cursor=l.limit-r,l.cursor>l.limit_backward&&(l.cursor--,l.bra=l.cursor,l.slice_del())):l.limit_backward=e)}var n,t,s,o=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],a=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],d=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],u=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],c=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],l=new i;this.setCurrent=function(e){l.setCurrent(e)},this.getCurrent=function(){return l.getCurrent()},this.stem=function(){var r=l.cursor;return function(){var e,r=l.cursor+3;if(t=l.limit,0<=r&&r<=l.limit){for(n=r;;){if(e=l.cursor,l.in_grouping(u,97,248)){l.cursor=e;break}if(l.cursor=e,e>=l.limit)return;l.cursor++}for(;!l.out_grouping(u,97,248);){if(l.cursor>=l.limit)return;l.cursor++}(t=l.cursor)<n&&(t=n)}}(),l.limit_backward=r,l.cursor=l.limit,function(){var e,r;if(l.cursor>=t&&(r=l.limit_backward,l.limit_backward=t,l.ket=l.cursor,e=l.find_among_b(o,32),l.limit_backward=r,e))switch(l.bra=l.cursor,e){case 1:l.slice_del();break;case 2:l.in_grouping_b(c,97,229)&&l.slice_del()}}(),l.cursor=l.limit,e(),l.cursor=l.limit,function(){var r,i,n,s=l.limit-l.cursor;if(l.ket=l.cursor,l.eq_s_b(2,"st")&&(l.bra=l.cursor,l.eq_s_b(2,"ig")&&l.slice_del()),l.cursor=l.limit-s,l.cursor>=t&&(i=l.limit_backward,l.limit_backward=t,l.ket=l.cursor,r=l.find_among_b(d,5),l.limit_backward=i,r))switch(l.bra=l.cursor,r){case 1:l.slice_del(),n=l.limit-l.cursor,e(),l.cursor=l.limit-n;break;case 2:l.slice_from("løs")}}(),l.cursor=l.limit,function(){var e;l.cursor>=t&&(e=l.limit_backward,l.limit_backward=t,l.ket=l.cursor,l.out_grouping_b(u,97,248)?(l.bra=l.cursor,s=l.slice_to(s),l.limit_backward=e,l.eq_v_b(s)&&l.slice_del()):l.limit_backward=e)}(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}});

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

docs/assets/javascripts/lunr/lunr.no.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(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(){var e,r=w.cursor+3;if(a=w.limit,0<=r||r<=w.limit){for(s=r;;){if(e=w.cursor,w.in_grouping(d,97,248)){w.cursor=e;break}if(e>=w.limit)return;w.cursor=e+1}for(;!w.out_grouping(d,97,248);){if(w.cursor>=w.limit)return;w.cursor++}(a=w.cursor)<s&&(a=s)}}function i(){var e,r,n;if(w.cursor>=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(m,29),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:n=w.limit-w.cursor,w.in_grouping_b(c,98,122)?w.slice_del():(w.cursor=w.limit-n,w.eq_s_b(1,"k")&&w.out_grouping_b(d,97,248)&&w.slice_del());break;case 3:w.slice_from("er")}}function t(){var e,r=w.limit-w.cursor;w.cursor>=a&&(e=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,w.find_among_b(u,2)?(w.bra=w.cursor,w.limit_backward=e,w.cursor=w.limit-r,w.cursor>w.limit_backward&&(w.cursor--,w.bra=w.cursor,w.slice_del())):w.limit_backward=e)}function o(){var e,r;w.cursor>=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,(e=w.find_among_b(l,11))?(w.bra=w.cursor,w.limit_backward=r,1==e&&w.slice_del()):w.limit_backward=r)}var s,a,m=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],u=[new r("dt",-1,-1),new r("vt",-1,-1)],l=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],c=[119,125,149,1],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,i(),w.cursor=w.limit,t(),w.cursor=w.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}});
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){var e,i,t=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],o=[new r("dt",-1,-1),new r("vt",-1,-1)],s=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],a=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],m=[119,125,149,1],u=new n;this.setCurrent=function(e){u.setCurrent(e)},this.getCurrent=function(){return u.getCurrent()},this.stem=function(){var r=u.cursor;return function(){var r,n=u.cursor+3;if(i=u.limit,0<=n||n<=u.limit){for(e=n;;){if(r=u.cursor,u.in_grouping(a,97,248)){u.cursor=r;break}if(r>=u.limit)return;u.cursor=r+1}for(;!u.out_grouping(a,97,248);){if(u.cursor>=u.limit)return;u.cursor++}(i=u.cursor)<e&&(i=e)}}(),u.limit_backward=r,u.cursor=u.limit,function(){var e,r,n;if(u.cursor>=i&&(r=u.limit_backward,u.limit_backward=i,u.ket=u.cursor,e=u.find_among_b(t,29),u.limit_backward=r,e))switch(u.bra=u.cursor,e){case 1:u.slice_del();break;case 2:n=u.limit-u.cursor,u.in_grouping_b(m,98,122)?u.slice_del():(u.cursor=u.limit-n,u.eq_s_b(1,"k")&&u.out_grouping_b(a,97,248)&&u.slice_del());break;case 3:u.slice_from("er")}}(),u.cursor=u.limit,function(){var e,r=u.limit-u.cursor;u.cursor>=i&&(e=u.limit_backward,u.limit_backward=i,u.ket=u.cursor,u.find_among_b(o,2)?(u.bra=u.cursor,u.limit_backward=e,u.cursor=u.limit-r,u.cursor>u.limit_backward&&(u.cursor--,u.bra=u.cursor,u.slice_del())):u.limit_backward=e)}(),u.cursor=u.limit,function(){var e,r;u.cursor>=i&&(r=u.limit_backward,u.limit_backward=i,u.ket=u.cursor,(e=u.find_among_b(s,11))?(u.bra=u.cursor,u.limit_backward=r,1==e&&u.slice_del()):u.limit_backward=r)}(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}});

docs/assets/javascripts/lunr/lunr.sv.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(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){function e(){var e,r=w.cursor+3;if(o=w.limit,0<=r||r<=w.limit){for(a=r;;){if(e=w.cursor,w.in_grouping(l,97,246)){w.cursor=e;break}if(w.cursor=e,w.cursor>=w.limit)return;w.cursor++}for(;!w.out_grouping(l,97,246);){if(w.cursor>=w.limit)return;w.cursor++}(o=w.cursor)<a&&(o=a)}}function t(){var e,r=w.limit_backward;if(w.cursor>=o&&(w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(u,37),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.in_grouping_b(d,98,121)&&w.slice_del()}}function i(){var e=w.limit_backward;w.cursor>=o&&(w.limit_backward=o,w.cursor=w.limit,w.find_among_b(c,7)&&(w.cursor=w.limit,w.ket=w.cursor,w.cursor>w.limit_backward&&(w.bra=--w.cursor,w.slice_del())),w.limit_backward=e)}function s(){var e,r;if(w.cursor>=o){if(r=w.limit_backward,w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(m,5))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.slice_from("lös");break;case 3:w.slice_from("full")}w.limit_backward=r}}var a,o,u=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],c=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],l=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],d=[119,127,149],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,t(),w.cursor=w.limit,i(),w.cursor=w.limit,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}}(),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}});
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){var e,t,i=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],s=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],o=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],u=[119,127,149],c=new n;this.setCurrent=function(e){c.setCurrent(e)},this.getCurrent=function(){return c.getCurrent()},this.stem=function(){var r=c.cursor;return function(){var r,n=c.cursor+3;if(t=c.limit,0<=n||n<=c.limit){for(e=n;;){if(r=c.cursor,c.in_grouping(o,97,246)){c.cursor=r;break}if(c.cursor=r,c.cursor>=c.limit)return;c.cursor++}for(;!c.out_grouping(o,97,246);){if(c.cursor>=c.limit)return;c.cursor++}(t=c.cursor)<e&&(t=e)}}(),c.limit_backward=r,c.cursor=c.limit,function(){var e,r=c.limit_backward;if(c.cursor>=t&&(c.limit_backward=t,c.cursor=c.limit,c.ket=c.cursor,e=c.find_among_b(i,37),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del();break;case 2:c.in_grouping_b(u,98,121)&&c.slice_del()}}(),c.cursor=c.limit,function(){var e=c.limit_backward;c.cursor>=t&&(c.limit_backward=t,c.cursor=c.limit,c.find_among_b(s,7)&&(c.cursor=c.limit,c.ket=c.cursor,c.cursor>c.limit_backward&&(c.bra=--c.cursor,c.slice_del())),c.limit_backward=e)}(),c.cursor=c.limit,function(){var e,r;if(c.cursor>=t){if(r=c.limit_backward,c.limit_backward=t,c.cursor=c.limit,c.ket=c.cursor,e=c.find_among_b(a,5))switch(c.bra=c.cursor,e){case 1:c.slice_del();break;case 2:c.slice_from("lös");break;case 3:c.slice_from("full")}c.limit_backward=r}}(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}}(),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}});

docs/convert/index.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="../assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Convert - Yaml</title>
+        <title>Convert - Yq</title>
       
     
     
-      <script src="../assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href=".." title="Yaml" class="md-header-nav__button md-logo">
+        <a href=".." title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,19 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <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>
             
-            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">
@@ -94,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -104,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -115,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -124,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -137,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -147,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -162,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -171,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -220,6 +238,18 @@
       
 
 
+  <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
@@ -336,18 +366,20 @@
             <article class="md-content__inner md-typeset">
               
                 
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/convert.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
                 
                   <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 be used with any command.</p>
+<p>To convert output to json, use the --tojson (or -j) flag. This can only be used with the read command.</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">yaml r -j sample.yaml b.c
+<pre><code class="bash">yq r -j sample.yaml b.c
 </code></pre>
 
 <p>will output</p>
@@ -361,7 +393,7 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml r sample.json
+<pre><code class="bash">yq r sample.json
 </code></pre>
 
 <p>will output</p>
@@ -427,9 +459,9 @@ b:
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -451,10 +483,9 @@ b:
       
     </div>
     
-      <script src="../assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="../assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:".."}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:".."}})</script>
       
     
     

docs/create/index.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="../assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Create - Yaml</title>
+        <title>Create - Yq</title>
       
     
     
-      <script src="../assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href=".." title="Yaml" class="md-header-nav__button md-logo">
+        <a href=".." title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,19 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <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>
             
-            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">
@@ -94,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -104,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -115,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -124,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -137,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -147,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -162,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -171,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -219,6 +237,18 @@
       
       
 
+
+  <li class="md-nav__item">
+    <a href="../delete/" title="Delete" class="md-nav__link">
+      Delete
+    </a>
+  </li>
+
+    
+      
+      
+      
+
   
 
 
@@ -257,6 +287,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -322,6 +359,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -336,15 +380,17 @@
             <article class="md-content__inner md-typeset">
               
                 
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/create.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
                 
                   <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.</p>
-<pre><code>yaml n &lt;path&gt; &lt;new value&gt;
+                <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;
 </code></pre>
 
 <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">yaml n b.c cat
+<pre><code class="bash">yq n b.c cat
 </code></pre>
 
 <p>will output:</p>
@@ -360,7 +406,7 @@ b.e[0].name: Howdy Partner
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml n -s create_instructions.yaml
+<pre><code class="bash">yq n -s create_instructions.yaml
 </code></pre>
 
 <p>will output:</p>
@@ -371,8 +417,23 @@ b.e[0].name: Howdy Partner
 </code></pre>
 
 <p>You can also pipe the instructions in:</p>
-<pre><code class="bash">cat create_instructions.yaml | yaml n -s -
+<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>
                 
                   
                 
@@ -391,7 +452,7 @@ b.e[0].name: Howdy Partner
     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">
         
-          <a href="../write/" title="Write/Update" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
+          <a href="../delete/" title="Delete" 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>
@@ -400,7 +461,7 @@ b.e[0].name: Howdy Partner
                 <span class="md-footer-nav__direction">
                   Previous
                 </span>
-                Write/Update
+                Delete
               </span>
             </div>
           </a>
@@ -428,9 +489,9 @@ b.e[0].name: Howdy Partner
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -452,10 +513,9 @@ b.e[0].name: Howdy Partner
       
     </div>
     
-      <script src="../assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="../assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:".."}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:".."}})</script>
       
     
     

docs/delete/index.html

@@ -0,0 +1,645 @@
+
+
+
+
+<!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.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-0.17.2, mkdocs-material-2.2.5">
+    
+    
+      
+        <title>Delete - Yq</title>
+      
+    
+    
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
+      
+    
+    
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
+      
+        <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="https://fonts.googleapis.com/icon?family=Material+Icons">
+    
+    
+    
+  </head>
+  
+    <body>
+  
+    <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 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 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.75T360 304zm56-44q0 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.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-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.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.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">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
+    <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">
+                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>
+            
+<div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="search"></label>
+  <div class="md-search__inner">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" required placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <label class="md-icon md-search__icon" for="search"></label>
+      <button type="reset" class="md-icon md-search__icon" data-md-component="reset">&#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">
+    <span class="md-nav__button md-logo">
+      
+        <i class="md-icon"></i>
+      
+    </span>
+    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 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">
+        Delete
+      </label>
+    
+    <a href="./" title="Delete" class="md-nav__link md-nav__link--active">
+      Delete
+    </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="#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">
+  <a href="#deleting-nodes-in-place" title="Deleting nodes in-place" class="md-nav__link">
+    Deleting nodes in-place
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-delete-from-single-document" title="Multiple Documents - delete from single document" class="md-nav__link">
+    Multiple Documents - delete from single document
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-delete-from-all-documents" title="Multiple Documents - delete from all documents" class="md-nav__link">
+    Multiple Documents - delete from all documents
+  </a>
+  
+</li>
+      
+        <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>
+    
+  </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="#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">
+  <a href="#deleting-nodes-in-place" title="Deleting nodes in-place" class="md-nav__link">
+    Deleting nodes in-place
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-delete-from-single-document" title="Multiple Documents - delete from single document" class="md-nav__link">
+    Multiple Documents - delete from single document
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-delete-from-all-documents" title="Multiple Documents - delete from all documents" class="md-nav__link">
+    Multiple Documents - delete from all documents
+  </a>
+  
+</li>
+      
+        <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/delete.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
+                
+                  <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
+</code></pre>
+
+<h3 id="from-stdin">From STDIN<a class="headerlink" href="#from-stdin" title="Permanent link">&para;</a></h3>
+<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:
+  c: 2
+  apples: green
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq d -i sample.yaml b.c
+</code></pre>
+
+<p>will update the sample.yaml file so that the 'c' node is deleted</p>
+<h3 id="multiple-documents-delete-from-single-document">Multiple Documents - delete from single document<a class="headerlink" href="#multiple-documents-delete-from-single-document" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">something: else
+field: leaveMe
+---
+b:
+  c: 2
+field: deleteMe
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w -d1 sample.yaml field
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">something: else
+field: leaveMe
+---
+b:
+  c: 2
+</code></pre>
+
+<h3 id="multiple-documents-delete-from-all-documents">Multiple Documents - delete from all documents<a class="headerlink" href="#multiple-documents-delete-from-all-documents" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">something: else
+field: deleteMe
+---
+b:
+  c: 2
+field: deleteMeToo
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w -d'*' sample.yaml field
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">something: else
+---
+b:
+  c: 2
+</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>
+                
+                  
+                
+              
+              
+                
+              
+            </article>
+          </div>
+        </div>
+      </main>
+      
+        
+<footer class="md-footer">
+  
+    <div class="md-footer-nav">
+      <nav class="md-footer-nav__inner md-grid">
+        
+          <a href="../write/" title="Write/Update" 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>
+                Write/Update
+              </span>
+            </div>
+          </a>
+        
+        
+          <a href="../create/" title="Create" 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>
+                Create
+              </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="http://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="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.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.6cdc17f0.js"></script>
+      
+      <script>app.initialize({version:"0.17.2",url:{base:".."}})</script>
+      
+    
+    
+      
+    
+  </body>
+</html>

docs/index.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="./assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Yaml</title>
+        <title>Yq</title>
       
     
     
-      <script src="./assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="./assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="./assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="./assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="." title="Yaml" class="md-header-nav__button md-logo">
+        <a href="." title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,19 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <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>
             
-            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">
@@ -94,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -104,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -115,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -124,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -137,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -147,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -162,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -171,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -212,15 +230,8 @@
     <ul class="md-nav__list" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#download-latest-binary" title="download latest binary" class="md-nav__link">
-    download latest binary
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#get-the-source" title="get the source" class="md-nav__link">
-    get the source
+  <a href="#install" title="Install" class="md-nav__link">
+    Install
   </a>
   
 </li>
@@ -263,6 +274,18 @@
       
 
 
+  <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
@@ -315,15 +338,8 @@
     <ul class="md-nav__list" data-md-scrollfix>
       
         <li class="md-nav__item">
-  <a href="#download-latest-binary" title="download latest binary" class="md-nav__link">
-    download latest binary
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#get-the-source" title="get the source" class="md-nav__link">
-    get the source
+  <a href="#install" title="Install" class="md-nav__link">
+    Install
   </a>
   
 </li>
@@ -342,17 +358,32 @@
             <article class="md-content__inner md-typeset">
               
                 
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/index.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
                 
-                <h1 id="yaml">yaml<a class="headerlink" href="#yaml" title="Permanent link">&para;</a></h1>
-<p>yaml is a lightweight and portable command-line YAML processor</p>
+                
+                <h1 id="yq">yq<a class="headerlink" href="#yq" title="Permanent link">&para;</a></h1>
+<p>yq is a lightweight and portable command-line YAML processor</p>
 <p>The aim of the project is to be the <a href="https://github.com/stedolan/jq">jq</a> or sed of yaml files.</p>
-<h3 id="download-latest-binary"><a href="https://github.com/mikefarah/yaml/releases/latest">download latest binary</a><a class="headerlink" href="#download-latest-binary" title="Permanent link">&para;</a></h3>
-<h3 id="get-the-source">get the source<a class="headerlink" href="#get-the-source" title="Permanent link">&para;</a></h3>
-<pre><code class="bash">go get github.com/mikefarah/yaml
+<h2 id="install">Install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h2>
+<p>On MacOS:</p>
+<pre><code>brew install yq
 </code></pre>
 
-<p><a href="https://github.com/mikefarah/yaml/zipball/master">.zip</a> or <a href="https://github.com/mikefarah/yaml/tarball/master">tar.gz</a></p>
-<p><a href="https://github.com/mikefarah/yaml">View on GitHub</a></p>
+<p>On Ubuntu and other Linux distros supporting <code>snap</code> packages:</p>
+<pre><code>snap install yq
+</code></pre>
+
+<p>On Ubuntu 16.04 or higher from Debian package:</p>
+<pre><code>sudo add-apt-repository ppa:rmescandon/yq
+sudo apt update
+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
+</code></pre>
+
+<p><a href="https://github.com/mikefarah/yq">View on GitHub</a></p>
                 
                   
                 
@@ -394,9 +425,9 @@
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -418,10 +449,9 @@
       
     </div>
     
-      <script src="./assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="./assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:"."}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:"."}})</script>
       
     
     

docs/merge/index.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="../assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Merge - Yaml</title>
+        <title>Merge - Yq</title>
       
     
     
-      <script src="../assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href=".." title="Yaml" class="md-header-nav__button md-logo">
+        <a href=".." title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,19 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <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>
             
-            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">
@@ -94,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -104,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -115,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -124,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -137,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -147,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -162,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -171,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -220,6 +238,18 @@
       
 
 
+  <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
@@ -295,6 +325,20 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#multiple-documents-merge-into-single-document" title="Multiple Documents - merge into single document" class="md-nav__link">
+    Multiple Documents - merge into single document
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-merge-into-all-documents" title="Multiple Documents - merge into all documents" class="md-nav__link">
+    Multiple Documents - merge into all documents
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -350,6 +394,20 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#multiple-documents-merge-into-single-document" title="Multiple Documents - merge into single document" class="md-nav__link">
+    Multiple Documents - merge into single document
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-merge-into-all-documents" title="Multiple Documents - merge into all documents" class="md-nav__link">
+    Multiple Documents - merge into all documents
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -364,15 +422,16 @@
             <article class="md-content__inner md-typeset">
               
                 
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/merge.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
                 
                   <h1>Merge</h1>
                 
                 <p>Yaml files can be merged using the 'merge' command. Each additional file merged with the first file will
 set values for any key not existing already or where the key has no value.</p>
-<pre><code>yaml m &lt;yaml_file|json_file&gt; &lt;path&gt;...
+<pre><code>yq m &lt;yaml_file&gt; &lt;path&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>
 <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
@@ -386,7 +445,7 @@ c:
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml m data1.yaml data2.yaml
+<pre><code class="bash">yq m data1.yaml data2.yaml
 </code></pre>
 
 <p>will output:</p>
@@ -409,7 +468,7 @@ c:
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml m -i data1.yaml data2.yaml
+<pre><code class="bash">yq m -i data1.yaml data2.yaml
 </code></pre>
 
 <p>will update the data1.yaml file so that the value of 'c' is 'test: 1'.</p>
@@ -426,7 +485,7 @@ c:
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml m -x data1.yaml data2.yaml
+<pre><code class="bash">yq m -x data1.yaml data2.yaml
 </code></pre>
 
 <p>will output:</p>
@@ -451,7 +510,7 @@ d: false
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml m -x data1.yaml data3.yaml
+<pre><code class="bash">yq m -x data1.yaml data3.yaml
 </code></pre>
 
 <p>will output:</p>
@@ -465,6 +524,54 @@ d: false
 
 <p>Notice that 'b' does not result in the merging of the values within an array. The underlying library does not
 currently handle merging values within an array.</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>
+<pre><code class="yaml">something: else
+---
+a: simple
+b: cat
+</code></pre>
+
+<p>and data3.yaml file of:</p>
+<pre><code class="yaml">b: dog
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq m -x -d1 data1.yaml data3.yaml
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">something: else
+---
+a: simple
+b: dog
+</code></pre>
+
+<h3 id="multiple-documents-merge-into-all-documents">Multiple Documents - merge into all documents<a class="headerlink" href="#multiple-documents-merge-into-all-documents" 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>
+<pre><code class="yaml">something: else
+---
+a: simple
+b: cat
+</code></pre>
+
+<p>and data3.yaml file of:</p>
+<pre><code class="yaml">b: dog
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq m -x -d'*' data1.yaml data3.yaml
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">b: dog
+something: else
+---
+a: simple
+b: dog
+</code></pre>
                 
                   
                 
@@ -506,9 +613,9 @@ currently handle merging values within an array.</p>
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -530,10 +637,9 @@ currently handle merging values within an array.</p>
       
     </div>
     
-      <script src="../assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="../assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:".."}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:".."}})</script>
       
     
     

docs/mkdocs/js/require.js

@@ -1,36 +0,0 @@
-/*
- RequireJS 2.1.16 Copyright (c) 2010-2015, The Dojo Foundation All Rights Reserved.
- Available via the MIT or new BSD license.
- see: http://github.com/jrburke/requirejs for details
-*/
-var requirejs,require,define;
-(function(ba){function G(b){return"[object Function]"===K.call(b)}function H(b){return"[object Array]"===K.call(b)}function v(b,c){if(b){var d;for(d=0;d<b.length&&(!b[d]||!c(b[d],d,b));d+=1);}}function T(b,c){if(b){var d;for(d=b.length-1;-1<d&&(!b[d]||!c(b[d],d,b));d-=1);}}function t(b,c){return fa.call(b,c)}function m(b,c){return t(b,c)&&b[c]}function B(b,c){for(var d in b)if(t(b,d)&&c(b[d],d))break}function U(b,c,d,e){c&&B(c,function(c,g){if(d||!t(b,g))e&&"object"===typeof c&&c&&!H(c)&&!G(c)&&!(c instanceof
-RegExp)?(b[g]||(b[g]={}),U(b[g],c,d,e)):b[g]=c});return b}function u(b,c){return function(){return c.apply(b,arguments)}}function ca(b){throw b;}function da(b){if(!b)return b;var c=ba;v(b.split("."),function(b){c=c[b]});return c}function C(b,c,d,e){c=Error(c+"\nhttp://requirejs.org/docs/errors.html#"+b);c.requireType=b;c.requireModules=e;d&&(c.originalError=d);return c}function ga(b){function c(a,k,b){var f,l,c,d,e,g,i,p,k=k&&k.split("/"),h=j.map,n=h&&h["*"];if(a){a=a.split("/");l=a.length-1;j.nodeIdCompat&&
-Q.test(a[l])&&(a[l]=a[l].replace(Q,""));"."===a[0].charAt(0)&&k&&(l=k.slice(0,k.length-1),a=l.concat(a));l=a;for(c=0;c<l.length;c++)if(d=l[c],"."===d)l.splice(c,1),c-=1;else if(".."===d&&!(0===c||1==c&&".."===l[2]||".."===l[c-1])&&0<c)l.splice(c-1,2),c-=2;a=a.join("/")}if(b&&h&&(k||n)){l=a.split("/");c=l.length;a:for(;0<c;c-=1){e=l.slice(0,c).join("/");if(k)for(d=k.length;0<d;d-=1)if(b=m(h,k.slice(0,d).join("/")))if(b=m(b,e)){f=b;g=c;break a}!i&&(n&&m(n,e))&&(i=m(n,e),p=c)}!f&&i&&(f=i,g=p);f&&(l.splice(0,
-g,f),a=l.join("/"))}return(f=m(j.pkgs,a))?f:a}function d(a){z&&v(document.getElementsByTagName("script"),function(k){if(k.getAttribute("data-requiremodule")===a&&k.getAttribute("data-requirecontext")===i.contextName)return k.parentNode.removeChild(k),!0})}function e(a){var k=m(j.paths,a);if(k&&H(k)&&1<k.length)return k.shift(),i.require.undef(a),i.makeRequire(null,{skipMap:!0})([a]),!0}function n(a){var k,c=a?a.indexOf("!"):-1;-1<c&&(k=a.substring(0,c),a=a.substring(c+1,a.length));return[k,a]}function p(a,
-k,b,f){var l,d,e=null,g=k?k.name:null,j=a,p=!0,h="";a||(p=!1,a="_@r"+(K+=1));a=n(a);e=a[0];a=a[1];e&&(e=c(e,g,f),d=m(r,e));a&&(e?h=d&&d.normalize?d.normalize(a,function(a){return c(a,g,f)}):-1===a.indexOf("!")?c(a,g,f):a:(h=c(a,g,f),a=n(h),e=a[0],h=a[1],b=!0,l=i.nameToUrl(h)));b=e&&!d&&!b?"_unnormalized"+(O+=1):"";return{prefix:e,name:h,parentMap:k,unnormalized:!!b,url:l,originalName:j,isDefine:p,id:(e?e+"!"+h:h)+b}}function s(a){var k=a.id,b=m(h,k);b||(b=h[k]=new i.Module(a));return b}function q(a,
-k,b){var f=a.id,c=m(h,f);if(t(r,f)&&(!c||c.defineEmitComplete))"defined"===k&&b(r[f]);else if(c=s(a),c.error&&"error"===k)b(c.error);else c.on(k,b)}function w(a,b){var c=a.requireModules,f=!1;if(b)b(a);else if(v(c,function(b){if(b=m(h,b))b.error=a,b.events.error&&(f=!0,b.emit("error",a))}),!f)g.onError(a)}function x(){R.length&&(ha.apply(A,[A.length,0].concat(R)),R=[])}function y(a){delete h[a];delete V[a]}function F(a,b,c){var f=a.map.id;a.error?a.emit("error",a.error):(b[f]=!0,v(a.depMaps,function(f,
-d){var e=f.id,g=m(h,e);g&&(!a.depMatched[d]&&!c[e])&&(m(b,e)?(a.defineDep(d,r[e]),a.check()):F(g,b,c))}),c[f]=!0)}function D(){var a,b,c=(a=1E3*j.waitSeconds)&&i.startTime+a<(new Date).getTime(),f=[],l=[],g=!1,h=!0;if(!W){W=!0;B(V,function(a){var i=a.map,j=i.id;if(a.enabled&&(i.isDefine||l.push(a),!a.error))if(!a.inited&&c)e(j)?g=b=!0:(f.push(j),d(j));else if(!a.inited&&(a.fetched&&i.isDefine)&&(g=!0,!i.prefix))return h=!1});if(c&&f.length)return a=C("timeout","Load timeout for modules: "+f,null,
-f),a.contextName=i.contextName,w(a);h&&v(l,function(a){F(a,{},{})});if((!c||b)&&g)if((z||ea)&&!X)X=setTimeout(function(){X=0;D()},50);W=!1}}function E(a){t(r,a[0])||s(p(a[0],null,!0)).init(a[1],a[2])}function I(a){var a=a.currentTarget||a.srcElement,b=i.onScriptLoad;a.detachEvent&&!Y?a.detachEvent("onreadystatechange",b):a.removeEventListener("load",b,!1);b=i.onScriptError;(!a.detachEvent||Y)&&a.removeEventListener("error",b,!1);return{node:a,id:a&&a.getAttribute("data-requiremodule")}}function J(){var a;
-for(x();A.length;){a=A.shift();if(null===a[0])return w(C("mismatch","Mismatched anonymous define() module: "+a[a.length-1]));E(a)}}var W,Z,i,L,X,j={waitSeconds:7,baseUrl:"./",paths:{},bundles:{},pkgs:{},shim:{},config:{}},h={},V={},$={},A=[],r={},S={},aa={},K=1,O=1;L={require:function(a){return a.require?a.require:a.require=i.makeRequire(a.map)},exports:function(a){a.usingExports=!0;if(a.map.isDefine)return a.exports?r[a.map.id]=a.exports:a.exports=r[a.map.id]={}},module:function(a){return a.module?
-a.module:a.module={id:a.map.id,uri:a.map.url,config:function(){return m(j.config,a.map.id)||{}},exports:a.exports||(a.exports={})}}};Z=function(a){this.events=m($,a.id)||{};this.map=a;this.shim=m(j.shim,a.id);this.depExports=[];this.depMaps=[];this.depMatched=[];this.pluginMaps={};this.depCount=0};Z.prototype={init:function(a,b,c,f){f=f||{};if(!this.inited){this.factory=b;if(c)this.on("error",c);else this.events.error&&(c=u(this,function(a){this.emit("error",a)}));this.depMaps=a&&a.slice(0);this.errback=
-c;this.inited=!0;this.ignore=f.ignore;f.enabled||this.enabled?this.enable():this.check()}},defineDep:function(a,b){this.depMatched[a]||(this.depMatched[a]=!0,this.depCount-=1,this.depExports[a]=b)},fetch:function(){if(!this.fetched){this.fetched=!0;i.startTime=(new Date).getTime();var a=this.map;if(this.shim)i.makeRequire(this.map,{enableBuildCallback:!0})(this.shim.deps||[],u(this,function(){return a.prefix?this.callPlugin():this.load()}));else return a.prefix?this.callPlugin():this.load()}},load:function(){var a=
-this.map.url;S[a]||(S[a]=!0,i.load(this.map.id,a))},check:function(){if(this.enabled&&!this.enabling){var a,b,c=this.map.id;b=this.depExports;var f=this.exports,l=this.factory;if(this.inited)if(this.error)this.emit("error",this.error);else{if(!this.defining){this.defining=!0;if(1>this.depCount&&!this.defined){if(G(l)){if(this.events.error&&this.map.isDefine||g.onError!==ca)try{f=i.execCb(c,l,b,f)}catch(d){a=d}else f=i.execCb(c,l,b,f);this.map.isDefine&&void 0===f&&((b=this.module)?f=b.exports:this.usingExports&&
-(f=this.exports));if(a)return a.requireMap=this.map,a.requireModules=this.map.isDefine?[this.map.id]:null,a.requireType=this.map.isDefine?"define":"require",w(this.error=a)}else f=l;this.exports=f;if(this.map.isDefine&&!this.ignore&&(r[c]=f,g.onResourceLoad))g.onResourceLoad(i,this.map,this.depMaps);y(c);this.defined=!0}this.defining=!1;this.defined&&!this.defineEmitted&&(this.defineEmitted=!0,this.emit("defined",this.exports),this.defineEmitComplete=!0)}}else this.fetch()}},callPlugin:function(){var a=
-this.map,b=a.id,d=p(a.prefix);this.depMaps.push(d);q(d,"defined",u(this,function(f){var l,d;d=m(aa,this.map.id);var e=this.map.name,P=this.map.parentMap?this.map.parentMap.name:null,n=i.makeRequire(a.parentMap,{enableBuildCallback:!0});if(this.map.unnormalized){if(f.normalize&&(e=f.normalize(e,function(a){return c(a,P,!0)})||""),f=p(a.prefix+"!"+e,this.map.parentMap),q(f,"defined",u(this,function(a){this.init([],function(){return a},null,{enabled:!0,ignore:!0})})),d=m(h,f.id)){this.depMaps.push(f);
-if(this.events.error)d.on("error",u(this,function(a){this.emit("error",a)}));d.enable()}}else d?(this.map.url=i.nameToUrl(d),this.load()):(l=u(this,function(a){this.init([],function(){return a},null,{enabled:!0})}),l.error=u(this,function(a){this.inited=!0;this.error=a;a.requireModules=[b];B(h,function(a){0===a.map.id.indexOf(b+"_unnormalized")&&y(a.map.id)});w(a)}),l.fromText=u(this,function(f,c){var d=a.name,e=p(d),P=M;c&&(f=c);P&&(M=!1);s(e);t(j.config,b)&&(j.config[d]=j.config[b]);try{g.exec(f)}catch(h){return w(C("fromtexteval",
-"fromText eval for "+b+" failed: "+h,h,[b]))}P&&(M=!0);this.depMaps.push(e);i.completeLoad(d);n([d],l)}),f.load(a.name,n,l,j))}));i.enable(d,this);this.pluginMaps[d.id]=d},enable:function(){V[this.map.id]=this;this.enabling=this.enabled=!0;v(this.depMaps,u(this,function(a,b){var c,f;if("string"===typeof a){a=p(a,this.map.isDefine?this.map:this.map.parentMap,!1,!this.skipMap);this.depMaps[b]=a;if(c=m(L,a.id)){this.depExports[b]=c(this);return}this.depCount+=1;q(a,"defined",u(this,function(a){this.defineDep(b,
-a);this.check()}));this.errback?q(a,"error",u(this,this.errback)):this.events.error&&q(a,"error",u(this,function(a){this.emit("error",a)}))}c=a.id;f=h[c];!t(L,c)&&(f&&!f.enabled)&&i.enable(a,this)}));B(this.pluginMaps,u(this,function(a){var b=m(h,a.id);b&&!b.enabled&&i.enable(a,this)}));this.enabling=!1;this.check()},on:function(a,b){var c=this.events[a];c||(c=this.events[a]=[]);c.push(b)},emit:function(a,b){v(this.events[a],function(a){a(b)});"error"===a&&delete this.events[a]}};i={config:j,contextName:b,
-registry:h,defined:r,urlFetched:S,defQueue:A,Module:Z,makeModuleMap:p,nextTick:g.nextTick,onError:w,configure:function(a){a.baseUrl&&"/"!==a.baseUrl.charAt(a.baseUrl.length-1)&&(a.baseUrl+="/");var b=j.shim,c={paths:!0,bundles:!0,config:!0,map:!0};B(a,function(a,b){c[b]?(j[b]||(j[b]={}),U(j[b],a,!0,!0)):j[b]=a});a.bundles&&B(a.bundles,function(a,b){v(a,function(a){a!==b&&(aa[a]=b)})});a.shim&&(B(a.shim,function(a,c){H(a)&&(a={deps:a});if((a.exports||a.init)&&!a.exportsFn)a.exportsFn=i.makeShimExports(a);
-b[c]=a}),j.shim=b);a.packages&&v(a.packages,function(a){var b,a="string"===typeof a?{name:a}:a;b=a.name;a.location&&(j.paths[b]=a.location);j.pkgs[b]=a.name+"/"+(a.main||"main").replace(ia,"").replace(Q,"")});B(h,function(a,b){!a.inited&&!a.map.unnormalized&&(a.map=p(b))});if(a.deps||a.callback)i.require(a.deps||[],a.callback)},makeShimExports:function(a){return function(){var b;a.init&&(b=a.init.apply(ba,arguments));return b||a.exports&&da(a.exports)}},makeRequire:function(a,e){function j(c,d,m){var n,
-q;e.enableBuildCallback&&(d&&G(d))&&(d.__requireJsBuild=!0);if("string"===typeof c){if(G(d))return w(C("requireargs","Invalid require call"),m);if(a&&t(L,c))return L[c](h[a.id]);if(g.get)return g.get(i,c,a,j);n=p(c,a,!1,!0);n=n.id;return!t(r,n)?w(C("notloaded",'Module name "'+n+'" has not been loaded yet for context: '+b+(a?"":". Use require([])"))):r[n]}J();i.nextTick(function(){J();q=s(p(null,a));q.skipMap=e.skipMap;q.init(c,d,m,{enabled:!0});D()});return j}e=e||{};U(j,{isBrowser:z,toUrl:function(b){var d,
-e=b.lastIndexOf("."),k=b.split("/")[0];if(-1!==e&&(!("."===k||".."===k)||1<e))d=b.substring(e,b.length),b=b.substring(0,e);return i.nameToUrl(c(b,a&&a.id,!0),d,!0)},defined:function(b){return t(r,p(b,a,!1,!0).id)},specified:function(b){b=p(b,a,!1,!0).id;return t(r,b)||t(h,b)}});a||(j.undef=function(b){x();var c=p(b,a,!0),e=m(h,b);d(b);delete r[b];delete S[c.url];delete $[b];T(A,function(a,c){a[0]===b&&A.splice(c,1)});e&&(e.events.defined&&($[b]=e.events),y(b))});return j},enable:function(a){m(h,a.id)&&
-s(a).enable()},completeLoad:function(a){var b,c,d=m(j.shim,a)||{},g=d.exports;for(x();A.length;){c=A.shift();if(null===c[0]){c[0]=a;if(b)break;b=!0}else c[0]===a&&(b=!0);E(c)}c=m(h,a);if(!b&&!t(r,a)&&c&&!c.inited){if(j.enforceDefine&&(!g||!da(g)))return e(a)?void 0:w(C("nodefine","No define call for "+a,null,[a]));E([a,d.deps||[],d.exportsFn])}D()},nameToUrl:function(a,b,c){var d,e,h;(d=m(j.pkgs,a))&&(a=d);if(d=m(aa,a))return i.nameToUrl(d,b,c);if(g.jsExtRegExp.test(a))d=a+(b||"");else{d=j.paths;
-a=a.split("/");for(e=a.length;0<e;e-=1)if(h=a.slice(0,e).join("/"),h=m(d,h)){H(h)&&(h=h[0]);a.splice(0,e,h);break}d=a.join("/");d+=b||(/^data\:|\?/.test(d)||c?"":".js");d=("/"===d.charAt(0)||d.match(/^[\w\+\.\-]+:/)?"":j.baseUrl)+d}return j.urlArgs?d+((-1===d.indexOf("?")?"?":"&")+j.urlArgs):d},load:function(a,b){g.load(i,a,b)},execCb:function(a,b,c,d){return b.apply(d,c)},onScriptLoad:function(a){if("load"===a.type||ja.test((a.currentTarget||a.srcElement).readyState))N=null,a=I(a),i.completeLoad(a.id)},
-onScriptError:function(a){var b=I(a);if(!e(b.id))return w(C("scripterror","Script error for: "+b.id,a,[b.id]))}};i.require=i.makeRequire();return i}var g,x,y,D,I,E,N,J,s,O,ka=/(\/\*([\s\S]*?)\*\/|([^:]|^)\/\/(.*)$)/mg,la=/[^.]\s*require\s*\(\s*["']([^'"\s]+)["']\s*\)/g,Q=/\.js$/,ia=/^\.\//;x=Object.prototype;var K=x.toString,fa=x.hasOwnProperty,ha=Array.prototype.splice,z=!!("undefined"!==typeof window&&"undefined"!==typeof navigator&&window.document),ea=!z&&"undefined"!==typeof importScripts,ja=
-z&&"PLAYSTATION 3"===navigator.platform?/^complete$/:/^(complete|loaded)$/,Y="undefined"!==typeof opera&&"[object Opera]"===opera.toString(),F={},q={},R=[],M=!1;if("undefined"===typeof define){if("undefined"!==typeof requirejs){if(G(requirejs))return;q=requirejs;requirejs=void 0}"undefined"!==typeof require&&!G(require)&&(q=require,require=void 0);g=requirejs=function(b,c,d,e){var n,p="_";!H(b)&&"string"!==typeof b&&(n=b,H(c)?(b=c,c=d,d=e):b=[]);n&&n.context&&(p=n.context);(e=m(F,p))||(e=F[p]=g.s.newContext(p));
-n&&e.configure(n);return e.require(b,c,d)};g.config=function(b){return g(b)};g.nextTick="undefined"!==typeof setTimeout?function(b){setTimeout(b,4)}:function(b){b()};require||(require=g);g.version="2.1.16";g.jsExtRegExp=/^\/|:|\?|\.js$/;g.isBrowser=z;x=g.s={contexts:F,newContext:ga};g({});v(["toUrl","undef","defined","specified"],function(b){g[b]=function(){var c=F._;return c.require[b].apply(c,arguments)}});if(z&&(y=x.head=document.getElementsByTagName("head")[0],D=document.getElementsByTagName("base")[0]))y=
-x.head=D.parentNode;g.onError=ca;g.createNode=function(b){var c=b.xhtml?document.createElementNS("http://www.w3.org/1999/xhtml","html:script"):document.createElement("script");c.type=b.scriptType||"text/javascript";c.charset="utf-8";c.async=!0;return c};g.load=function(b,c,d){var e=b&&b.config||{};if(z)return e=g.createNode(e,c,d),e.setAttribute("data-requirecontext",b.contextName),e.setAttribute("data-requiremodule",c),e.attachEvent&&!(e.attachEvent.toString&&0>e.attachEvent.toString().indexOf("[native code"))&&
-!Y?(M=!0,e.attachEvent("onreadystatechange",b.onScriptLoad)):(e.addEventListener("load",b.onScriptLoad,!1),e.addEventListener("error",b.onScriptError,!1)),e.src=d,J=e,D?y.insertBefore(e,D):y.appendChild(e),J=null,e;if(ea)try{importScripts(d),b.completeLoad(c)}catch(m){b.onError(C("importscripts","importScripts failed for "+c+" at "+d,m,[c]))}};z&&!q.skipDataMain&&T(document.getElementsByTagName("script"),function(b){y||(y=b.parentNode);if(I=b.getAttribute("data-main"))return s=I,q.baseUrl||(E=s.split("/"),
-s=E.pop(),O=E.length?E.join("/")+"/":"./",q.baseUrl=O),s=s.replace(Q,""),g.jsExtRegExp.test(s)&&(s=I),q.deps=q.deps?q.deps.concat(s):[s],!0});define=function(b,c,d){var e,g;"string"!==typeof b&&(d=c,c=b,b=null);H(c)||(d=c,c=null);!c&&G(d)&&(c=[],d.length&&(d.toString().replace(ka,"").replace(la,function(b,d){c.push(d)}),c=(1===d.length?["require"]:["require","exports","module"]).concat(c)));if(M){if(!(e=J))N&&"interactive"===N.readyState||T(document.getElementsByTagName("script"),function(b){if("interactive"===
-b.readyState)return N=b}),e=N;e&&(b||(b=e.getAttribute("data-requiremodule")),g=F[e.getAttribute("data-requirecontext")])}(g?g.defQueue:R).push([b,c,d])};define.amd={jQuery:!0};g.exec=function(b){return eval(b)};g(q)}})(this);

docs/mkdocs/js/search-results-template.mustache

@@ -1,4 +0,0 @@
-<article>
-  <h3><a href="{{location}}">{{title}}</a></h3>
-  <p>{{summary}}</p>
-</article>

docs/mkdocs/js/search.js

@@ -1,88 +0,0 @@
-require([
-    base_url + '/mkdocs/js/mustache.min.js',
-    base_url + '/mkdocs/js/lunr.min.js',
-    'text!search-results-template.mustache',
-    'text!../search_index.json',
-], function (Mustache, lunr, results_template, data) {
-   "use strict";
-
-    function getSearchTerm()
-    {
-        var sPageURL = window.location.search.substring(1);
-        var sURLVariables = sPageURL.split('&');
-        for (var i = 0; i < sURLVariables.length; i++)
-        {
-            var sParameterName = sURLVariables[i].split('=');
-            if (sParameterName[0] == 'q')
-            {
-                return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
-            }
-        }
-    }
-
-    var index = lunr(function () {
-        this.field('title', {boost: 10});
-        this.field('text');
-        this.ref('location');
-    });
-
-    data = JSON.parse(data);
-    var documents = {};
-
-    for (var i=0; i < data.docs.length; i++){
-        var doc = data.docs[i];
-        doc.location = base_url + doc.location;
-        index.add(doc);
-        documents[doc.location] = doc;
-    }
-
-    var search = function(){
-
-        var query = document.getElementById('mkdocs-search-query').value;
-        var search_results = document.getElementById("mkdocs-search-results");
-        while (search_results.firstChild) {
-            search_results.removeChild(search_results.firstChild);
-        }
-
-        if(query === ''){
-            return;
-        }
-
-        var results = index.search(query);
-
-        if (results.length > 0){
-            for (var i=0; i < results.length; i++){
-                var result = results[i];
-                doc = documents[result.ref];
-                doc.base_url = base_url;
-                doc.summary = doc.text.substring(0, 200);
-                var html = Mustache.to_html(results_template, doc);
-                search_results.insertAdjacentHTML('beforeend', html);
-            }
-        } else {
-            search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>");
-        }
-
-        if(jQuery){
-            /*
-             * We currently only automatically hide bootstrap models. This
-             * requires jQuery to work.
-             */
-            jQuery('#mkdocs_search_modal a').click(function(){
-                jQuery('#mkdocs_search_modal').modal('hide');
-            });
-        }
-
-    };
-
-    var search_input = document.getElementById('mkdocs-search-query');
-
-    var term = getSearchTerm();
-    if (term){
-        search_input.value = term;
-        search();
-    }
-
-    search_input.addEventListener("keyup", search);
-
-});

docs/mkdocs/js/text.js

@@ -1,390 +0,0 @@
-/**
- * @license RequireJS text 2.0.12 Copyright (c) 2010-2014, The Dojo Foundation All Rights Reserved.
- * Available via the MIT or new BSD license.
- * see: http://github.com/requirejs/text for details
- */
-/*jslint regexp: true */
-/*global require, XMLHttpRequest, ActiveXObject,
-  define, window, process, Packages,
-  java, location, Components, FileUtils */
-
-define(['module'], function (module) {
-    'use strict';
-
-    var text, fs, Cc, Ci, xpcIsWindows,
-        progIds = ['Msxml2.XMLHTTP', 'Microsoft.XMLHTTP', 'Msxml2.XMLHTTP.4.0'],
-        xmlRegExp = /^\s*<\?xml(\s)+version=[\'\"](\d)*.(\d)*[\'\"](\s)*\?>/im,
-        bodyRegExp = /<body[^>]*>\s*([\s\S]+)\s*<\/body>/im,
-        hasLocation = typeof location !== 'undefined' && location.href,
-        defaultProtocol = hasLocation && location.protocol && location.protocol.replace(/\:/, ''),
-        defaultHostName = hasLocation && location.hostname,
-        defaultPort = hasLocation && (location.port || undefined),
-        buildMap = {},
-        masterConfig = (module.config && module.config()) || {};
-
-    text = {
-        version: '2.0.12',
-
-        strip: function (content) {
-            //Strips <?xml ...?> declarations so that external SVG and XML
-            //documents can be added to a document without worry. Also, if the string
-            //is an HTML document, only the part inside the body tag is returned.
-            if (content) {
-                content = content.replace(xmlRegExp, "");
-                var matches = content.match(bodyRegExp);
-                if (matches) {
-                    content = matches[1];
-                }
-            } else {
-                content = "";
-            }
-            return content;
-        },
-
-        jsEscape: function (content) {
-            return content.replace(/(['\\])/g, '\\$1')
-                .replace(/[\f]/g, "\\f")
-                .replace(/[\b]/g, "\\b")
-                .replace(/[\n]/g, "\\n")
-                .replace(/[\t]/g, "\\t")
-                .replace(/[\r]/g, "\\r")
-                .replace(/[\u2028]/g, "\\u2028")
-                .replace(/[\u2029]/g, "\\u2029");
-        },
-
-        createXhr: masterConfig.createXhr || function () {
-            //Would love to dump the ActiveX crap in here. Need IE 6 to die first.
-            var xhr, i, progId;
-            if (typeof XMLHttpRequest !== "undefined") {
-                return new XMLHttpRequest();
-            } else if (typeof ActiveXObject !== "undefined") {
-                for (i = 0; i < 3; i += 1) {
-                    progId = progIds[i];
-                    try {
-                        xhr = new ActiveXObject(progId);
-                    } catch (e) {}
-
-                    if (xhr) {
-                        progIds = [progId];  // so faster next time
-                        break;
-                    }
-                }
-            }
-
-            return xhr;
-        },
-
-        /**
-         * Parses a resource name into its component parts. Resource names
-         * look like: module/name.ext!strip, where the !strip part is
-         * optional.
-         * @param {String} name the resource name
-         * @returns {Object} with properties "moduleName", "ext" and "strip"
-         * where strip is a boolean.
-         */
-        parseName: function (name) {
-            var modName, ext, temp,
-                strip = false,
-                index = name.indexOf("."),
-                isRelative = name.indexOf('./') === 0 ||
-                             name.indexOf('../') === 0;
-
-            if (index !== -1 && (!isRelative || index > 1)) {
-                modName = name.substring(0, index);
-                ext = name.substring(index + 1, name.length);
-            } else {
-                modName = name;
-            }
-
-            temp = ext || modName;
-            index = temp.indexOf("!");
-            if (index !== -1) {
-                //Pull off the strip arg.
-                strip = temp.substring(index + 1) === "strip";
-                temp = temp.substring(0, index);
-                if (ext) {
-                    ext = temp;
-                } else {
-                    modName = temp;
-                }
-            }
-
-            return {
-                moduleName: modName,
-                ext: ext,
-                strip: strip
-            };
-        },
-
-        xdRegExp: /^((\w+)\:)?\/\/([^\/\\]+)/,
-
-        /**
-         * Is an URL on another domain. Only works for browser use, returns
-         * false in non-browser environments. Only used to know if an
-         * optimized .js version of a text resource should be loaded
-         * instead.
-         * @param {String} url
-         * @returns Boolean
-         */
-        useXhr: function (url, protocol, hostname, port) {
-            var uProtocol, uHostName, uPort,
-                match = text.xdRegExp.exec(url);
-            if (!match) {
-                return true;
-            }
-            uProtocol = match[2];
-            uHostName = match[3];
-
-            uHostName = uHostName.split(':');
-            uPort = uHostName[1];
-            uHostName = uHostName[0];
-
-            return (!uProtocol || uProtocol === protocol) &&
-                   (!uHostName || uHostName.toLowerCase() === hostname.toLowerCase()) &&
-                   ((!uPort && !uHostName) || uPort === port);
-        },
-
-        finishLoad: function (name, strip, content, onLoad) {
-            content = strip ? text.strip(content) : content;
-            if (masterConfig.isBuild) {
-                buildMap[name] = content;
-            }
-            onLoad(content);
-        },
-
-        load: function (name, req, onLoad, config) {
-            //Name has format: some.module.filext!strip
-            //The strip part is optional.
-            //if strip is present, then that means only get the string contents
-            //inside a body tag in an HTML string. For XML/SVG content it means
-            //removing the <?xml ...?> declarations so the content can be inserted
-            //into the current doc without problems.
-
-            // Do not bother with the work if a build and text will
-            // not be inlined.
-            if (config && config.isBuild && !config.inlineText) {
-                onLoad();
-                return;
-            }
-
-            masterConfig.isBuild = config && config.isBuild;
-
-            var parsed = text.parseName(name),
-                nonStripName = parsed.moduleName +
-                    (parsed.ext ? '.' + parsed.ext : ''),
-                url = req.toUrl(nonStripName),
-                useXhr = (masterConfig.useXhr) ||
-                         text.useXhr;
-
-            // Do not load if it is an empty: url
-            if (url.indexOf('empty:') === 0) {
-                onLoad();
-                return;
-            }
-
-            //Load the text. Use XHR if possible and in a browser.
-            if (!hasLocation || useXhr(url, defaultProtocol, defaultHostName, defaultPort)) {
-                text.get(url, function (content) {
-                    text.finishLoad(name, parsed.strip, content, onLoad);
-                }, function (err) {
-                    if (onLoad.error) {
-                        onLoad.error(err);
-                    }
-                });
-            } else {
-                //Need to fetch the resource across domains. Assume
-                //the resource has been optimized into a JS module. Fetch
-                //by the module name + extension, but do not include the
-                //!strip part to avoid file system issues.
-                req([nonStripName], function (content) {
-                    text.finishLoad(parsed.moduleName + '.' + parsed.ext,
-                                    parsed.strip, content, onLoad);
-                });
-            }
-        },
-
-        write: function (pluginName, moduleName, write, config) {
-            if (buildMap.hasOwnProperty(moduleName)) {
-                var content = text.jsEscape(buildMap[moduleName]);
-                write.asModule(pluginName + "!" + moduleName,
-                               "define(function () { return '" +
-                                   content +
-                               "';});\n");
-            }
-        },
-
-        writeFile: function (pluginName, moduleName, req, write, config) {
-            var parsed = text.parseName(moduleName),
-                extPart = parsed.ext ? '.' + parsed.ext : '',
-                nonStripName = parsed.moduleName + extPart,
-                //Use a '.js' file name so that it indicates it is a
-                //script that can be loaded across domains.
-                fileName = req.toUrl(parsed.moduleName + extPart) + '.js';
-
-            //Leverage own load() method to load plugin value, but only
-            //write out values that do not have the strip argument,
-            //to avoid any potential issues with ! in file names.
-            text.load(nonStripName, req, function (value) {
-                //Use own write() method to construct full module value.
-                //But need to create shell that translates writeFile's
-                //write() to the right interface.
-                var textWrite = function (contents) {
-                    return write(fileName, contents);
-                };
-                textWrite.asModule = function (moduleName, contents) {
-                    return write.asModule(moduleName, fileName, contents);
-                };
-
-                text.write(pluginName, nonStripName, textWrite, config);
-            }, config);
-        }
-    };
-
-    if (masterConfig.env === 'node' || (!masterConfig.env &&
-            typeof process !== "undefined" &&
-            process.versions &&
-            !!process.versions.node &&
-            !process.versions['node-webkit'])) {
-        //Using special require.nodeRequire, something added by r.js.
-        fs = require.nodeRequire('fs');
-
-        text.get = function (url, callback, errback) {
-            try {
-                var file = fs.readFileSync(url, 'utf8');
-                //Remove BOM (Byte Mark Order) from utf8 files if it is there.
-                if (file.indexOf('\uFEFF') === 0) {
-                    file = file.substring(1);
-                }
-                callback(file);
-            } catch (e) {
-                if (errback) {
-                    errback(e);
-                }
-            }
-        };
-    } else if (masterConfig.env === 'xhr' || (!masterConfig.env &&
-            text.createXhr())) {
-        text.get = function (url, callback, errback, headers) {
-            var xhr = text.createXhr(), header;
-            xhr.open('GET', url, true);
-
-            //Allow plugins direct access to xhr headers
-            if (headers) {
-                for (header in headers) {
-                    if (headers.hasOwnProperty(header)) {
-                        xhr.setRequestHeader(header.toLowerCase(), headers[header]);
-                    }
-                }
-            }
-
-            //Allow overrides specified in config
-            if (masterConfig.onXhr) {
-                masterConfig.onXhr(xhr, url);
-            }
-
-            xhr.onreadystatechange = function (evt) {
-                var status, err;
-                //Do not explicitly handle errors, those should be
-                //visible via console output in the browser.
-                if (xhr.readyState === 4) {
-                    status = xhr.status || 0;
-                    if (status > 399 && status < 600) {
-                        //An http 4xx or 5xx error. Signal an error.
-                        err = new Error(url + ' HTTP status: ' + status);
-                        err.xhr = xhr;
-                        if (errback) {
-                            errback(err);
-                        }
-                    } else {
-                        callback(xhr.responseText);
-                    }
-
-                    if (masterConfig.onXhrComplete) {
-                        masterConfig.onXhrComplete(xhr, url);
-                    }
-                }
-            };
-            xhr.send(null);
-        };
-    } else if (masterConfig.env === 'rhino' || (!masterConfig.env &&
-            typeof Packages !== 'undefined' && typeof java !== 'undefined')) {
-        //Why Java, why is this so awkward?
-        text.get = function (url, callback) {
-            var stringBuffer, line,
-                encoding = "utf-8",
-                file = new java.io.File(url),
-                lineSeparator = java.lang.System.getProperty("line.separator"),
-                input = new java.io.BufferedReader(new java.io.InputStreamReader(new java.io.FileInputStream(file), encoding)),
-                content = '';
-            try {
-                stringBuffer = new java.lang.StringBuffer();
-                line = input.readLine();
-
-                // Byte Order Mark (BOM) - The Unicode Standard, version 3.0, page 324
-                // http://www.unicode.org/faq/utf_bom.html
-
-                // Note that when we use utf-8, the BOM should appear as "EF BB BF", but it doesn't due to this bug in the JDK:
-                // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4508058
-                if (line && line.length() && line.charAt(0) === 0xfeff) {
-                    // Eat the BOM, since we've already found the encoding on this file,
-                    // and we plan to concatenating this buffer with others; the BOM should
-                    // only appear at the top of a file.
-                    line = line.substring(1);
-                }
-
-                if (line !== null) {
-                    stringBuffer.append(line);
-                }
-
-                while ((line = input.readLine()) !== null) {
-                    stringBuffer.append(lineSeparator);
-                    stringBuffer.append(line);
-                }
-                //Make sure we return a JavaScript string and not a Java string.
-                content = String(stringBuffer.toString()); //String
-            } finally {
-                input.close();
-            }
-            callback(content);
-        };
-    } else if (masterConfig.env === 'xpconnect' || (!masterConfig.env &&
-            typeof Components !== 'undefined' && Components.classes &&
-            Components.interfaces)) {
-        //Avert your gaze!
-        Cc = Components.classes;
-        Ci = Components.interfaces;
-        Components.utils['import']('resource://gre/modules/FileUtils.jsm');
-        xpcIsWindows = ('@mozilla.org/windows-registry-key;1' in Cc);
-
-        text.get = function (url, callback) {
-            var inStream, convertStream, fileObj,
-                readData = {};
-
-            if (xpcIsWindows) {
-                url = url.replace(/\//g, '\\');
-            }
-
-            fileObj = new FileUtils.File(url);
-
-            //XPCOM, you so crazy
-            try {
-                inStream = Cc['@mozilla.org/network/file-input-stream;1']
-                           .createInstance(Ci.nsIFileInputStream);
-                inStream.init(fileObj, 1, 0, false);
-
-                convertStream = Cc['@mozilla.org/intl/converter-input-stream;1']
-                                .createInstance(Ci.nsIConverterInputStream);
-                convertStream.init(inStream, "utf-8", inStream.available(),
-                Ci.nsIConverterInputStream.DEFAULT_REPLACEMENT_CHARACTER);
-
-                convertStream.readString(inStream.available(), readData);
-                convertStream.close();
-                inStream.close();
-                callback(readData.value);
-            } catch (e) {
-                throw new Error((fileObj && fileObj.path || '') + ': ' + e);
-            }
-        };
-    }
-    return text;
-});

docs/mkdocs/search_index.json

@@ -1,154 +0,0 @@
-{
-    "docs": [
-        {
-            "location": "/", 
-            "text": "yaml\n\n\nyaml is a lightweight and portable command-line YAML processor\n\n\nThe aim of the project is to be the \njq\n or sed of yaml files.\n\n\ndownload latest binary\n\n\nget the source\n\n\ngo get github.com/mikefarah/yaml\n\n\n\n\n.zip\n or \ntar.gz\n\n\nView on GitHub", 
-            "title": "Install"
-        }, 
-        {
-            "location": "/#yaml", 
-            "text": "yaml is a lightweight and portable command-line YAML processor  The aim of the project is to be the  jq  or sed of yaml files.", 
-            "title": "yaml"
-        }, 
-        {
-            "location": "/#download-latest-binary", 
-            "text": "", 
-            "title": "download latest binary"
-        }, 
-        {
-            "location": "/#get-the-source", 
-            "text": "go get github.com/mikefarah/yaml  .zip  or  tar.gz  View on GitHub", 
-            "title": "get the source"
-        }, 
-        {
-            "location": "/read/", 
-            "text": "yaml r \nyaml_file|json_file\n \npath\n\n\n\n\n\nThis command can take a json file as input too, and will output yaml unless specified to export as json (-j)\n\n\nBasic\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyaml r sample.yaml b.c\n\n\n\n\nwill output the value of '2'.\n\n\nFrom Stdin\n\n\nGiven a sample.yaml file of:\n\n\ncat sample.yaml | yaml r - b.c\n\n\n\n\nwill output the value of '2'.\n\n\nSplat\n\n\nGiven a sample.yaml file of:\n\n\n---\nbob:\n  item1:\n    cats: bananas\n  item2:\n    cats: apples\n\n\n\n\nthen\n\n\nyaml r sample.yaml bob.*.cats\n\n\n\n\nwill output\n\n\n- bananas\n- apples\n\n\n\n\nHandling '.' in the yaml key\n\n\nGiven a sample.yaml file of:\n\n\nb.x:\n  c: 2\n\n\n\n\nthen\n\n\nyaml r sample.yaml \\\nb.x\\\n.c\n\n\n\n\nwill output the value of '2'.\n\n\nArrays\n\n\nYou can give an index to access a specific element:\ne.g.: given a sample file of\n\n\nb:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4\n\n\n\n\nthen\n\n\nyaml r sample.yaml b.e[1].name\n\n\n\n\nwill output 'sam'\n\n\nArray Splat\n\n\ne.g.: given a sample file of\n\n\nb:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4\n\n\n\n\nthen\n\n\nyaml r sample.yaml b.e[*].name\n\n\n\n\nwill output:\n\n\n- fred\n- sam", 
-            "title": "Read"
-        }, 
-        {
-            "location": "/read/#basic", 
-            "text": "Given a sample.yaml file of:  b:\n  c: 2  then  yaml r sample.yaml b.c  will output the value of '2'.", 
-            "title": "Basic"
-        }, 
-        {
-            "location": "/read/#from-stdin", 
-            "text": "Given a sample.yaml file of:  cat sample.yaml | yaml r - b.c  will output the value of '2'.", 
-            "title": "From Stdin"
-        }, 
-        {
-            "location": "/read/#splat", 
-            "text": "Given a sample.yaml file of:  ---\nbob:\n  item1:\n    cats: bananas\n  item2:\n    cats: apples  then  yaml r sample.yaml bob.*.cats  will output  - bananas\n- apples", 
-            "title": "Splat"
-        }, 
-        {
-            "location": "/read/#handling-in-the-yaml-key", 
-            "text": "Given a sample.yaml file of:  b.x:\n  c: 2  then  yaml r sample.yaml \\ b.x\\ .c  will output the value of '2'.", 
-            "title": "Handling '.' in the yaml key"
-        }, 
-        {
-            "location": "/read/#arrays", 
-            "text": "You can give an index to access a specific element:\ne.g.: given a sample file of  b:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4  then  yaml r sample.yaml b.e[1].name  will output 'sam'", 
-            "title": "Arrays"
-        }, 
-        {
-            "location": "/read/#array-splat", 
-            "text": "e.g.: given a sample file of  b:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4  then  yaml r sample.yaml b.e[*].name  will output:  - fred\n- sam", 
-            "title": "Array Splat"
-        }, 
-        {
-            "location": "/write/", 
-            "text": "yaml w \nyaml_file|json_file\n \npath\n \nnew value\n\n\n\n\n\nThis command can take a json file as input too, and will output yaml unless specified to export as json (-j)\n\n\nTo Stdout\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyaml w sample.yaml b.c cat\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n\n\n\n\nFrom STDIN\n\n\ncat sample.yaml | yaml w - b.c blah\n\n\n\n\nAdding new fields\n\n\nAny missing fields in the path will be created on the fly.\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyaml w sample.yaml b.d[0] \nnew thing\n\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n  d:\n    - new thing\n\n\n\n\nAppending value to an array field\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n  d:\n    - new thing\n    - foo thing\n\n\n\n\nthen\n\n\nyaml w sample.yaml b.d[+] \nbar thing\n\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n  d:\n    - new thing\n    - foo thing\n    - bar thing\n\n\n\n\nUpdating files in-place\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyaml w -i sample.yaml b.c cat\n\n\n\n\nwill update the sample.yaml file so that the value of 'c' is cat.\n\n\nUpdating multiple values with a script\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n  e:\n    - name: Billy Bob\n\n\n\n\nand a script update_instructions.yaml of:\n\n\nb.c: 3\nb.e[0].name: Howdy Partner\n\n\n\n\nthen\n\n\nyaml w -s update_instructions.yaml sample.yaml\n\n\n\n\nwill output:\n\n\nb:\n  c: 3\n  e:\n    - name: Howdy Partner\n\n\n\n\nAnd, of course, you can pipe the instructions in using '-':\n\n\ncat update_instructions.yaml | yaml w -s - sample.yaml\n\n\n\n\nValues starting with a hyphen (or dash)\n\n\nThe flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags:\n\n\nyaml w -- my.path -3\n\n\n\n\nwill output\n\n\nmy:\n  path: -3", 
-            "title": "Write/Update"
-        }, 
-        {
-            "location": "/write/#to-stdout", 
-            "text": "Given a sample.yaml file of:  b:\n  c: 2  then  yaml w sample.yaml b.c cat  will output:  b:\n  c: cat", 
-            "title": "To Stdout"
-        }, 
-        {
-            "location": "/write/#from-stdin", 
-            "text": "cat sample.yaml | yaml w - b.c blah", 
-            "title": "From STDIN"
-        }, 
-        {
-            "location": "/write/#adding-new-fields", 
-            "text": "Any missing fields in the path will be created on the fly.  Given a sample.yaml file of:  b:\n  c: 2  then  yaml w sample.yaml b.d[0]  new thing   will output:  b:\n  c: cat\n  d:\n    - new thing", 
-            "title": "Adding new fields"
-        }, 
-        {
-            "location": "/write/#appending-value-to-an-array-field", 
-            "text": "Given a sample.yaml file of:  b:\n  c: 2\n  d:\n    - new thing\n    - foo thing  then  yaml w sample.yaml b.d[+]  bar thing   will output:  b:\n  c: cat\n  d:\n    - new thing\n    - foo thing\n    - bar thing", 
-            "title": "Appending value to an array field"
-        }, 
-        {
-            "location": "/write/#updating-files-in-place", 
-            "text": "Given a sample.yaml file of:  b:\n  c: 2  then  yaml w -i sample.yaml b.c cat  will update the sample.yaml file so that the value of 'c' is cat.", 
-            "title": "Updating files in-place"
-        }, 
-        {
-            "location": "/write/#updating-multiple-values-with-a-script", 
-            "text": "Given a sample.yaml file of:  b:\n  c: 2\n  e:\n    - name: Billy Bob  and a script update_instructions.yaml of:  b.c: 3\nb.e[0].name: Howdy Partner  then  yaml w -s update_instructions.yaml sample.yaml  will output:  b:\n  c: 3\n  e:\n    - name: Howdy Partner  And, of course, you can pipe the instructions in using '-':  cat update_instructions.yaml | yaml w -s - sample.yaml", 
-            "title": "Updating multiple values with a script"
-        }, 
-        {
-            "location": "/write/#values-starting-with-a-hyphen-or-dash", 
-            "text": "The flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags:  yaml w -- my.path -3  will output  my:\n  path: -3", 
-            "title": "Values starting with a hyphen (or dash)"
-        }, 
-        {
-            "location": "/create/", 
-            "text": "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.\n\n\nyaml n \npath\n \nnew value\n\n\n\n\n\nCreating a simple yaml file\n\n\nyaml n b.c cat\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n\n\n\n\nCreating using a create script\n\n\nCreate scripts follow the same format as the update scripts.\n\n\nGiven a script create_instructions.yaml of:\n\n\nb.c: 3\nb.e[0].name: Howdy Partner\n\n\n\n\nthen\n\n\nyaml n -s create_instructions.yaml\n\n\n\n\nwill output:\n\n\nb:\n  c: 3\n  e:\n    - name: Howdy Partner\n\n\n\n\nYou can also pipe the instructions in:\n\n\ncat create_instructions.yaml | yaml n -s -", 
-            "title": "Create"
-        }, 
-        {
-            "location": "/create/#creating-a-simple-yaml-file", 
-            "text": "yaml n b.c cat  will output:  b:\n  c: cat", 
-            "title": "Creating a simple yaml file"
-        }, 
-        {
-            "location": "/create/#creating-using-a-create-script", 
-            "text": "Create scripts follow the same format as the update scripts.  Given a script create_instructions.yaml of:  b.c: 3\nb.e[0].name: Howdy Partner  then  yaml n -s create_instructions.yaml  will output:  b:\n  c: 3\n  e:\n    - name: Howdy Partner  You can also pipe the instructions in:  cat create_instructions.yaml | yaml n -s -", 
-            "title": "Creating using a create script"
-        }, 
-        {
-            "location": "/convert/", 
-            "text": "Yaml to Json\n\n\nTo convert output to json, use the --tojson (or -j) flag. This can be used with any command.\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyaml r -j sample.yaml b.c\n\n\n\n\nwill output\n\n\n{\nb\n:{\nc\n:2}}\n\n\n\n\nJson to Yaml\n\n\nTo read in json, just pass in a json file instead of yaml, it will just work :)\n\n\ne.g given a json file\n\n\n{\na\n:\nEasy! as one two three\n,\nb\n:{\nc\n:2,\nd\n:[3,4]}}\n\n\n\n\nthen\n\n\nyaml r sample.json\n\n\n\n\nwill output\n\n\na: Easy! as one two three\nb:\n  c: 2\n  d:\n  - 3\n  - 4", 
-            "title": "Convert"
-        }, 
-        {
-            "location": "/convert/#yaml-to-json", 
-            "text": "To convert output to json, use the --tojson (or -j) flag. This can be used with any command.  Given a sample.yaml file of:  b:\n  c: 2  then  yaml r -j sample.yaml b.c  will output  { b :{ c :2}}", 
-            "title": "Yaml to Json"
-        }, 
-        {
-            "location": "/convert/#json-to-yaml", 
-            "text": "To read in json, just pass in a json file instead of yaml, it will just work :)  e.g given a json file  { a : Easy! as one two three , b :{ c :2, d :[3,4]}}  then  yaml r sample.json  will output  a: Easy! as one two three\nb:\n  c: 2\n  d:\n  - 3\n  - 4", 
-            "title": "Json to Yaml"
-        }, 
-        {
-            "location": "/merge/", 
-            "text": "Yaml files can be merged using the 'merge' command. Each additional file merged with the first file will\nset values for any key not existing already or where the key has no value.\n\n\nyaml m \nyaml_file|json_file\n \npath\n...\n\n\n\n\nThis command can take a json file as input too, and will output yaml unless specified to export as json (-j)\n\n\nTo Stdout\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data2.yaml file of:\n\n\na: other\nc:\n  test: 1\n\n\n\n\nthen\n\n\nyaml m data1.yaml data2.yaml\n\n\n\n\nwill output:\n\n\na: simple\nb: [1, 2]\nc:\n  test: 1\n\n\n\n\nUpdating files in-place\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data2.yaml file of:\n\n\na: other\nc:\n  test: 1\n\n\n\n\nthen\n\n\nyaml m -i data1.yaml data2.yaml\n\n\n\n\nwill update the data1.yaml file so that the value of 'c' is 'test: 1'.\n\n\nOverwrite values\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data2.yaml file of:\n\n\na: other\nc:\n  test: 1\n\n\n\n\nthen\n\n\nyaml m -x data1.yaml data2.yaml\n\n\n\n\nwill output:\n\n\na: other\nb: [1, 2]\nc:\n  test: 1\n\n\n\n\nOverwrite values with arrays\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data3.yaml file of:\n\n\nb: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false\n\n\n\n\nthen\n\n\nyaml m -x data1.yaml data3.yaml\n\n\n\n\nwill output:\n\n\na: simple\nb: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false\n\n\n\n\nNotice that 'b' does not result in the merging of the values within an array. The underlying library does not\ncurrently handle merging values within an array.", 
-            "title": "Merge"
-        }, 
-        {
-            "location": "/merge/#to-stdout", 
-            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data2.yaml file of:  a: other\nc:\n  test: 1  then  yaml m data1.yaml data2.yaml  will output:  a: simple\nb: [1, 2]\nc:\n  test: 1", 
-            "title": "To Stdout"
-        }, 
-        {
-            "location": "/merge/#updating-files-in-place", 
-            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data2.yaml file of:  a: other\nc:\n  test: 1  then  yaml m -i data1.yaml data2.yaml  will update the data1.yaml file so that the value of 'c' is 'test: 1'.", 
-            "title": "Updating files in-place"
-        }, 
-        {
-            "location": "/merge/#overwrite-values", 
-            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data2.yaml file of:  a: other\nc:\n  test: 1  then  yaml m -x data1.yaml data2.yaml  will output:  a: other\nb: [1, 2]\nc:\n  test: 1", 
-            "title": "Overwrite values"
-        }, 
-        {
-            "location": "/merge/#overwrite-values-with-arrays", 
-            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data3.yaml file of:  b: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false  then  yaml m -x data1.yaml data3.yaml  will output:  a: simple\nb: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false  Notice that 'b' does not result in the merging of the values within an array. The underlying library does not\ncurrently handle merging values within an array.", 
-            "title": "Overwrite values with arrays"
-        }
-    ]
-}

docs/read/index.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="../assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Read - Yaml</title>
+        <title>Read - Yq</title>
       
     
     
-      <script src="../assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href=".." title="Yaml" class="md-header-nav__button md-logo">
+        <a href=".." title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,19 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <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>
             
-            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">
@@ -94,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -104,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -115,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -124,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -137,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -147,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -162,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -171,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -241,8 +259,8 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#handling-in-the-yaml-key" title="Handling '.' in the yaml key" class="md-nav__link">
-    Handling '.' in the yaml key
+  <a href="#multiple-documents" title="Multiple Documents" class="md-nav__link">
+    Multiple Documents
   </a>
   
 </li>
@@ -261,6 +279,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -287,6 +312,18 @@
       
 
 
+  <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
@@ -358,8 +395,8 @@
 </li>
       
         <li class="md-nav__item">
-  <a href="#handling-in-the-yaml-key" title="Handling '.' in the yaml key" class="md-nav__link">
-    Handling '.' in the yaml key
+  <a href="#multiple-documents" title="Multiple Documents" class="md-nav__link">
+    Multiple Documents
   </a>
   
 </li>
@@ -378,6 +415,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -392,10 +436,12 @@
             <article class="md-content__inner md-typeset">
               
                 
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/read.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
                 
                   <h1>Read</h1>
                 
-                <pre><code>yaml r &lt;yaml_file|json_file&gt; &lt;path&gt;
+                <pre><code>yq r &lt;yaml_file|json_file&gt; &lt;path&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>
@@ -406,13 +452,13 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml r sample.yaml b.c
+<pre><code class="bash">yq r sample.yaml b.c
 </code></pre>
 
 <p>will output the value of '2'.</p>
 <h3 id="from-stdin">From Stdin<a class="headerlink" href="#from-stdin" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
-<pre><code class="bash">cat sample.yaml | yaml r - b.c
+<pre><code class="bash">cat sample.yaml | yq r - b.c
 </code></pre>
 
 <p>will output the value of '2'.</p>
@@ -427,7 +473,7 @@ bob:
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml r sample.yaml bob.*.cats
+<pre><code class="bash">yq r sample.yaml bob.*.cats
 </code></pre>
 
 <p>will output</p>
@@ -435,14 +481,16 @@ bob:
 - apples
 </code></pre>
 
-<h3 id="handling-in-the-yaml-key">Handling '.' in the yaml key<a class="headerlink" href="#handling-in-the-yaml-key" title="Permanent link">&para;</a></h3>
+<h3 id="multiple-documents">Multiple Documents<a class="headerlink" href="#multiple-documents" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
-<pre><code class="yaml">b.x:
+<pre><code class="yaml">something: else
+---
+b:
   c: 2
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml r sample.yaml \&quot;b.x\&quot;.c
+<pre><code class="bash">yq r -d1 sample.yaml b.c
 </code></pre>
 
 <p>will output the value of '2'.</p>
@@ -458,10 +506,11 @@ e.g.: given a sample file of</p>
 </code></pre>
 
 <p>then</p>
-<pre><code>yaml r sample.yaml b.e[1].name
+<pre><code>yq r sample.yaml 'b.e[1].name'
 </code></pre>
 
 <p>will output 'sam'</p>
+<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
 <h3 id="array-splat">Array Splat<a class="headerlink" href="#array-splat" title="Permanent link">&para;</a></h3>
 <p>e.g.: given a sample file of</p>
 <pre><code class="yaml">b:
@@ -473,13 +522,29 @@ e.g.: given a sample file of</p>
 </code></pre>
 
 <p>then</p>
-<pre><code>yaml r sample.yaml b.e[*].name
+<pre><code>yq r sample.yaml 'b.e[*].name'
 </code></pre>
 
 <p>will output:</p>
 <pre><code>- fred
 - sam
 </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>
                 
                   
                 
@@ -535,9 +600,9 @@ e.g.: given a sample file of</p>
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -559,10 +624,9 @@ e.g.: given a sample file of</p>
       
     </div>
     
-      <script src="../assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="../assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:".."}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:".."}})</script>
       
     
     

docs/search/search_index.json

@@ -0,0 +1,224 @@
+{
+    "docs": [
+        {
+            "location": "/",
+            "text": "yq\n\u00b6\n\n\nyq is a lightweight and portable command-line YAML processor\n\n\nThe aim of the project is to be the \njq\n or sed of yaml files.\n\n\nInstall\n\u00b6\n\n\nOn MacOS:\n\n\nbrew install yq\n\n\n\n\nOn Ubuntu and other Linux distros supporting \nsnap\n packages:\n\n\nsnap install yq\n\n\n\n\nOn Ubuntu 16.04 or higher from Debian package:\n\n\nsudo add-apt-repository ppa:rmescandon/yq\nsudo apt update\nsudo apt install yq -y\n\n\n\n\nor, \nDownload latest binary\n or alternatively:\n\n\ngo get gopkg.in/mikefarah/yq.v2\n\n\n\n\nView on GitHub",
+            "title": "Install"
+        },
+        {
+            "location": "/#yq",
+            "text": "yq is a lightweight and portable command-line YAML processor  The aim of the project is to be the  jq  or sed of yaml files.",
+            "title": "yq"
+        },
+        {
+            "location": "/#install",
+            "text": "On MacOS:  brew install yq  On Ubuntu and other Linux distros supporting  snap  packages:  snap install yq  On Ubuntu 16.04 or higher from Debian package:  sudo add-apt-repository ppa:rmescandon/yq\nsudo apt update\nsudo apt install yq -y  or,  Download latest binary  or alternatively:  go get gopkg.in/mikefarah/yq.v2  View on GitHub",
+            "title": "Install"
+        },
+        {
+            "location": "/read/",
+            "text": "yq r <yaml_file|json_file> <path>\n\n\n\n\nThis command can take a json file as input too, and will output yaml unless specified to export as json (-j)\n\n\nBasic\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq r sample.yaml b.c\n\n\n\n\nwill output the value of '2'.\n\n\nFrom Stdin\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\ncat sample.yaml | yq r - b.c\n\n\n\n\nwill output the value of '2'.\n\n\nSplat\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\n---\nbob:\n  item1:\n    cats: bananas\n  item2:\n    cats: apples\n\n\n\n\nthen\n\n\nyq r sample.yaml bob.*.cats\n\n\n\n\nwill output\n\n\n- bananas\n- apples\n\n\n\n\nMultiple Documents\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nsomething: else\n---\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq r -d1 sample.yaml b.c\n\n\n\n\nwill output the value of '2'.\n\n\nArrays\n\u00b6\n\n\nYou can give an index to access a specific element:\ne.g.: given a sample file of\n\n\nb:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4\n\n\n\n\nthen\n\n\nyq r sample.yaml 'b.e[1].name'\n\n\n\n\nwill output 'sam'\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.\n\n\nArray Splat\n\u00b6\n\n\ne.g.: given a sample file of\n\n\nb:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4\n\n\n\n\nthen\n\n\nyq r sample.yaml 'b.e[*].name'\n\n\n\n\nwill output:\n\n\n- fred\n- sam\n\n\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.\n\n\nKeys with dots\n\u00b6\n\n\nWhen specifying a key that has a dot use key lookup indicator.\n\n\nb:\n  foo.bar: 7\n\n\n\n\nyaml r sample.yaml 'b[foo.bar]'\n\n\n\n\nyaml w sample.yaml 'b[foo.bar]' 9\n\n\n\n\nAny valid yaml key can be specified as part of a key lookup.\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.",
+            "title": "Read"
+        },
+        {
+            "location": "/read/#basic",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2  then  yq r sample.yaml b.c  will output the value of '2'.",
+            "title": "Basic"
+        },
+        {
+            "location": "/read/#from-stdin",
+            "text": "Given a sample.yaml file of:  cat sample.yaml | yq r - b.c  will output the value of '2'.",
+            "title": "From Stdin"
+        },
+        {
+            "location": "/read/#splat",
+            "text": "Given a sample.yaml file of:  ---\nbob:\n  item1:\n    cats: bananas\n  item2:\n    cats: apples  then  yq r sample.yaml bob.*.cats  will output  - bananas\n- apples",
+            "title": "Splat"
+        },
+        {
+            "location": "/read/#multiple-documents",
+            "text": "Given a sample.yaml file of:  something: else\n---\nb:\n  c: 2  then  yq r -d1 sample.yaml b.c  will output the value of '2'.",
+            "title": "Multiple Documents"
+        },
+        {
+            "location": "/read/#arrays",
+            "text": "You can give an index to access a specific element:\ne.g.: given a sample file of  b:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      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.",
+            "title": "Arrays"
+        },
+        {
+            "location": "/read/#array-splat",
+            "text": "e.g.: given a sample file of  b:\n  e:\n    - name: fred\n      value: 3\n    - name: sam\n      value: 4  then  yq r sample.yaml 'b.e[*].name'  will output:  - fred\n- sam  Note that the path is in quotes to avoid the square brackets being interpreted by your shell.",
+            "title": "Array Splat"
+        },
+        {
+            "location": "/read/#keys-with-dots",
+            "text": "When specifying a key that has a dot use key lookup indicator.  b:\n  foo.bar: 7  yaml r sample.yaml 'b[foo.bar]'  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.",
+            "title": "Keys with dots"
+        },
+        {
+            "location": "/write/",
+            "text": "yq w <yaml_file> <path> <new value>\n\n\n\n\nTo Stdout\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq w sample.yaml b.c cat\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n\n\n\n\nFrom STDIN\n\u00b6\n\n\ncat sample.yaml | yq w - b.c blah\n\n\n\n\nAdding new fields\n\u00b6\n\n\nAny missing fields in the path will be created on the fly.\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq w sample.yaml b.d[0] \"new thing\"\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n  d:\n    - new thing\n\n\n\n\nAppending value to an array field\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n  d:\n    - new thing\n    - foo thing\n\n\n\n\nthen\n\n\nyq w sample.yaml \"b.d[+]\" \"bar thing\"\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n  d:\n    - new thing\n    - foo thing\n    - bar thing\n\n\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.\n\n\nMultiple Documents - update a single document\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nsomething: else\n---\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq w -d1 sample.yaml b.c 5\n\n\n\n\nwill output:\n\n\nsomething: else\n---\nb:\n  c: 5\n\n\n\n\nMultiple Documents - update all documents\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nsomething: else\n---\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq w -d'*' sample.yaml b.c 5\n\n\n\n\nwill output:\n\n\nsomething: else\nb:\n  c: 5\n---\nb:\n  c: 5\n\n\n\n\nNote that '*' is in quotes to avoid being interpreted by your shell.\n\n\nUpdating files in-place\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq w -i sample.yaml b.c cat\n\n\n\n\nwill update the sample.yaml file so that the value of 'c' is cat.\n\n\nUpdating multiple values with a script\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n  e:\n    - name: Billy Bob\n\n\n\n\nand a script update_instructions.yaml of:\n\n\nb.c: 3\nb.e[0].name: Howdy Partner\n\n\n\n\nthen\n\n\nyq w -s update_instructions.yaml sample.yaml\n\n\n\n\nwill output:\n\n\nb:\n  c: 3\n  e:\n    - name: Howdy Partner\n\n\n\n\nAnd, of course, you can pipe the instructions in using '-':\n\n\ncat update_instructions.yaml | yq w -s - sample.yaml\n\n\n\n\nValues starting with a hyphen (or dash)\n\u00b6\n\n\nThe flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags:\n\n\nyq w -- my.path -3\n\n\n\n\nwill output\n\n\nmy:\n  path: -3\n\n\n\n\nKeys with dots\n\u00b6\n\n\nWhen specifying a key that has a dot use key lookup indicator.\n\n\nb:\n  foo.bar: 7\n\n\n\n\nyaml r sample.yaml 'b[foo.bar]'\n\n\n\n\nyaml w sample.yaml 'b[foo.bar]' 9\n\n\n\n\nAny valid yaml key can be specified as part of a key lookup.\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.",
+            "title": "Write/Update"
+        },
+        {
+            "location": "/write/#to-stdout",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2  then  yq w sample.yaml b.c cat  will output:  b:\n  c: cat",
+            "title": "To Stdout"
+        },
+        {
+            "location": "/write/#from-stdin",
+            "text": "cat sample.yaml | yq w - b.c blah",
+            "title": "From STDIN"
+        },
+        {
+            "location": "/write/#adding-new-fields",
+            "text": "Any missing fields in the path will be created on the fly.  Given a sample.yaml file of:  b:\n  c: 2  then  yq w sample.yaml b.d[0] \"new thing\"  will output:  b:\n  c: cat\n  d:\n    - new thing",
+            "title": "Adding new fields"
+        },
+        {
+            "location": "/write/#appending-value-to-an-array-field",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2\n  d:\n    - new thing\n    - foo thing  then  yq w sample.yaml \"b.d[+]\" \"bar thing\"  will output:  b:\n  c: cat\n  d:\n    - new thing\n    - foo thing\n    - bar thing  Note that the path is in quotes to avoid the square brackets being interpreted by your shell.",
+            "title": "Appending value to an array field"
+        },
+        {
+            "location": "/write/#multiple-documents-update-a-single-document",
+            "text": "Given a sample.yaml file of:  something: else\n---\nb:\n  c: 2  then  yq w -d1 sample.yaml b.c 5  will output:  something: else\n---\nb:\n  c: 5",
+            "title": "Multiple Documents - update a single document"
+        },
+        {
+            "location": "/write/#multiple-documents-update-all-documents",
+            "text": "Given a sample.yaml file of:  something: else\n---\nb:\n  c: 2  then  yq w -d'*' sample.yaml b.c 5  will output:  something: else\nb:\n  c: 5\n---\nb:\n  c: 5  Note that '*' is in quotes to avoid being interpreted by your shell.",
+            "title": "Multiple Documents - update all documents"
+        },
+        {
+            "location": "/write/#updating-files-in-place",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2  then  yq w -i sample.yaml b.c cat  will update the sample.yaml file so that the value of 'c' is cat.",
+            "title": "Updating files in-place"
+        },
+        {
+            "location": "/write/#updating-multiple-values-with-a-script",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2\n  e:\n    - name: Billy Bob  and a script update_instructions.yaml of:  b.c: 3\nb.e[0].name: Howdy Partner  then  yq w -s update_instructions.yaml sample.yaml  will output:  b:\n  c: 3\n  e:\n    - name: Howdy Partner  And, of course, you can pipe the instructions in using '-':  cat update_instructions.yaml | yq w -s - sample.yaml",
+            "title": "Updating multiple values with a script"
+        },
+        {
+            "location": "/write/#values-starting-with-a-hyphen-or-dash",
+            "text": "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  my:\n  path: -3",
+            "title": "Values starting with a hyphen (or dash)"
+        },
+        {
+            "location": "/write/#keys-with-dots",
+            "text": "When specifying a key that has a dot use key lookup indicator.  b:\n  foo.bar: 7  yaml r sample.yaml 'b[foo.bar]'  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.",
+            "title": "Keys with dots"
+        },
+        {
+            "location": "/delete/",
+            "text": "yq d <yaml_file> <path_to_delete>\n\n\n\n\nTo Stdout\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n  apples: green\n\n\n\n\nthen\n\n\nyq d sample.yaml b.c\n\n\n\n\nwill output:\n\n\nb:\n  apples: green\n\n\n\n\nFrom STDIN\n\u00b6\n\n\ncat sample.yaml | yq d - b.c\n\n\n\n\nDeleting array elements\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: \n    - 1\n    - 2\n    - 3\n\n\n\n\nthen\n\n\nyq d sample.yaml 'b.c[1]'\n\n\n\n\nwill output:\n\n\nb:\n  c:\n  - 1\n  - 3\n\n\n\n\nDeleting nodes in-place\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n  apples: green\n\n\n\n\nthen\n\n\nyq d -i sample.yaml b.c\n\n\n\n\nwill update the sample.yaml file so that the 'c' node is deleted\n\n\nMultiple Documents - delete from single document\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nsomething: else\nfield: leaveMe\n---\nb:\n  c: 2\nfield: deleteMe\n\n\n\n\nthen\n\n\nyq w -d1 sample.yaml field\n\n\n\n\nwill output:\n\n\nsomething: else\nfield: leaveMe\n---\nb:\n  c: 2\n\n\n\n\nMultiple Documents - delete from all documents\n\u00b6\n\n\nGiven a sample.yaml file of:\n\n\nsomething: else\nfield: deleteMe\n---\nb:\n  c: 2\nfield: deleteMeToo\n\n\n\n\nthen\n\n\nyq w -d'*' sample.yaml field\n\n\n\n\nwill output:\n\n\nsomething: else\n---\nb:\n  c: 2\n\n\n\n\nNote that '*' is in quotes to avoid being interpreted by your shell.\n\n\nKeys with dots\n\u00b6\n\n\nWhen specifying a key that has a dot use key lookup indicator.\n\n\nb:\n  foo.bar: 7\n\n\n\n\nyaml r sample.yaml 'b[foo.bar]'\n\n\n\n\nyaml w sample.yaml 'b[foo.bar]' 9\n\n\n\n\nAny valid yaml key can be specified as part of a key lookup.\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.",
+            "title": "Delete"
+        },
+        {
+            "location": "/delete/#to-stdout",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2\n  apples: green  then  yq d sample.yaml b.c  will output:  b:\n  apples: green",
+            "title": "To Stdout"
+        },
+        {
+            "location": "/delete/#from-stdin",
+            "text": "cat sample.yaml | yq d - b.c",
+            "title": "From STDIN"
+        },
+        {
+            "location": "/delete/#deleting-array-elements",
+            "text": "Given a sample.yaml file of:  b:\n  c: \n    - 1\n    - 2\n    - 3  then  yq d sample.yaml 'b.c[1]'  will output:  b:\n  c:\n  - 1\n  - 3",
+            "title": "Deleting array elements"
+        },
+        {
+            "location": "/delete/#deleting-nodes-in-place",
+            "text": "Given a sample.yaml file of:  b:\n  c: 2\n  apples: green  then  yq d -i sample.yaml b.c  will update the sample.yaml file so that the 'c' node is deleted",
+            "title": "Deleting nodes in-place"
+        },
+        {
+            "location": "/delete/#multiple-documents-delete-from-single-document",
+            "text": "Given a sample.yaml file of:  something: else\nfield: leaveMe\n---\nb:\n  c: 2\nfield: deleteMe  then  yq w -d1 sample.yaml field  will output:  something: else\nfield: leaveMe\n---\nb:\n  c: 2",
+            "title": "Multiple Documents - delete from single document"
+        },
+        {
+            "location": "/delete/#multiple-documents-delete-from-all-documents",
+            "text": "Given a sample.yaml file of:  something: else\nfield: deleteMe\n---\nb:\n  c: 2\nfield: deleteMeToo  then  yq w -d'*' sample.yaml field  will output:  something: else\n---\nb:\n  c: 2  Note that '*' is in quotes to avoid being interpreted by your shell.",
+            "title": "Multiple Documents - delete from all documents"
+        },
+        {
+            "location": "/delete/#keys-with-dots",
+            "text": "When specifying a key that has a dot use key lookup indicator.  b:\n  foo.bar: 7  yaml r sample.yaml 'b[foo.bar]'  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.",
+            "title": "Keys with dots"
+        },
+        {
+            "location": "/create/",
+            "text": "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.\n\n\nyq n <path> <new value>\n\n\n\n\nCreating a simple yaml file\n\u00b6\n\n\nyq n b.c cat\n\n\n\n\nwill output:\n\n\nb:\n  c: cat\n\n\n\n\nCreating using a create script\n\u00b6\n\n\nCreate scripts follow the same format as the update scripts.\n\n\nGiven a script create_instructions.yaml of:\n\n\nb.c: 3\nb.e[0].name: Howdy Partner\n\n\n\n\nthen\n\n\nyq n -s create_instructions.yaml\n\n\n\n\nwill output:\n\n\nb:\n  c: 3\n  e:\n    - name: Howdy Partner\n\n\n\n\nYou can also pipe the instructions in:\n\n\ncat create_instructions.yaml | yq n -s -\n\n\n\n\nKeys with dots\n\u00b6\n\n\nWhen specifying a key that has a dot use key lookup indicator.\n\n\nb:\n  foo.bar: 7\n\n\n\n\nyaml r sample.yaml 'b[foo.bar]'\n\n\n\n\nyaml w sample.yaml 'b[foo.bar]' 9\n\n\n\n\nAny valid yaml key can be specified as part of a key lookup.\n\n\nNote that the path is in quotes to avoid the square brackets being interpreted by your shell.",
+            "title": "Create"
+        },
+        {
+            "location": "/create/#creating-a-simple-yaml-file",
+            "text": "yq n b.c cat  will output:  b:\n  c: cat",
+            "title": "Creating a simple yaml file"
+        },
+        {
+            "location": "/create/#creating-using-a-create-script",
+            "text": "Create scripts follow the same format as the update scripts.  Given a script create_instructions.yaml of:  b.c: 3\nb.e[0].name: Howdy Partner  then  yq n -s create_instructions.yaml  will output:  b:\n  c: 3\n  e:\n    - name: Howdy Partner  You can also pipe the instructions in:  cat create_instructions.yaml | yq n -s -",
+            "title": "Creating using a create script"
+        },
+        {
+            "location": "/create/#keys-with-dots",
+            "text": "When specifying a key that has a dot use key lookup indicator.  b:\n  foo.bar: 7  yaml r sample.yaml 'b[foo.bar]'  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.",
+            "title": "Keys with dots"
+        },
+        {
+            "location": "/convert/",
+            "text": "Yaml to Json\n\u00b6\n\n\nTo convert output to json, use the --tojson (or -j) flag. This can only be used with the read command.\n\n\nGiven a sample.yaml file of:\n\n\nb:\n  c: 2\n\n\n\n\nthen\n\n\nyq r -j sample.yaml b.c\n\n\n\n\nwill output\n\n\n{\"b\":{\"c\":2}}\n\n\n\n\nJson to Yaml\n\u00b6\n\n\nTo read in json, just pass in a json file instead of yaml, it will just work :)\n\n\ne.g given a json file\n\n\n{\"a\":\"Easy! as one two three\",\"b\":{\"c\":2,\"d\":[3,4]}}\n\n\n\n\nthen\n\n\nyq r sample.json\n\n\n\n\nwill output\n\n\na: Easy! as one two three\nb:\n  c: 2\n  d:\n  - 3\n  - 4",
+            "title": "Convert"
+        },
+        {
+            "location": "/convert/#yaml-to-json",
+            "text": "To convert output to json, use the --tojson (or -j) flag. This can only be used with the read command.  Given a sample.yaml file of:  b:\n  c: 2  then  yq r -j sample.yaml b.c  will output  {\"b\":{\"c\":2}}",
+            "title": "Yaml to Json"
+        },
+        {
+            "location": "/convert/#json-to-yaml",
+            "text": "To read in json, just pass in a json file instead of yaml, it will just work :)  e.g given a json file  {\"a\":\"Easy! as one two three\",\"b\":{\"c\":2,\"d\":[3,4]}}  then  yq r sample.json  will output  a: Easy! as one two three\nb:\n  c: 2\n  d:\n  - 3\n  - 4",
+            "title": "Json to Yaml"
+        },
+        {
+            "location": "/merge/",
+            "text": "Yaml files can be merged using the 'merge' command. Each additional file merged with the first file will\nset values for any key not existing already or where the key has no value.\n\n\nyq m <yaml_file> <path>...\n\n\n\n\nTo Stdout\n\u00b6\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data2.yaml file of:\n\n\na: other\nc:\n  test: 1\n\n\n\n\nthen\n\n\nyq m data1.yaml data2.yaml\n\n\n\n\nwill output:\n\n\na: simple\nb: [1, 2]\nc:\n  test: 1\n\n\n\n\nUpdating files in-place\n\u00b6\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data2.yaml file of:\n\n\na: other\nc:\n  test: 1\n\n\n\n\nthen\n\n\nyq m -i data1.yaml data2.yaml\n\n\n\n\nwill update the data1.yaml file so that the value of 'c' is 'test: 1'.\n\n\nOverwrite values\n\u00b6\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data2.yaml file of:\n\n\na: other\nc:\n  test: 1\n\n\n\n\nthen\n\n\nyq m -x data1.yaml data2.yaml\n\n\n\n\nwill output:\n\n\na: other\nb: [1, 2]\nc:\n  test: 1\n\n\n\n\nOverwrite values with arrays\n\u00b6\n\n\nGiven a data1.yaml file of:\n\n\na: simple\nb: [1, 2]\n\n\n\n\nand data3.yaml file of:\n\n\nb: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false\n\n\n\n\nthen\n\n\nyq m -x data1.yaml data3.yaml\n\n\n\n\nwill output:\n\n\na: simple\nb: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false\n\n\n\n\nNotice that 'b' does not result in the merging of the values within an array. The underlying library does not\ncurrently handle merging values within an array.\n\n\nMultiple Documents - merge into single document\n\u00b6\n\n\nCurrently yq only has multi-document support for the \nfirst\n document being merged into. The remaining yaml files will have their first document selected.\n\n\nGiven a data1.yaml file of:\n\n\nsomething: else\n---\na: simple\nb: cat\n\n\n\n\nand data3.yaml file of:\n\n\nb: dog\n\n\n\n\nthen\n\n\nyq m -x -d1 data1.yaml data3.yaml\n\n\n\n\nwill output:\n\n\nsomething: else\n---\na: simple\nb: dog\n\n\n\n\nMultiple Documents - merge into all documents\n\u00b6\n\n\nCurrently yq only has multi-document support for the \nfirst\n document being merged into. The remaining yaml files will have their first document selected.\n\n\nGiven a data1.yaml file of:\n\n\nsomething: else\n---\na: simple\nb: cat\n\n\n\n\nand data3.yaml file of:\n\n\nb: dog\n\n\n\n\nthen\n\n\nyq m -x -d'*' data1.yaml data3.yaml\n\n\n\n\nwill output:\n\n\nb: dog\nsomething: else\n---\na: simple\nb: dog",
+            "title": "Merge"
+        },
+        {
+            "location": "/merge/#to-stdout",
+            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data2.yaml file of:  a: other\nc:\n  test: 1  then  yq m data1.yaml data2.yaml  will output:  a: simple\nb: [1, 2]\nc:\n  test: 1",
+            "title": "To Stdout"
+        },
+        {
+            "location": "/merge/#updating-files-in-place",
+            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data2.yaml file of:  a: other\nc:\n  test: 1  then  yq m -i data1.yaml data2.yaml  will update the data1.yaml file so that the value of 'c' is 'test: 1'.",
+            "title": "Updating files in-place"
+        },
+        {
+            "location": "/merge/#overwrite-values",
+            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data2.yaml file of:  a: other\nc:\n  test: 1  then  yq m -x data1.yaml data2.yaml  will output:  a: other\nb: [1, 2]\nc:\n  test: 1",
+            "title": "Overwrite values"
+        },
+        {
+            "location": "/merge/#overwrite-values-with-arrays",
+            "text": "Given a data1.yaml file of:  a: simple\nb: [1, 2]  and data3.yaml file of:  b: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false  then  yq m -x data1.yaml data3.yaml  will output:  a: simple\nb: [2, 3, 4]\nc:\n  test: 2\n  other: true\nd: false  Notice that 'b' does not result in the merging of the values within an array. The underlying library does not\ncurrently handle merging values within an array.",
+            "title": "Overwrite values with arrays"
+        },
+        {
+            "location": "/merge/#multiple-documents-merge-into-single-document",
+            "text": "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:  something: else\n---\na: simple\nb: cat  and data3.yaml file of:  b: dog  then  yq m -x -d1 data1.yaml data3.yaml  will output:  something: else\n---\na: simple\nb: dog",
+            "title": "Multiple Documents - merge into single document"
+        },
+        {
+            "location": "/merge/#multiple-documents-merge-into-all-documents",
+            "text": "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:  something: else\n---\na: simple\nb: cat  and data3.yaml file of:  b: dog  then  yq m -x -d'*' data1.yaml data3.yaml  will output:  b: dog\nsomething: else\n---\na: simple\nb: dog",
+            "title": "Multiple Documents - merge into all documents"
+        }
+    ]
+}

docs/sitemap.xml

@@ -4,7 +4,7 @@
     
     <url>
      <loc>/</loc>
-     <lastmod>2017-09-24</lastmod>
+     <lastmod>2018-06-20</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -12,7 +12,7 @@
     
     <url>
      <loc>/read/</loc>
-     <lastmod>2017-09-24</lastmod>
+     <lastmod>2018-06-20</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -20,7 +20,15 @@
     
     <url>
      <loc>/write/</loc>
-     <lastmod>2017-09-24</lastmod>
+     <lastmod>2018-06-20</lastmod>
+     <changefreq>daily</changefreq>
+    </url>
+    
+
+    
+    <url>
+     <loc>/delete/</loc>
+     <lastmod>2018-06-20</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -28,7 +36,7 @@
     
     <url>
      <loc>/create/</loc>
-     <lastmod>2017-09-24</lastmod>
+     <lastmod>2018-06-20</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -36,7 +44,7 @@
     
     <url>
      <loc>/convert/</loc>
-     <lastmod>2017-09-24</lastmod>
+     <lastmod>2018-06-20</lastmod>
      <changefreq>daily</changefreq>
     </url>
     
@@ -44,7 +52,7 @@
     
     <url>
      <loc>/merge/</loc>
-     <lastmod>2017-09-24</lastmod>
+     <lastmod>2018-06-20</lastmod>
      <changefreq>daily</changefreq>
     </url>
     

docs/write/index.html

@@ -1,4 +1,7 @@
 
+
+
+
 <!DOCTYPE html>
 <html lang="en" class="no-js">
   <head>
@@ -10,27 +13,37 @@
       
       
       
-        <link rel="shortcut icon" href="../assets/images/favicon.png">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
       
-      <meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.10.1">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+      
+        <meta name="lang:search.language" content="en">
+      
+        <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-0.17.2, mkdocs-material-2.2.5">
     
     
       
-        <title>Write/Update - Yaml</title>
+        <title>Write/Update - Yq</title>
       
     
     
-      <script src="../assets/javascripts/modernizr-e826f8942a.js"></script>
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-a20f419c8e.css">
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
+    
+    
       
-        
-        
-        
         <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>
       
@@ -40,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -61,9 +71,9 @@
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
-        <a href=".." title="Yaml" class="md-header-nav__button md-logo">
+        <a href=".." title="Yq" class="md-header-nav__button md-logo">
           
-            <i class="md-icon md-icon--home"></i>
+            <i class="md-icon"></i>
           
         </a>
       </div>
@@ -71,19 +81,24 @@
         <label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
-        <span class="md-flex__ellipsis md-header-nav__title">
+        <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>
             
-            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">
@@ -94,8 +109,8 @@
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result" data-md-lang-search="" data-md-lang-tokenizer="[\s\-]+">
-          <div class="md-search-result__meta" data-md-lang-result-none="No matching documents" data-md-lang-result-one="1 matching document" data-md-lang-result-other="# matching documents">
+        <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>
@@ -104,6 +119,7 @@
     </div>
   </div>
 </div>
+          
         
       </div>
       
@@ -115,7 +131,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -124,7 +140,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -137,6 +153,8 @@
     
     <div class="md-container">
       
+        
+      
       
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
@@ -147,12 +165,12 @@
                   <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">
-    <div class="md-nav__button md-logo">
+    <span class="md-nav__button md-logo">
       
-        <i class="md-icon md-icon--home"></i>
+        <i class="md-icon"></i>
       
-    </div>
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -162,7 +180,7 @@
   
 
 
-  <a href="https://github.com/mikefarah/yaml" title="Go to repository" class="md-source" data-md-source="github">
+  <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">
@@ -171,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -257,6 +275,20 @@
     Appending value to an array field
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-update-a-single-document" title="Multiple Documents - update a single document" class="md-nav__link">
+    Multiple Documents - update a single document
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-update-all-documents" title="Multiple Documents - update all documents" class="md-nav__link">
+    Multiple Documents - update all documents
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -280,6 +312,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -294,6 +333,18 @@
       
 
 
+  <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
@@ -369,6 +420,20 @@
     Appending value to an array field
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-update-a-single-document" title="Multiple Documents - update a single document" class="md-nav__link">
+    Multiple Documents - update a single document
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#multiple-documents-update-all-documents" title="Multiple Documents - update all documents" class="md-nav__link">
+    Multiple Documents - update all documents
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -392,6 +457,13 @@
   
 </li>
       
+        <li class="md-nav__item">
+  <a href="#keys-with-dots" title="Keys with dots" class="md-nav__link">
+    Keys with dots
+  </a>
+  
+</li>
+      
       
       
     </ul>
@@ -406,13 +478,14 @@
             <article class="md-content__inner md-typeset">
               
                 
+                  <a href="https://github.com/mikefarah/yq/edit/master/docs/write.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
+                
                 
                   <h1>Write/Update</h1>
                 
-                <pre><code>yaml w &lt;yaml_file|json_file&gt; &lt;path&gt; &lt;new value&gt;
+                <pre><code>yq w &lt;yaml_file&gt; &lt;path&gt; &lt;new value&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>
 <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:
@@ -420,7 +493,7 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml w sample.yaml b.c cat
+<pre><code class="bash">yq w sample.yaml b.c cat
 </code></pre>
 
 <p>will output:</p>
@@ -429,7 +502,7 @@
 </code></pre>
 
 <h3 id="from-stdin">From STDIN<a class="headerlink" href="#from-stdin" title="Permanent link">&para;</a></h3>
-<pre><code class="bash">cat sample.yaml | yaml w - b.c blah
+<pre><code class="bash">cat sample.yaml | yq w - b.c blah
 </code></pre>
 
 <h3 id="adding-new-fields">Adding new fields<a class="headerlink" href="#adding-new-fields" title="Permanent link">&para;</a></h3>
@@ -440,7 +513,7 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml w sample.yaml b.d[0] &quot;new thing&quot;
+<pre><code class="bash">yq w sample.yaml b.d[0] &quot;new thing&quot;
 </code></pre>
 
 <p>will output:</p>
@@ -460,7 +533,7 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml w sample.yaml b.d[+] &quot;bar thing&quot;
+<pre><code class="bash">yq w sample.yaml &quot;b.d[+]&quot; &quot;bar thing&quot;
 </code></pre>
 
 <p>will output:</p>
@@ -472,6 +545,48 @@
     - bar thing
 </code></pre>
 
+<p>Note that the path is in quotes to avoid the square brackets being interpreted by your shell.</p>
+<h3 id="multiple-documents-update-a-single-document">Multiple Documents - update a single document<a class="headerlink" href="#multiple-documents-update-a-single-document" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">something: else
+---
+b:
+  c: 2
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w -d1 sample.yaml b.c 5
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">something: else
+---
+b:
+  c: 5
+</code></pre>
+
+<h3 id="multiple-documents-update-all-documents">Multiple Documents - update all documents<a class="headerlink" href="#multiple-documents-update-all-documents" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">something: else
+---
+b:
+  c: 2
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w -d'*' sample.yaml b.c 5
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">something: else
+b:
+  c: 5
+---
+b:
+  c: 5
+</code></pre>
+
+<p>Note that '*' is in quotes to avoid being interpreted by your shell.</p>
 <h3 id="updating-files-in-place">Updating files in-place<a class="headerlink" href="#updating-files-in-place" title="Permanent link">&para;</a></h3>
 <p>Given a sample.yaml file of:</p>
 <pre><code class="yaml">b:
@@ -479,7 +594,7 @@
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml w -i sample.yaml b.c cat
+<pre><code class="bash">yq w -i sample.yaml b.c cat
 </code></pre>
 
 <p>will update the sample.yaml file so that the value of 'c' is cat.</p>
@@ -497,7 +612,7 @@ b.e[0].name: Howdy Partner
 </code></pre>
 
 <p>then</p>
-<pre><code class="bash">yaml w -s update_instructions.yaml sample.yaml
+<pre><code class="bash">yq w -s update_instructions.yaml sample.yaml
 </code></pre>
 
 <p>will output:</p>
@@ -508,18 +623,33 @@ b.e[0].name: Howdy Partner
 </code></pre>
 
 <p>And, of course, you can pipe the instructions in using '-':</p>
-<pre><code class="bash">cat update_instructions.yaml | yaml w -s - sample.yaml
+<pre><code class="bash">cat update_instructions.yaml | yq w -s - sample.yaml
 </code></pre>
 
 <h3 id="values-starting-with-a-hyphen-or-dash">Values starting with a hyphen (or dash)<a class="headerlink" href="#values-starting-with-a-hyphen-or-dash" title="Permanent link">&para;</a></h3>
 <p>The flag terminator needs to be used to stop the app from attempting to parse the subsequent arguments as flags:</p>
-<pre><code>yaml w -- my.path -3
+<pre><code>yq w -- my.path -3
 </code></pre>
 
 <p>will output</p>
 <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>
                 
                   
                 
@@ -553,13 +683,13 @@ b.e[0].name: Howdy Partner
           </a>
         
         
-          <a href="../create/" title="Create" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
+          <a href="../delete/" title="Delete" 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>
-                Create
+                Delete
               </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink">
@@ -575,9 +705,9 @@ b.e[0].name: Howdy Partner
       <div class="md-footer-copyright">
         
         powered by
-        <a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
+        <a href="http://www.mkdocs.org">MkDocs</a>
         and
-        <a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
+        <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>
       
@@ -599,10 +729,9 @@ b.e[0].name: Howdy Partner
       
     </div>
     
-      <script src="../assets/javascripts/application-f3ab9e5ff8.js"></script>
+      <script src="../assets/javascripts/application.6cdc17f0.js"></script>
       
-      
-      <script>app.initialize({url:{base:".."}})</script>
+      <script>app.initialize({version:"0.17.2",url:{base:".."}})</script>
       
     
     

examples/data3.yaml

@@ -1,5 +1 @@
-b: [2, 3, 4]
-c:
-  test: 2
-  other: true
-d: false
+b: dog

examples/multiline-text.yaml

@@ -0,0 +1,5 @@
+test: |
+  abcdefg    
+  hijklmno
+
+

examples/multiple_docs.yaml

@@ -0,0 +1,22 @@
+commonKey: first document
+a: Easy! as one two three
+b:
+  c: 2
+  d: [3, 4]
+  e:
+    - name: fred
+      value: 3
+    - name: sam
+      value: 4
+---
+commonKey: second document
+another:
+  document: here
+---
+commonKey: third document
+wow: 
+  - here is another
+---
+- 1
+- 2
+- 3 

examples/multiple_docs_small.yaml

@@ -0,0 +1,7 @@
+a: Easy! as one two three
+---
+another:
+  document: here
+---
+- 1
+- 2

examples/sample.yaml

@@ -6,4 +6,4 @@ b:
     - name: fred
       value: 3
     - name: sam
-      value: 4
+      value: 4

json_converter.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"strconv"
 
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/mikefarah/yaml.v2"
 )
 
 func jsonToString(context interface{}) (string, error) {

merge.go

@@ -1,8 +1,6 @@
 package main
 
-import (
-	"github.com/imdario/mergo"
-)
+import "gopkg.in/imdario/mergo.v0"
 
 func merge(dst, src interface{}, overwrite bool) error {
 	if overwrite {

merge_test.go

@@ -1,30 +0,0 @@
-package main
-
-import (
-	"testing"
-
-	yaml "gopkg.in/yaml.v2"
-)
-
-func TestMerge(t *testing.T) {
-	result, _ := mergeYaml([]string{"examples/data1.yaml", "examples/data2.yaml", "examples/data3.yaml"})
-	expected := yaml.MapSlice{
-		yaml.MapItem{Key: "a", Value: "simple"},
-		yaml.MapItem{Key: "b", Value: []interface{}{1, 2}},
-		yaml.MapItem{Key: "c", Value: yaml.MapSlice{yaml.MapItem{Key: "other", Value: true}, yaml.MapItem{Key: "test", Value: 1}}},
-		yaml.MapItem{Key: "d", Value: false},
-	}
-	assertResultComplex(t, expected, result)
-}
-
-func TestMergeWithOverwrite(t *testing.T) {
-	overwriteFlag = true
-	result, _ := mergeYaml([]string{"examples/data1.yaml", "examples/data2.yaml", "examples/data3.yaml"})
-	expected := yaml.MapSlice{
-		yaml.MapItem{Key: "a", Value: "other"},
-		yaml.MapItem{Key: "b", Value: []interface{}{2, 3, 4}},
-		yaml.MapItem{Key: "c", Value: yaml.MapSlice{yaml.MapItem{Key: "other", Value: true}, yaml.MapItem{Key: "test", Value: 2}}},
-		yaml.MapItem{Key: "d", Value: false},
-	}
-	assertResultComplex(t, expected, result)
-}

mkdocs.yml

@@ -1,16 +1,17 @@
 docs_dir: mkdocs
 site_dir: docs
-site_name: Yaml
+site_name: Yq
 theme: 'material'
 pages:
     - Install: index.md
     - Read: read.md
     - Write/Update: write.md
+    - Delete: delete.md
     - Create: create.md
     - Convert: convert.md
     - Merge: merge.md
-repo_name: 'mikefarah/yaml'
-repo_url: 'https://github.com/mikefarah/yaml'
+repo_name: 'mikefarah/yq'
+repo_url: 'https://github.com/mikefarah/yq'
 
 extra:
   social:

mkdocs/convert.md

@@ -1,5 +1,5 @@
 ### Yaml to Json
-To convert output to json, use the --tojson (or -j) flag. This can be used with any command.
+To convert output to json, use the --tojson (or -j) flag. This can only be used with the read command.
 
 Given a sample.yaml file of:
 ```yaml
@@ -8,7 +8,7 @@ b:
 ```
 then
 ```bash
-yaml r -j sample.yaml b.c
+yq r -j sample.yaml b.c
 ```
 
 will output
@@ -26,7 +26,7 @@ e.g given a json file
 ```
 then
 ```bash
-yaml r sample.json
+yq r sample.json
 ```
 will output
 ```yaml

mkdocs/create.md

@@ -1,12 +1,12 @@
-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.
+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.
 
 ```
-yaml n <path> <new value>
+yq n <path> <new value>
 ```
 
 ### Creating a simple yaml file
 ```bash
-yaml n b.c cat
+yq n b.c cat
 ```
 will output:
 ```yaml
@@ -25,7 +25,7 @@ b.e[0].name: Howdy Partner
 then
 
 ```bash
-yaml n -s create_instructions.yaml
+yq n -s create_instructions.yaml
 ```
 will output:
 ```yaml
@@ -38,5 +38,7 @@ b:
 You can also pipe the instructions in:
 
 ```bash
-cat create_instructions.yaml | yaml n -s -
-```
+cat create_instructions.yaml | yq n -s -
+```
+
+{!snippets/keys_with_dots.md!}

mkdocs/delete.md

@@ -0,0 +1,110 @@
+```
+yq d <yaml_file> <path_to_delete>
+```
+
+### To Stdout
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+  apples: green
+```
+then
+```bash
+yq d sample.yaml b.c
+```
+will output:
+```yaml
+b:
+  apples: green
+```
+
+### 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
+```bash
+yq d -i sample.yaml b.c
+```
+will update the sample.yaml file so that the 'c' node is deleted
+
+
+
+### Multiple Documents - delete from single document
+Given a sample.yaml file of:
+```yaml
+something: else
+field: leaveMe
+---
+b:
+  c: 2
+field: deleteMe
+```
+then
+```bash
+yq w -d1 sample.yaml field
+```
+will output:
+```yaml
+something: else
+field: leaveMe
+---
+b:
+  c: 2
+```
+
+### Multiple Documents - delete from all documents
+Given a sample.yaml file of:
+```yaml
+something: else
+field: deleteMe
+---
+b:
+  c: 2
+field: deleteMeToo
+```
+then
+```bash
+yq w -d'*' sample.yaml field
+```
+will output:
+```yaml
+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

@@ -1,16 +1,26 @@
-# yaml
-yaml is a lightweight and portable command-line YAML processor
+# yq
+yq is a lightweight and portable command-line YAML processor
 
 The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
 
-### [download latest binary](https://github.com/mikefarah/yaml/releases/latest)
-
-### get the source
-```bash
-go get github.com/mikefarah/yaml
+## Install
+On MacOS:
+```
+brew install yq
+```
+On Ubuntu and other Linux distros supporting `snap` packages:
+```
+snap install yq
+```
+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:
+```
+go get gopkg.in/mikefarah/yq.v2
 ```
 
-[.zip](https://github.com/mikefarah/yaml/zipball/master) or [tar.gz](https://github.com/mikefarah/yaml/tarball/master)
-
-[View on GitHub](https://github.com/mikefarah/yaml)
-
+[View on GitHub](https://github.com/mikefarah/yq)

mkdocs/merge.md

@@ -2,9 +2,9 @@ Yaml files can be merged using the 'merge' command. Each additional file merged
 set values for any key not existing already or where the key has no value.
 
 ```
-yaml m <yaml_file|json_file> <path>...
+yq m <yaml_file> <path>...
 ```
-{!snippets/works_with_json.md!}
+
 
 ### To Stdout
 Given a data1.yaml file of:
@@ -20,7 +20,7 @@ c:
 ```
 then
 ```bash
-yaml m data1.yaml data2.yaml
+yq m data1.yaml data2.yaml
 ```
 will output:
 ```yaml
@@ -44,7 +44,7 @@ c:
 ```
 then
 ```bash
-yaml m -i data1.yaml data2.yaml
+yq m -i data1.yaml data2.yaml
 ```
 will update the data1.yaml file so that the value of 'c' is 'test: 1'.
 
@@ -62,7 +62,7 @@ c:
 ```
 then
 ```bash
-yaml m -x data1.yaml data2.yaml
+yq m -x data1.yaml data2.yaml
 ```
 will output:
 ```yaml
@@ -88,7 +88,7 @@ d: false
 ```
 then
 ```bash
-yaml m -x data1.yaml data3.yaml
+yq m -x data1.yaml data3.yaml
 ```
 will output:
 ```yaml
@@ -102,3 +102,56 @@ d: false
 
 Notice that 'b' does not result in the merging of the values within an array. The underlying library does not
 currently handle merging values within an array.
+
+### 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:
+```yaml
+something: else
+---
+a: simple
+b: cat
+```
+and data3.yaml file of:
+```yaml
+b: dog
+```
+then
+```bash
+yq m -x -d1 data1.yaml data3.yaml
+```
+will output:
+```yaml
+something: else
+---
+a: simple
+b: dog
+```
+
+### Multiple 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:
+```yaml
+something: else
+---
+a: simple
+b: cat
+```
+and data3.yaml file of:
+```yaml
+b: dog
+```
+then
+```bash
+yq m -x -d'*' data1.yaml data3.yaml
+```
+will output:
+```yaml
+b: dog
+something: else
+---
+a: simple
+b: dog
+```

mkdocs/read.md

@@ -1,5 +1,5 @@
 ```
-yaml r <yaml_file|json_file> <path>
+yq r <yaml_file|json_file> <path>
 ```
 
 {!snippets/works_with_json.md!}
@@ -12,14 +12,14 @@ b:
 ```
 then
 ```bash
-yaml r sample.yaml b.c
+yq r sample.yaml b.c
 ```
 will output the value of '2'.
 
 ### From Stdin
 Given a sample.yaml file of:
 ```bash
-cat sample.yaml | yaml r - b.c
+cat sample.yaml | yq r - b.c
 ```
 will output the value of '2'.
 
@@ -35,7 +35,7 @@ bob:
 ```
 then
 ```bash
-yaml r sample.yaml bob.*.cats
+yq r sample.yaml bob.*.cats
 ```
 will output
 ```yaml
@@ -43,15 +43,17 @@ will output
 - apples
 ```
 
-### Handling '.' in the yaml key
+### Multiple Documents
 Given a sample.yaml file of:
 ```yaml
-b.x:
+something: else
+---
+b:
   c: 2
 ```
 then
 ```bash
-yaml r sample.yaml \"b.x\".c
+yq r -d1 sample.yaml b.c
 ```
 will output the value of '2'.
 
@@ -68,10 +70,12 @@ b:
 ```
 then
 ```
-yaml r sample.yaml b.e[1].name
+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
@@ -84,10 +88,13 @@ b:
 ```
 then
 ```
-yaml r sample.yaml b.e[*].name
+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

@@ -0,0 +1,19 @@
+### 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/write.md

@@ -1,7 +1,6 @@
 ```
-yaml w <yaml_file|json_file> <path> <new value>
+yq w <yaml_file> <path> <new value>
 ```
-{!snippets/works_with_json.md!}
 
 ### To Stdout
 Given a sample.yaml file of:
@@ -11,7 +10,7 @@ b:
 ```
 then
 ```bash
-yaml w sample.yaml b.c cat
+yq w sample.yaml b.c cat
 ```
 will output:
 ```yaml
@@ -21,7 +20,7 @@ b:
 
 ### From STDIN
 ```bash
-cat sample.yaml | yaml w - b.c blah
+cat sample.yaml | yq w - b.c blah
 ```
 
 ### Adding new fields
@@ -34,7 +33,7 @@ b:
 ```
 then
 ```bash
-yaml w sample.yaml b.d[0] "new thing"
+yq w sample.yaml b.d[0] "new thing"
 ```
 will output:
 ```yaml
@@ -55,7 +54,7 @@ b:
 ```
 then
 ```bash
-yaml w sample.yaml b.d[+] "bar thing"
+yq w sample.yaml "b.d[+]" "bar thing"
 ```
 will output:
 ```yaml
@@ -67,6 +66,52 @@ b:
     - bar thing
 ```
 
+Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
+
+### Multiple Documents - update a single document
+Given a sample.yaml file of:
+```yaml
+something: else
+---
+b:
+  c: 2
+```
+then
+```bash
+yq w -d1 sample.yaml b.c 5
+```
+will output:
+```yaml
+something: else
+---
+b:
+  c: 5
+```
+
+### Multiple Documents - update all documents
+Given a sample.yaml file of:
+```yaml
+something: else
+---
+b:
+  c: 2
+```
+then
+```bash
+yq w -d'*' sample.yaml b.c 5
+```
+will output:
+```yaml
+something: else
+b:
+  c: 5
+---
+b:
+  c: 5
+```
+
+Note that '*' is in quotes to avoid being interpreted by your shell.
+
 ### Updating files in-place
 Given a sample.yaml file of:
 ```yaml
@@ -75,7 +120,7 @@ b:
 ```
 then
 ```bash
-yaml w -i sample.yaml b.c cat
+yq w -i sample.yaml b.c cat
 ```
 will update the sample.yaml file so that the value of 'c' is cat.
 
@@ -96,7 +141,7 @@ b.e[0].name: Howdy Partner
 then
 
 ```bash
-yaml w -s update_instructions.yaml sample.yaml
+yq w -s update_instructions.yaml sample.yaml
 ```
 will output:
 ```yaml
@@ -108,14 +153,14 @@ b:
 
 And, of course, you can pipe the instructions in using '-':
 ```bash
-cat update_instructions.yaml | yaml w -s - sample.yaml
+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:
 
 ```
-yaml w -- my.path -3
+yq w -- my.path -3
 ```
 
 will output
@@ -123,3 +168,5 @@ will output
 my:
   path: -3
 ```
+
+{!snippets/keys_with_dots.md!}

release_instructions.txt

@@ -0,0 +1,37 @@
+- increment version in version.go
+- increment version in snapcraft.yaml
+- tag git with same version number
+- make sure local build passes
+- push tag to git
+- make local xcompile (builds binaries for all platforms)
+
+- git release
+  ./scripts/publish.sh
+
+- snapcraft
+  - will auto create a candidate, test it works then promote
+  - see https://build.snapcraft.io/user/mikefarah/yq
+  
+  sudo snap remove yq
+  sudo snap install --edge yq
+  
+  then on the mac snapcraft release yq <snap_build_number> stable
+
+
+- brew
+  - create pull request pointing to latest git release
+
+- docker
+  - build and push latest and new version tag
+
+- debian package
+  - execute 
+    ```dch -i```
+  - fill debian/changelog with changes from last version
+  - build the package sources 
+    ```debuild -i -I -S -sa```
+    (signing with gpg key is required in order to put it to ppa)
+  - put to PPA
+    ```dput ppa:<REPOSITORY> ../yq_<VERSION>_source.changes```
+    (current distro repository is ppa:rmescandon/yq. In case that a new version
+    is released, please contact rmescandon@gmail.com to bump debian package)

scripts/acceptance.sh

@@ -3,9 +3,10 @@
 set -e
 
 # acceptance test
-X=$(./bin/yaml w ./examples/sample.yaml b.c 3 | ./bin/yaml r - b.c)
+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"
   exit 1
 fi
+echo "acceptance tests passed"

scripts/doctools.sh

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

scripts/publish.sh

@@ -1,39 +1,32 @@
 #!/bin/bash
-
+set -ex
 GITHUB_TOKEN="${GITHUB_TOKEN:?missing required input \'GITHUB_TOKEN\'}"
 
 CURRENT="$(git describe --tags --abbrev=0)"
 PREVIOUS="$(git describe --tags --abbrev=0 --always "${CURRENT}"^)"
 OWNER="mikefarah"
-REPO="yaml"
+REPO="yq"
 
 release() {
-    mapfile -t logs < <(git log --pretty=oneline --abbrev-commit "${PREVIOUS}".."${CURRENT}")
-    description="$(printf '%s\n' "${logs[@]}")"
     github-release release \
         --user "$OWNER" \
         --repo "$REPO" \
-        --tag "$CURRENT" \
-        --description "$description" ||
-            github-release edit \
-                --user "$OWNER" \
-                --repo "$REPO" \
-                --tag "$CURRENT" \
-                --description "$description"
+        --tag "$CURRENT"
 }
 
 upload() {
-    mapfile -t files < <(find ./build -mindepth 1 -maxdepth 1)
-    for file in "${files[@]}"; do
+    while IFS=  read -r -d $'\0'; do
+        file=$REPLY
         BINARY=$(basename "${file}")
         echo "--> ${BINARY}"
         github-release upload \
+            --replace \
             --user "$OWNER" \
             --repo "$REPO" \
             --tag "$CURRENT" \
             --name "${BINARY}" \
             --file "$file"
-    done
+    done < <(find ./build -mindepth 1 -maxdepth 1 -print0)
 }
 
 release

scripts/vendor.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-set -e
-
-govendor fetch github.com/op/go-logging
-govendor fetch github.com/spf13/cobra
-govendor fetch gopkg.in/yaml.v2
-govendor fetch github.com/imdario/mergo
-govendor sync

snap/snapcraft.yaml

@@ -0,0 +1,22 @@
+name: yq
+version: 2.0.0
+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.
+
+grade: stable # devel|stable. must be 'stable' to release into candidate/stable channels
+confinement: strict
+
+apps:
+  yq:
+    command: yq
+    plugs: [home]
+
+parts:
+  yq:
+    plugin: go
+    source: .
+    go-importpath: github.com/mikefarah/yq
+    after: [go]
+  go:
+    source-tag: go1.9.4

utils_test.go

@@ -9,8 +9,8 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/spf13/cobra"
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/mikefarah/yaml.v2"
+	"gopkg.in/spf13/cobra.v0"
 )
 
 type resulter struct {
@@ -41,19 +41,21 @@ func parseData(rawData string) yaml.MapSlice {
 }
 
 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{}) {
+	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{}) {
-
+	t.Helper()
 	if expectedValue != actualValue {
 		t.Error(context)
 		t.Error(": expected <", expectedValue, "> but got <", actualValue, ">")

vendor/vendor.json

@@ -2,12 +2,6 @@
 	"comment": "",
 	"ignore": "test",
 	"package": [
-		{
-			"checksumSHA1": "66lykxpWgSmQodnhkADqn6tnroQ=",
-			"path": "github.com/imdario/mergo",
-			"revision": "e3000cb3d28c72b837601cac94debd91032d19fe",
-			"revisionTime": "2017-06-20T10:47:01Z"
-		},
 		{
 			"checksumSHA1": "40vJyUB4ezQSn/NSadsKEOrudMc=",
 			"path": "github.com/inconshreveable/mousetrap",
@@ -15,29 +9,41 @@
 			"revisionTime": "2014-10-17T20:07:13Z"
 		},
 		{
-			"checksumSHA1": "BoXdUBWB8UnSlFlbnuTQaPqfCGk=",
-			"path": "github.com/op/go-logging",
-			"revision": "970db520ece77730c7e4724c61121037378659d9",
-			"revisionTime": "2016-03-15T20:05:05Z"
+			"checksumSHA1": "ljd3FhYRJ91cLZz3wsH9BQQ2JbA=",
+			"path": "github.com/pkg/errors",
+			"revision": "816c9085562cd7ee03e7f8188a1cfd942858cded",
+			"revisionTime": "2018-03-11T21:45:15Z"
 		},
 		{
-			"checksumSHA1": "xPKgXygsORkmXnLdtFaFmipYKaA=",
-			"path": "github.com/spf13/cobra",
-			"revision": "b78744579491c1ceeaaa3b40205e56b0591b93a3",
-			"revisionTime": "2017-09-05T17:20:51Z"
-		},
-		{
-			"checksumSHA1": "Q52Y7t0lEtk/wcDn5q7tS7B+jqs=",
+			"checksumSHA1": "OJI0OgC5V8gZtfS1e0CDYMhkDNc=",
 			"path": "github.com/spf13/pflag",
-			"revision": "7aff26db30c1be810f9de5038ec5ef96ac41fd7c",
-			"revisionTime": "2017-08-24T17:57:12Z"
+			"revision": "3ebe029320b2676d667ae88da602a5f854788a8a",
+			"revisionTime": "2018-06-01T13:25:42Z"
 		},
 		{
-			"checksumSHA1": "RDJpJQwkF012L6m/2BJizyOksNw=",
-			"path": "gopkg.in/yaml.v2",
-			"revision": "eb3733d160e74a9c7e442f435eb3bea458e1d19f",
-			"revisionTime": "2017-08-12T16:00:11Z"
+			"checksumSHA1": "RwlkCZz8VFXAE4aHQQOSC0hLu5k=",
+			"path": "gopkg.in/imdario/mergo.v0",
+			"revision": "9316a62528ac99aaecb4e47eadd6dc8aa6533d58",
+			"revisionTime": "2018-06-08T14:01:56Z"
+		},
+		{
+			"checksumSHA1": "7wtGubs4v7+RZovtlmyT9KwA/gE=",
+			"path": "gopkg.in/mikefarah/yaml.v2",
+			"revision": "e175af14aaa1d0eff2ee04b691e4a4827a111416",
+			"revisionTime": "2018-06-13T04:05:11Z"
+		},
+		{
+			"checksumSHA1": "rL5r44ASTGubGW88gqQwlvVQshw=",
+			"path": "gopkg.in/op/go-logging.v1",
+			"revision": "b2cb9fa56473e98db8caba80237377e83fe44db5",
+			"revisionTime": "2016-02-11T21:21:56Z"
+		},
+		{
+			"checksumSHA1": "xsZjAbfLrXcMtY6fyQ8QC6EvJD0=",
+			"path": "gopkg.in/spf13/cobra.v0",
+			"revision": "ef82de70bb3f60c65fb8eebacbb2d122ef517385",
+			"revisionTime": "2018-04-27T13:45:50Z"
 		}
 	],
-	"rootPath": "github.com/mikefarah/yaml"
+	"rootPath": "github.com/mikefarah/yq"
 }

version.go

@@ -11,7 +11,7 @@ var (
 	GitDescribe string
 
 	// Version is main version number that is being run at the moment.
-	Version = "1.13.0"
+	Version = "2.0.1"
 
 	// VersionPrerelease is a pre-release marker for the version. If this is "" (empty string)
 	// then it means that it is a final release. Otherwise, this is a pre-release
@@ -20,7 +20,7 @@ var (
 )
 
 // ProductName is the name of the product
-const ProductName = "yaml"
+const ProductName = "yq"
 
 // GetVersionDisplay composes the parts of the version in a way that's suitable
 // for displaying to humans.
@@ -35,9 +35,6 @@ func getHumanVersion() string {
 	}
 
 	release := VersionPrerelease
-	if GitDescribe == "" && release == "" {
-		release = "dev"
-	}
 	if release != "" {
 		if !strings.Contains(version, release) {
 			version += fmt.Sprintf("-%s", release)

version_test.go

@@ -3,13 +3,18 @@ package main
 import "testing"
 
 func TestGetVersionDisplay(t *testing.T) {
+	var expectedVersion = ProductName + " version " + Version
+	if VersionPrerelease != "" {
+		expectedVersion = expectedVersion + "-" + VersionPrerelease
+	}
+	expectedVersion = expectedVersion + "\n"
 	tests := []struct {
 		name string
 		want string
 	}{
 		{
 			name: "Display Version",
-			want: ProductName + " version " + Version + "-dev\n",
+			want: expectedVersion,
 		},
 	}
 	for _, tt := range tests {

yaml.go

@@ -1,451 +0,0 @@
-package main
-
-import (
-	"errors"
-	"fmt"
-	"io/ioutil"
-	"os"
-	"strconv"
-	"strings"
-
-	logging "github.com/op/go-logging"
-	"github.com/spf13/cobra"
-	yaml "gopkg.in/yaml.v2"
-)
-
-var trimOutput = true
-var writeInplace = false
-var writeScript = ""
-var outputToJSON = false
-var overwriteFlag = false
-var verbose = false
-var version = false
-var log = logging.MustGetLogger("yaml")
-
-func main() {
-	cmd := newCommandCLI()
-	if err := cmd.Execute(); err != nil {
-		fmt.Println(err.Error())
-		os.Exit(1)
-	}
-}
-
-func newCommandCLI() *cobra.Command {
-	var rootCmd = &cobra.Command{
-		Use: "yaml",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			if version {
-				cmd.Print(GetVersionDisplay())
-				return nil
-			}
-			cmd.Println(cmd.UsageString())
-
-			return nil
-		},
-		PersistentPreRun: func(cmd *cobra.Command, args []string) {
-			var format = logging.MustStringFormatter(
-				`%{color}%{time:15:04:05} %{shortfunc} [%{level:.4s}]%{color:reset} %{message}`,
-			)
-			var backend = logging.AddModuleLevel(
-				logging.NewBackendFormatter(logging.NewLogBackend(os.Stderr, "", 0), format))
-
-			if verbose {
-				backend.SetLevel(logging.DEBUG, "")
-			} else {
-				backend.SetLevel(logging.ERROR, "")
-			}
-
-			logging.SetBackend(backend)
-		},
-	}
-
-	rootCmd.PersistentFlags().BoolVarP(&trimOutput, "trim", "t", true, "trim yaml output")
-	rootCmd.PersistentFlags().BoolVarP(&outputToJSON, "tojson", "j", false, "output as json")
-	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "verbose mode")
-	rootCmd.Flags().BoolVarP(&version, "version", "V", false, "Print version information and quit")
-
-	rootCmd.AddCommand(createReadCmd(), createWriteCmd(), createNewCmd(), createMergeCmd())
-	rootCmd.SetOutput(os.Stdout)
-
-	return rootCmd
-}
-
-func createReadCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:     "read [yaml_file] [path]",
-		Aliases: []string{"r"},
-		Short:   "yaml r sample.yaml a.b.c",
-		Example: `
-yaml read things.yaml a.b.c
-yaml r - a.b.c (reads from stdin)
-yaml r things.yaml a.*.c
-yaml r things.yaml a.array[0].blah
-yaml r things.yaml a.array[*].blah
-      `,
-		Long: "Outputs the value of the given path in the yaml file to STDOUT",
-		RunE: readProperty,
-	}
-}
-
-func createWriteCmd() *cobra.Command {
-	var cmdWrite = &cobra.Command{
-		Use:     "write [yaml_file] [path] [value]",
-		Aliases: []string{"w"},
-		Short:   "yaml w [--inplace/-i] [--script/-s script_file] sample.yaml a.b.c newValueForC",
-		Example: `
-yaml write things.yaml a.b.c cat
-yaml write --inplace things.yaml a.b.c cat
-yaml w -i things.yaml a.b.c cat
-yaml w --script update_script.yaml things.yaml
-yaml w -i -s update_script.yaml things.yaml
-yaml w things.yaml a.b.d[+] foo
-yaml w things.yaml a.b.d[+] foo
-      `,
-		Long: `Updates the yaml file w.r.t the given path and value.
-Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
-
-Append value to array adds the value to the end of array.
-
-Update Scripts:
-Note that you can give an update script to perform more sophisticated updated. Update script
-format is a yaml map where the key is the path and the value is..well the value. e.g.:
----
-a.b.c: true,
-a.b.e:
-  - name: bob
-`,
-		RunE: writeProperty,
-	}
-	cmdWrite.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
-	cmdWrite.PersistentFlags().StringVarP(&writeScript, "script", "s", "", "yaml script for updating yaml")
-	return cmdWrite
-}
-
-func createNewCmd() *cobra.Command {
-	var cmdNew = &cobra.Command{
-		Use:     "new [path] [value]",
-		Aliases: []string{"n"},
-		Short:   "yaml n [--script/-s script_file] a.b.c newValueForC",
-		Example: `
-yaml new a.b.c cat
-yaml n a.b.c cat
-yaml n --script create_script.yaml
-      `,
-		Long: `Creates a new yaml w.r.t the given path and value.
-Outputs to STDOUT
-
-Create Scripts:
-Note that you can give a create script to perform more sophisticated yaml. This follows the same format as the update script.
-`,
-		RunE: newProperty,
-	}
-	cmdNew.PersistentFlags().StringVarP(&writeScript, "script", "s", "", "yaml script for updating yaml")
-	return cmdNew
-}
-
-func createMergeCmd() *cobra.Command {
-	var cmdMerge = &cobra.Command{
-		Use:     "merge [initial_yaml_file] [additional_yaml_file]...",
-		Aliases: []string{"m"},
-		Short:   "yaml m [--inplace/-i] [--overwrite/-x] sample.yaml sample2.yaml",
-		Example: `
-yaml merge things.yaml other.yaml
-yaml merge --inplace things.yaml other.yaml
-yaml m -i things.yaml other.yaml
-yaml m --overwrite things.yaml other.yaml
-yaml m -i -x things.yaml other.yaml
-      `,
-		Long: `Updates the yaml file by adding/updating the path(s) and value(s) from additional yaml file(s).
-Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
-
-If overwrite flag is set then existing values will be overwritten using the values from each additional yaml file.
-`,
-		RunE: mergeProperties,
-	}
-	cmdMerge.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
-	cmdMerge.PersistentFlags().BoolVarP(&overwriteFlag, "overwrite", "x", false, "update the yaml file by overwriting existing values")
-	return cmdMerge
-}
-
-func readProperty(cmd *cobra.Command, args []string) error {
-	data, err := read(args)
-	if err != nil {
-		return err
-	}
-	dataStr, err := toString(data)
-	if err != nil {
-		return err
-	}
-	cmd.Println(dataStr)
-	return nil
-}
-
-func read(args []string) (interface{}, error) {
-	var parsedData yaml.MapSlice
-	var path = ""
-
-	if len(args) < 1 {
-		return nil, errors.New("Must provide filename")
-	} else if len(args) > 1 {
-		path = args[1]
-	}
-
-	if err := readData(args[0], &parsedData); err != nil {
-		var generalData interface{}
-		if err = readData(args[0], &generalData); err != nil {
-			return nil, err
-		}
-		item := yaml.MapItem{Key: "thing", Value: generalData}
-		parsedData = yaml.MapSlice{item}
-		path = "thing." + path
-	}
-
-	if parsedData != nil && parsedData[0].Key == nil {
-		var interfaceData []map[interface{}]interface{}
-		if err := readData(args[0], &interfaceData); err == nil {
-			var listMap []yaml.MapSlice
-			for _, item := range interfaceData {
-				listMap = append(listMap, mapToMapSlice(item))
-			}
-			return readYamlArray(listMap, path)
-		}
-	}
-
-	if path == "" {
-		return parsedData, nil
-	}
-
-	var paths = parsePath(path)
-
-	return readMap(parsedData, paths[0], paths[1:])
-}
-
-func readYamlArray(listMap []yaml.MapSlice, path string) (interface{}, error) {
-	if path == "" {
-		return listMap, nil
-	}
-
-	var paths = parsePath(path)
-
-	if paths[0] == "*" {
-		if len(paths[1:]) == 0 {
-			return listMap, nil
-		}
-		var results []interface{}
-		for _, m := range listMap {
-			value, err := readMap(m, paths[1], paths[2:])
-			if err != nil {
-				return nil, err
-			}
-			results = append(results, value)
-		}
-		return results, nil
-	}
-
-	index, err := strconv.ParseInt(paths[0], 10, 64)
-	if err != nil {
-		return nil, fmt.Errorf("Error accessing array: %v", err)
-	}
-	if len(paths[1:]) == 0 {
-		return listMap[index], nil
-	}
-	return readMap(listMap[index], paths[1], paths[2:])
-}
-
-func newProperty(cmd *cobra.Command, args []string) error {
-	updatedData, err := newYaml(args)
-	if err != nil {
-		return err
-	}
-	dataStr, err := toString(updatedData)
-	if err != nil {
-		return err
-	}
-	cmd.Println(dataStr)
-	return nil
-}
-
-func newYaml(args []string) (interface{}, error) {
-	var writeCommands yaml.MapSlice
-	if writeScript != "" {
-		if err := readData(writeScript, &writeCommands); err != nil {
-			return nil, err
-		}
-	} else if len(args) < 2 {
-		return nil, errors.New("Must provide <path_to_update> <value>")
-	} else {
-		writeCommands = make(yaml.MapSlice, 1)
-		writeCommands[0] = yaml.MapItem{Key: args[0], Value: parseValue(args[1])}
-	}
-
-	var parsedData yaml.MapSlice
-	var prependCommand = ""
-	var isArray = strings.HasPrefix(writeCommands[0].Key.(string), "[")
-	if isArray {
-		item := yaml.MapItem{Key: "thing", Value: make(yaml.MapSlice, 0)}
-		parsedData = yaml.MapSlice{item}
-		prependCommand = "thing"
-	} else {
-		parsedData = make(yaml.MapSlice, 0)
-	}
-
-	return updateParsedData(parsedData, writeCommands, prependCommand)
-}
-
-func writeProperty(cmd *cobra.Command, args []string) error {
-	updatedData, err := updateYaml(args)
-	if err != nil {
-		return err
-	}
-	return write(cmd, args[0], updatedData)
-}
-
-func write(cmd *cobra.Command, filename string, updatedData interface{}) error {
-	if writeInplace {
-		dataStr, err := yamlToString(updatedData)
-		if err != nil {
-			return err
-		}
-		return ioutil.WriteFile(filename, []byte(dataStr), 0644)
-	}
-	dataStr, err := toString(updatedData)
-	if err != nil {
-		return err
-	}
-	cmd.Println(dataStr)
-	return nil
-}
-
-func mergeProperties(cmd *cobra.Command, args []string) error {
-	if len(args) < 2 {
-		return errors.New("Must provide at least 2 yaml files")
-	}
-
-	updatedData, err := mergeYaml(args)
-	if err != nil {
-		return err
-	}
-	return write(cmd, args[0], updatedData)
-}
-
-func mergeYaml(args []string) (interface{}, error) {
-	var updatedData map[interface{}]interface{}
-
-	for _, f := range args {
-		var parsedData map[interface{}]interface{}
-		if err := readData(f, &parsedData); err != nil {
-			return nil, err
-		}
-		if err := merge(&updatedData, parsedData, overwriteFlag); err != nil {
-			return nil, err
-		}
-	}
-
-	return mapToMapSlice(updatedData), nil
-}
-
-func updateParsedData(parsedData yaml.MapSlice, writeCommands yaml.MapSlice, prependCommand string) (interface{}, error) {
-	var prefix = ""
-	if prependCommand != "" {
-		prefix = prependCommand + "."
-	}
-	for _, entry := range writeCommands {
-		path := prefix + entry.Key.(string)
-		value := entry.Value
-		var paths = parsePath(path)
-		parsedData = writeMap(parsedData, paths, value)
-	}
-	if prependCommand != "" {
-		return readMap(parsedData, prependCommand, make([]string, 0))
-	}
-	return parsedData, nil
-}
-
-func updateYaml(args []string) (interface{}, error) {
-	var writeCommands yaml.MapSlice
-	var prependCommand = ""
-	if writeScript != "" {
-		if err := readData(writeScript, &writeCommands); err != nil {
-			return nil, err
-		}
-	} else if len(args) < 3 {
-		return nil, errors.New("Must provide <filename> <path_to_update> <value>")
-	} else {
-		writeCommands = make(yaml.MapSlice, 1)
-		writeCommands[0] = yaml.MapItem{Key: args[1], Value: parseValue(args[2])}
-	}
-
-	var parsedData yaml.MapSlice
-	if err := readData(args[0], &parsedData); err != nil {
-		var generalData interface{}
-		if err = readData(args[0], &generalData); err != nil {
-			return nil, err
-		}
-		item := yaml.MapItem{Key: "thing", Value: generalData}
-		parsedData = yaml.MapSlice{item}
-		prependCommand = "thing"
-	}
-
-	return updateParsedData(parsedData, writeCommands, prependCommand)
-}
-
-func parseValue(argument string) interface{} {
-	var value, err interface{}
-	var inQuotes = len(argument) > 0 && argument[0] == '"'
-	if !inQuotes {
-		value, err = strconv.ParseFloat(argument, 64)
-		if err == nil {
-			return value
-		}
-		value, err = strconv.ParseBool(argument)
-		if err == nil {
-			return value
-		}
-		if argument == "[]" {
-			return make([]interface{}, 0)
-		}
-		return argument
-	}
-	return argument[1 : len(argument)-1]
-}
-
-func toString(context interface{}) (string, error) {
-	if outputToJSON {
-		return jsonToString(context)
-	}
-	return yamlToString(context)
-}
-
-func yamlToString(context interface{}) (string, error) {
-	out, err := yaml.Marshal(context)
-	if err != nil {
-		return "", fmt.Errorf("error printing yaml: %v", err)
-	}
-	outStr := string(out)
-	// trim the trailing new line as it's easier for a script to add
-	// it in if required than to remove it
-	if trimOutput {
-		return strings.Trim(outStr, "\n "), nil
-	}
-	return outStr, nil
-}
-
-func readData(filename string, parsedData interface{}) error {
-	if filename == "" {
-		return errors.New("Must provide filename")
-	}
-
-	var rawData []byte
-	var err error
-	if filename == "-" {
-		rawData, err = ioutil.ReadAll(os.Stdin)
-	} else {
-		rawData, err = ioutil.ReadFile(filename)
-	}
-
-	if err != nil {
-		return err
-	}
-
-	return yaml.Unmarshal(rawData, parsedData)
-}

yq.go

@@ -0,0 +1,588 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"os"
+	"reflect"
+	"strconv"
+	"strings"
+
+	errors "github.com/pkg/errors"
+	"gopkg.in/spf13/cobra.v0"
+
+	yaml "gopkg.in/mikefarah/yaml.v2"
+	logging "gopkg.in/op/go-logging.v1"
+)
+
+var trimOutput = true
+var writeInplace = false
+var writeScript = ""
+var outputToJSON = false
+var overwriteFlag = false
+var verbose = false
+var version = false
+var docIndex = "0"
+var log = logging.MustGetLogger("yq")
+
+func main() {
+	cmd := newCommandCLI()
+	if err := cmd.Execute(); err != nil {
+		log.Error(err.Error())
+		os.Exit(1)
+	}
+}
+
+func newCommandCLI() *cobra.Command {
+	yaml.DefaultMapType = reflect.TypeOf(yaml.MapSlice{})
+	var rootCmd = &cobra.Command{
+		Use: "yq",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if version {
+				cmd.Print(GetVersionDisplay())
+				return nil
+			}
+			cmd.Println(cmd.UsageString())
+
+			return nil
+		},
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			var format = logging.MustStringFormatter(
+				`%{color}%{time:15:04:05} %{shortfunc} [%{level:.4s}]%{color:reset} %{message}`,
+			)
+			var backend = logging.AddModuleLevel(
+				logging.NewBackendFormatter(logging.NewLogBackend(os.Stderr, "", 0), format))
+
+			if verbose {
+				backend.SetLevel(logging.DEBUG, "")
+			} else {
+				backend.SetLevel(logging.ERROR, "")
+			}
+
+			logging.SetBackend(backend)
+		},
+	}
+
+	rootCmd.PersistentFlags().BoolVarP(&trimOutput, "trim", "t", true, "trim yaml output")
+	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "verbose mode")
+	rootCmd.Flags().BoolVarP(&version, "version", "V", false, "Print version information and quit")
+
+	rootCmd.AddCommand(
+		createReadCmd(),
+		createWriteCmd(),
+		createDeleteCmd(),
+		createNewCmd(),
+		createMergeCmd(),
+	)
+	rootCmd.SetOutput(os.Stdout)
+
+	return rootCmd
+}
+
+func createReadCmd() *cobra.Command {
+	var cmdRead = &cobra.Command{
+		Use:     "read [yaml_file] [path]",
+		Aliases: []string{"r"},
+		Short:   "yq r [--doc/-d index] sample.yaml a.b.c",
+		Example: `
+yq read things.yaml a.b.c
+yq r - a.b.c (reads from stdin)
+yq r things.yaml a.*.c
+yq r -d1 things.yaml a.array[0].blah
+yq r things.yaml a.array[*].blah
+      `,
+		Long: "Outputs the value of the given path in the yaml file to STDOUT",
+		RunE: readProperty,
+	}
+	cmdRead.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number, 0 based")
+	cmdRead.PersistentFlags().BoolVarP(&outputToJSON, "tojson", "j", false, "output as json")
+	return cmdRead
+}
+
+func createWriteCmd() *cobra.Command {
+	var cmdWrite = &cobra.Command{
+		Use:     "write [yaml_file] [path] [value]",
+		Aliases: []string{"w"},
+		Short:   "yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml a.b.c newValue",
+		Example: `
+yq write things.yaml a.b.c cat
+yq write --inplace things.yaml a.b.c cat
+yq w -i things.yaml a.b.c cat
+yq w --script update_script.yaml things.yaml
+yq w -i -s update_script.yaml things.yaml
+yq w --doc 2 things.yaml a.b.d[+] foo
+yq w -d2 things.yaml a.b.d[+] foo
+      `,
+		Long: `Updates the yaml file w.r.t the given path and value.
+Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
+
+Append value to array adds the value to the end of array.
+
+Update Scripts:
+Note that you can give an update script to perform more sophisticated updated. Update script
+format is a yaml map where the key is the path and the value is..well the value. e.g.:
+---
+a.b.c: true,
+a.b.e:
+  - name: bob
+`,
+		RunE: writeProperty,
+	}
+	cmdWrite.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
+	cmdWrite.PersistentFlags().StringVarP(&writeScript, "script", "s", "", "yaml script for updating yaml")
+	cmdWrite.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
+	return cmdWrite
+}
+
+func createDeleteCmd() *cobra.Command {
+	var cmdDelete = &cobra.Command{
+		Use:     "delete [yaml_file] [path]",
+		Aliases: []string{"d"},
+		Short:   "yq d [--inplace/-i] [--doc/-d index] sample.yaml a.b.c",
+		Example: `
+yq delete things.yaml a.b.c
+yq delete --inplace things.yaml a.b.c
+yq d -i things.yaml a.b.c
+yq d things.yaml a.b.c
+	`,
+		Long: `Deletes the given path from the YAML file.
+Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
+`,
+		RunE: deleteProperty,
+	}
+	cmdDelete.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
+	cmdDelete.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
+	return cmdDelete
+}
+
+func createNewCmd() *cobra.Command {
+	var cmdNew = &cobra.Command{
+		Use:     "new [path] [value]",
+		Aliases: []string{"n"},
+		Short:   "yq n [--script/-s script_file] a.b.c newValue",
+		Example: `
+yq new a.b.c cat
+yq n a.b.c cat
+yq n --script create_script.yaml
+      `,
+		Long: `Creates a new yaml w.r.t the given path and value.
+Outputs to STDOUT
+
+Create Scripts:
+Note that you can give a create script to perform more sophisticated yaml. This follows the same format as the update script.
+`,
+		RunE: newProperty,
+	}
+	cmdNew.PersistentFlags().StringVarP(&writeScript, "script", "s", "", "yaml script for updating yaml")
+	return cmdNew
+}
+
+func createMergeCmd() *cobra.Command {
+	var cmdMerge = &cobra.Command{
+		Use:     "merge [initial_yaml_file] [additional_yaml_file]...",
+		Aliases: []string{"m"},
+		Short:   "yq m [--inplace/-i] [--doc/-d index] [--overwrite/-x] sample.yaml sample2.yaml",
+		Example: `
+yq merge things.yaml other.yaml
+yq merge --inplace things.yaml other.yaml
+yq m -i things.yaml other.yaml
+yq m --overwrite things.yaml other.yaml
+yq m -i -x things.yaml other.yaml
+      `,
+		Long: `Updates the yaml file by adding/updating the path(s) and value(s) from additional yaml file(s).
+Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
+
+If overwrite flag is set then existing values will be overwritten using the values from each additional yaml file.
+`,
+		RunE: mergeProperties,
+	}
+	cmdMerge.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
+	cmdMerge.PersistentFlags().BoolVarP(&overwriteFlag, "overwrite", "x", false, "update the yaml file by overwriting existing values")
+	cmdMerge.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
+	return cmdMerge
+}
+
+func readProperty(cmd *cobra.Command, args []string) error {
+	data, err := read(args)
+	if err != nil {
+		return err
+	}
+	dataStr, err := toString(data)
+	if err != nil {
+		return err
+	}
+	cmd.Println(dataStr)
+	return nil
+}
+
+func read(args []string) (interface{}, error) {
+	var path = ""
+
+	if len(args) < 1 {
+		return nil, errors.New("Must provide filename")
+	} else if len(args) > 1 {
+		path = args[1]
+	}
+	var generalData interface{}
+	var docIndexInt, errorParsingDocumentIndex = strconv.ParseInt(docIndex, 10, 32)
+	if errorParsingDocumentIndex != nil {
+		return nil, errors.Wrapf(errorParsingDocumentIndex, "Document index %v is not a integer", docIndex)
+	}
+	if err := readData(args[0], int(docIndexInt), &generalData); err != nil {
+		return nil, err
+	}
+	if path == "" {
+		return generalData, nil
+	}
+
+	var paths = parsePath(path)
+	return recurse(generalData, paths[0], paths[1:])
+}
+
+func newProperty(cmd *cobra.Command, args []string) error {
+	updatedData, err := newYaml(args)
+	if err != nil {
+		return err
+	}
+	dataStr, err := toString(updatedData)
+	if err != nil {
+		return err
+	}
+	cmd.Println(dataStr)
+	return nil
+}
+
+func newYaml(args []string) (interface{}, error) {
+	var writeCommands, writeCommandsError = readWriteCommands(args, 2, "Must provide <path_to_update> <value>")
+	if writeCommandsError != nil {
+		return nil, writeCommandsError
+	}
+
+	var dataBucket interface{}
+	var isArray = strings.HasPrefix(writeCommands[0].Key.(string), "[")
+	if isArray {
+		dataBucket = make([]interface{}, 0)
+	} else {
+		dataBucket = make(yaml.MapSlice, 0)
+	}
+
+	for _, entry := range writeCommands {
+		path := entry.Key.(string)
+		value := entry.Value
+		log.Debugf("setting %v to %v", path, value)
+		var paths = parsePath(path)
+		dataBucket = updatedChildValue(dataBucket, paths, value)
+	}
+
+	return dataBucket, nil
+}
+
+func parseDocumentIndex() (bool, int, error) {
+	if docIndex == "*" {
+		return true, -1, nil
+	}
+	docIndexInt64, err := strconv.ParseInt(docIndex, 10, 32)
+	if err != nil {
+		return false, -1, errors.Wrapf(err, "Document index %v is not a integer or *", docIndex)
+	}
+	return false, int(docIndexInt64), nil
+}
+
+type updateDataFn func(dataBucket interface{}, currentIndex int) (interface{}, error)
+
+func mapYamlDecoder(updateData updateDataFn, encoder *yaml.Encoder) yamlDecoderFn {
+	return func(decoder *yaml.Decoder) error {
+		var dataBucket interface{}
+		var errorReading error
+		var errorWriting error
+		var errorUpdating error
+		var currentIndex = 0
+
+		var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
+		if errorParsingDocIndex != nil {
+			return errorParsingDocIndex
+		}
+
+		for {
+			log.Debugf("Read doc %v", currentIndex)
+			errorReading = decoder.Decode(&dataBucket)
+
+			if errorReading == io.EOF {
+				if !updateAll && currentIndex < docIndexInt {
+					return fmt.Errorf("Asked to process document %v but there are only %v document(s)", docIndex, currentIndex)
+				}
+				return nil
+			} else if errorReading != nil {
+				return errors.Wrapf(errorReading, "Error reading document at index %v, %v", currentIndex, errorReading)
+			}
+			dataBucket, errorUpdating = updateData(dataBucket, currentIndex)
+			if errorUpdating != nil {
+				return errors.Wrapf(errorUpdating, "Error updating document at index %v", currentIndex)
+			}
+
+			errorWriting = encoder.Encode(dataBucket)
+
+			if errorWriting != nil {
+				return errors.Wrapf(errorWriting, "Error writing document at index %v, %v", currentIndex, errorWriting)
+			}
+			currentIndex = currentIndex + 1
+		}
+	}
+}
+
+func writeProperty(cmd *cobra.Command, args []string) error {
+	var writeCommands, writeCommandsError = readWriteCommands(args, 3, "Must provide <filename> <path_to_update> <value>")
+	if writeCommandsError != nil {
+		return writeCommandsError
+	}
+	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
+	if errorParsingDocIndex != nil {
+		return errorParsingDocIndex
+	}
+
+	var updateData = func(dataBucket interface{}, currentIndex int) (interface{}, error) {
+		if updateAll || currentIndex == docIndexInt {
+			log.Debugf("Updating doc %v", currentIndex)
+			for _, entry := range writeCommands {
+				path := entry.Key.(string)
+				value := entry.Value
+				log.Debugf("setting %v to %v", path, value)
+				var paths = parsePath(path)
+				dataBucket = updatedChildValue(dataBucket, paths, value)
+			}
+		}
+		return dataBucket, nil
+	}
+	return readAndUpdate(cmd.OutOrStdout(), args[0], updateData)
+}
+
+func readAndUpdate(stdOut io.Writer, inputFile string, updateData updateDataFn) error {
+	var destination io.Writer
+	var destinationName string
+	if writeInplace {
+		var tempFile, err = ioutil.TempFile("", "temp")
+		if err != nil {
+			return err
+		}
+		destinationName = tempFile.Name()
+		destination = tempFile
+		defer func() {
+			safelyCloseFile(tempFile)
+			safelyRenameFile(tempFile.Name(), inputFile)
+		}()
+	} else {
+		var writer = bufio.NewWriter(stdOut)
+		destination = writer
+		destinationName = "Stdout"
+		defer safelyFlush(writer)
+	}
+	var encoder = yaml.NewEncoder(destination)
+	log.Debugf("Writing to %v from %v", destinationName, inputFile)
+	return readStream(inputFile, mapYamlDecoder(updateData, encoder))
+}
+
+func deleteProperty(cmd *cobra.Command, args []string) error {
+	if len(args) < 2 {
+		return errors.New("Must provide <filename> <path_to_delete>")
+	}
+	var deletePath = args[1]
+	var paths = parsePath(deletePath)
+	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
+	if errorParsingDocIndex != nil {
+		return errorParsingDocIndex
+	}
+
+	var updateData = func(dataBucket interface{}, currentIndex int) (interface{}, error) {
+		if updateAll || currentIndex == docIndexInt {
+			log.Debugf("Deleting path in doc %v", currentIndex)
+			return deleteChildValue(dataBucket, paths), nil
+		}
+		return dataBucket, nil
+	}
+
+	return readAndUpdate(cmd.OutOrStdout(), args[0], updateData)
+}
+
+func mergeProperties(cmd *cobra.Command, args []string) error {
+	if len(args) < 2 {
+		return errors.New("Must provide at least 2 yaml files")
+	}
+	var input = args[0]
+	var filesToMerge = args[1:]
+	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
+	if errorParsingDocIndex != nil {
+		return errorParsingDocIndex
+	}
+
+	var updateData = func(dataBucket interface{}, currentIndex int) (interface{}, error) {
+		if updateAll || currentIndex == docIndexInt {
+			log.Debugf("Merging doc %v", currentIndex)
+			var mergedData map[interface{}]interface{}
+			if err := merge(&mergedData, dataBucket, overwriteFlag); err != nil {
+				return nil, err
+			}
+			for _, f := range filesToMerge {
+				var fileToMerge interface{}
+				if err := readData(f, 0, &fileToMerge); err != nil {
+					return nil, err
+				}
+				if err := merge(&mergedData, fileToMerge, overwriteFlag); err != nil {
+					return nil, err
+				}
+			}
+			return mergedData, nil
+		}
+		return dataBucket, nil
+	}
+	yaml.DefaultMapType = reflect.TypeOf(map[interface{}]interface{}{})
+	defer func() { yaml.DefaultMapType = reflect.TypeOf(yaml.MapSlice{}) }()
+	return readAndUpdate(cmd.OutOrStdout(), input, updateData)
+}
+
+func readWriteCommands(args []string, expectedArgs int, badArgsMessage string) (yaml.MapSlice, error) {
+	var writeCommands yaml.MapSlice
+	if writeScript != "" {
+		if err := readData(writeScript, 0, &writeCommands); err != nil {
+			return nil, err
+		}
+	} else if len(args) < expectedArgs {
+		return nil, errors.New(badArgsMessage)
+	} else {
+		writeCommands = make(yaml.MapSlice, 1)
+		writeCommands[0] = yaml.MapItem{Key: args[expectedArgs-2], Value: parseValue(args[expectedArgs-1])}
+	}
+	return writeCommands, nil
+}
+
+func parseValue(argument string) interface{} {
+	var value, err interface{}
+	var inQuotes = len(argument) > 0 && argument[0] == '"'
+	if !inQuotes {
+		value, err = strconv.ParseFloat(argument, 64)
+		if err == nil {
+			return value
+		}
+		value, err = strconv.ParseBool(argument)
+		if err == nil {
+			return value
+		}
+		if argument == "[]" {
+			return make([]interface{}, 0)
+		}
+		return argument
+	}
+	return argument[1 : len(argument)-1]
+}
+
+func toString(context interface{}) (string, error) {
+	if outputToJSON {
+		return jsonToString(context)
+	}
+	return yamlToString(context)
+}
+
+func yamlToString(context interface{}) (string, error) {
+	switch context.(type) {
+	case string:
+		return context.(string), nil
+	default:
+		return marshalContext(context)
+	}
+}
+
+func marshalContext(context interface{}) (string, error) {
+	out, err := yaml.Marshal(context)
+
+	if err != nil {
+		return "", errors.Wrap(err, "error printing yaml")
+	}
+
+	outStr := string(out)
+	// trim the trailing new line as it's easier for a script to add
+	// it in if required than to remove it
+	if trimOutput {
+		return strings.Trim(outStr, "\n "), nil
+	}
+	return outStr, nil
+}
+
+func safelyRenameFile(from string, to string) {
+	if renameError := os.Rename(from, to); renameError != nil {
+		log.Warningf("Error renaming from %v to %v, attemting to copy contents", from, to)
+		log.Warning(renameError.Error())
+		// can't do this rename when running in docker to a file targeted in a mounted volume,
+		// so gracefully degrade to copying the entire contents.
+		if copyError := copyFileContents(from, to); copyError != nil {
+			log.Errorf("Failed copying from %v to %v", from, to)
+			log.Errorf(copyError.Error())
+		}
+	}
+}
+
+// thanks https://stackoverflow.com/questions/21060945/simple-way-to-copy-a-file-in-golang
+func copyFileContents(src, dst string) (err error) {
+	in, err := os.Open(src)
+	if err != nil {
+		return err
+	}
+	defer safelyCloseFile(in)
+	out, err := os.Create(dst)
+	if err != nil {
+		return err
+	}
+	defer safelyCloseFile(out)
+	if _, err = io.Copy(out, in); err != nil {
+		return err
+	}
+	return out.Sync()
+}
+
+func safelyFlush(writer *bufio.Writer) {
+	if err := writer.Flush(); err != nil {
+		log.Error("Error flushing writer!")
+		log.Error(err.Error())
+	}
+
+}
+func safelyCloseFile(file *os.File) {
+	err := file.Close()
+	if err != nil {
+		log.Error("Error closing file!")
+		log.Error(err.Error())
+	}
+}
+
+type yamlDecoderFn func(*yaml.Decoder) error
+
+func readStream(filename string, yamlDecoder yamlDecoderFn) error {
+	if filename == "" {
+		return errors.New("Must provide filename")
+	}
+
+	var stream io.Reader
+	if filename == "-" {
+		stream = bufio.NewReader(os.Stdin)
+	} else {
+		file, err := os.Open(filename)
+		if err != nil {
+			return err
+		}
+		defer safelyCloseFile(file)
+		stream = file
+	}
+	return yamlDecoder(yaml.NewDecoder(stream))
+}
+
+func readData(filename string, indexToRead int, parsedData interface{}) error {
+	return readStream(filename, func(decoder *yaml.Decoder) error {
+		for currentIndex := 0; currentIndex < indexToRead; currentIndex++ {
+			errorSkipping := decoder.Decode(parsedData)
+			if errorSkipping != nil {
+				return errors.Wrapf(errorSkipping, "Error processing document at index %v, %v", currentIndex, errorSkipping)
+			}
+		}
+		return decoder.Decode(parsedData)
+	})
+}

yq_test.go

@@ -28,6 +28,13 @@ func TestRead(t *testing.T) {
 	assertResult(t, 2, result)
 }
 
+func TestReadMulti(t *testing.T) {
+	docIndex = "1"
+	result, _ := read([]string{"examples/multiple_docs.yaml", "another.document"})
+	assertResult(t, "here", result)
+	docIndex = "0"
+}
+
 func TestReadArray(t *testing.T) {
 	result, _ := read([]string{"examples/sample_array.yaml", "[1]"})
 	assertResult(t, 2, result)
@@ -47,6 +54,14 @@ application: MyApp`,
 		formattedResult)
 }
 
+func TestMultilineString(t *testing.T) {
+	testString := `
+	abcd
+	efg`
+	formattedResult, _ := yamlToString(testString)
+	assertResult(t, testString, formattedResult)
+}
+
 func TestNewYaml(t *testing.T) {
 	result, _ := newYaml([]string{"b.c", "3"})
 	formattedResult := fmt.Sprintf("%v", result)
@@ -63,37 +78,6 @@ func TestNewYamlArray(t *testing.T) {
 		formattedResult)
 }
 
-func TestUpdateYaml(t *testing.T) {
-	result, _ := updateYaml([]string{"examples/sample.yaml", "b.c", "3"})
-	formattedResult := fmt.Sprintf("%v", result)
-	assertResult(t,
-		"[{a Easy! as one two three} {b [{c 3} {d [3 4]} {e [[{name fred} {value 3}] [{name sam} {value 4}]]}]}]",
-		formattedResult)
-}
-
-func TestUpdateYamlArray(t *testing.T) {
-	result, _ := updateYaml([]string{"examples/sample_array.yaml", "[0]", "3"})
-	formattedResult := fmt.Sprintf("%v", result)
-	assertResult(t,
-		"[3 2 3]",
-		formattedResult)
-}
-
-func TestUpdateYaml_WithScript(t *testing.T) {
-	writeScript = "examples/instruction_sample.yaml"
-	_, _ = updateYaml([]string{"examples/sample.yaml"})
-}
-
-func TestUpdateYaml_WithUnknownScript(t *testing.T) {
-	writeScript = "fake-unknown"
-	_, err := updateYaml([]string{"examples/sample.yaml"})
-	if err == nil {
-		t.Error("Expected error due to unknown file")
-	}
-	expectedOutput := `open fake-unknown: no such file or directory`
-	assertResult(t, expectedOutput, err.Error())
-}
-
 func TestNewYaml_WithScript(t *testing.T) {
 	writeScript = "examples/instruction_sample.yaml"
 	expectedResult := `b: