Updated repo name

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

@@ -6,6 +6,7 @@
 # Folders
 _obj
 _test
+bin
 build
 .DS_Store
 
@@ -26,3 +27,12 @@ coverage.out
 *.prof
 yaml
 vendor/*/
+tmp/
+cover/
+yq
+
+# snapcraft
+parts/
+prime/
+.snapcraft/
+yq*.snap

.travis.yml

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

Dockerfile

@@ -0,0 +1,17 @@
+FROM golang:1.9 as builder
+
+WORKDIR /go/src/mikefarah/yq
+
+COPY . /go/src/mikefarah/yq
+
+RUN scripts/devtools.sh
+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

@@ -0,0 +1,30 @@
+FROM golang:1.9
+
+COPY scripts/devtools.sh /opt/devtools.sh
+
+RUN set -e -x \
+    && /opt/devtools.sh
+
+# install mkdocs
+RUN set -ex \
+    && buildDeps=' \
+        build-essential \
+        python-dev \
+    ' \
+    && apt-get update && apt-get install -y --no-install-recommends \
+        $buildDeps \
+        python2.7 \
+        python-setuptools \
+        python-wheel \
+        python-pip \
+    && pip install --upgrade \
+        pip \
+        'Markdown>=2.6.9' \
+        'mkdocs>=0.16.3' \
+        'mkdocs-material>=1.10.1' \
+        'markdown-include>=0.5.1' \
+    && apt-get purge -y --auto-remove $buildDeps \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV CGO_ENABLED 0
+ENV GOPATH /go:/yq

Makefile

@@ -0,0 +1,120 @@
+MAKEFLAGS += --warn-undefined-variables
+SHELL := /bin/bash
+.SHELLFLAGS := -o pipefail -euc
+.DEFAULT_GOAL := install
+
+include Makefile.variables
+
+.PHONY: help
+help:
+	@echo 'Management commands for cicdtest:'
+	@echo
+	@echo 'Usage:'
+	@echo '  ## Develop / Test Commands'
+	@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).'
+	@echo '    make test            Run tests on project.'
+	@echo '    make cover           Run tests and capture code coverage metrics on project.'
+	@echo '    make clean           Clean the directory tree of produced artifacts.'
+	@echo
+	@echo '  ## Utility Commands'
+	@echo '    make setup           Configures Minishfit/Docker directory mounts.'
+	@echo
+
+
+.PHONY: clean
+clean:
+	@rm -rf bin build cover *.out
+
+## prefix before other make targets to run in your local dev environment
+local: | quiet
+	@$(eval DOCKRUN= )
+	@mkdir -p tmp
+	@touch tmp/dev_image_id
+quiet: # this is silly but shuts up 'Nothing to be done for `local`'
+	@:
+
+prepare: tmp/dev_image_id
+tmp/dev_image_id: Dockerfile.dev scripts/devtools.sh
+	@mkdir -p tmp
+	@docker rmi -f ${DEV_IMAGE} > /dev/null 2>&1 || true
+	@docker build -t ${DEV_IMAGE} -f Dockerfile.dev .
+	@docker inspect -f "{{ .ID }}" ${DEV_IMAGE} > tmp/dev_image_id
+
+# ----------------------------------------------
+# build
+.PHONY: build
+build: build/dev
+
+.PHONY: build/dev
+build/dev: test *.go
+	@mkdir -p bin/
+	${DOCKRUN} go build --ldflags "$(LDFLAGS)"
+	${DOCKRUN} bash ./scripts/acceptance.sh
+
+## Compile the project for multiple OS and Architectures.
+xcompile: check
+	@rm -rf build/
+	@mkdir -p build
+	${DOCKRUN} bash ./scripts/xcompile.sh
+	@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
+
+# Each of the fetch should be an entry within vendor.json; not currently included within project
+.PHONY: vendor
+vendor: tmp/dev_image_id
+	${DOCKRUN} govendor sync
+	@chmod 664 vendor/vendor.json
+
+# ----------------------------------------------
+# develop and test
+
+.PHONY: format
+format: vendor
+	${DOCKRUN} bash ./scripts/format.sh
+
+.PHONY: check
+check: format
+	${DOCKRUN} bash ./scripts/check.sh
+
+.PHONY: test
+test: check
+	${DOCKRUN} bash ./scripts/test.sh
+
+.PHONY: cover
+cover: check
+	@rm -rf cover/
+	@mkdir -p cover
+	${DOCKRUN} bash ./scripts/coverage.sh
+	@find cover -type d -exec chmod 755 {} \; || :
+	@find cover -type f -exec chmod 644 {} \; || :
+
+.PHONY: build-docs
+build-docs: prepare mkdocs.yml mkdocs/*
+	${DOCKRUN} mkdocs build
+	@find docs -type d -exec chmod 755 {} \; || :
+	@find docs -type f -exec chmod 644 {} \; || :
+
+.PHONY: release
+release: xcompile
+	${DOCKRUN} bash ./scripts/publish.sh
+
+# ----------------------------------------------
+# utilities
+
+.PHONY: setup
+setup:
+	@bash ./scripts/setup.sh

Makefile.variables

@@ -0,0 +1,38 @@
+export PROJECT = yq
+IMPORT_PATH := github.com/mikefarah/${PROJECT}
+
+export GIT_COMMIT = $(shell git rev-parse --short HEAD)
+export GIT_DIRTY = $(shell test -n "$$(git status --porcelain)" && echo "+CHANGES" || true)
+export GIT_DESCRIBE = $(shell git describe --tags --always)
+LDFLAGS :=
+LDFLAGS += -X main.GitCommit=${GIT_COMMIT}${GIT_DIRTY}
+LDFLAGS += -X main.GitDescribe=${GIT_DESCRIBE}
+
+GITHUB_TOKEN ?=
+
+# Windows environment?
+CYG_CHECK := $(shell hash cygpath 2>/dev/null && echo 1)
+ifeq ($(CYG_CHECK),1)
+	VBOX_CHECK := $(shell hash VBoxManage 2>/dev/null && echo 1)
+
+	# Docker Toolbox (pre-Windows 10)
+	ifeq ($(VBOX_CHECK),1)
+		ROOT := /${PROJECT}
+	else
+		# Docker Windows
+		ROOT := $(shell cygpath -m -a "$(shell pwd)")
+	endif
+else
+	# all non-windows environments
+	ROOT := $(shell pwd)
+endif
+
+DEV_IMAGE := ${PROJECT}_dev
+
+DOCKRUN := docker run --rm \
+	-e LDFLAGS="${LDFLAGS}" \
+	-e GITHUB_TOKEN="${GITHUB_TOKEN}" \
+	-v ${ROOT}/vendor:/go/src \
+	-v ${ROOT}:/${PROJECT}/src/${IMPORT_PATH} \
+	-w /${PROJECT}/src/${IMPORT_PATH} \
+	${DEV_IMAGE}

README.md

@@ -1,12 +1,34 @@
-# yaml [![Build Status](https://travis-ci.org/mikefarah/yaml.svg?branch=master)](https://travis-ci.org/mikefarah/yaml)
+# yq [![Build Status](https://travis-ci.org/mikefarah/yq.svg?branch=master)](https://travis-ci.org/mikefarah/yq)
-yaml is a lightweight and portable command-line YAML processor
+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
+```
+or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
+```
+go get github.com/mikefarah/yq
+```
+
+## 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
@@ -20,32 +42,39 @@ go get github.com/mikefarah/yaml
 - Convert from json to yaml
 - Convert from yaml to json
 - 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.
 
-## [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 [command]
+  yq [flags]
+  yq [command]
 
 Available Commands:
-  read        yaml r sample.yaml a.b.c
+  delete      yq d [--inplace/-i] sample.yaml a.b.c
-  write       yaml w [--inplace/-i] [--script/-s script_file] sample.yaml a.b.c newValueForC
+  help        Help about any command
-  new         yaml n [--script/-s script_file] a.b.c newValueForC
+  merge       yq m [--inplace/-i] [--overwrite/-x] sample.yaml sample2.yaml
+  new         yq n [--script/-s script_file] a.b.c newValueForC
+  read        yq r sample.yaml a.b.c
+  write       yq w [--inplace/-i] [--script/-s script_file] sample.yaml a.b.c newValueForC
 
 Flags:
-  -h, --help[=false]: help for yaml
+  -h, --help      help for yq
-  -j, --tojson[=false]: output as json
+  -j, --tojson    output as json
-  -t, --trim[=true]: trim yaml output
+  -t, --trim      trim yaml output (default true)
-  -v, --verbose[=false]: verbose mode
+  -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. run `govendor sync` [link](https://github.com/kardianos/govendor)
+1. `make [local] vendor`
 2. add unit tests
-3. make changes
+3. apply changes
-4. run ./precheckin.sh
+4. `make [local] build`
 5. profit

ci.sh

@@ -1,15 +0,0 @@
-#!/bin/bash
-
-set -e
-
-go test
-go build
-
-# acceptance test
-X=$(./yaml w sample.yaml b.c 3 | ./yaml r - b.c)
-
-if [ $X != 3 ]
-  then
-  echo "Failed acceptance test: expected 2 but was $X"
-  exit 1
-fi

commands_test.go

@@ -0,0 +1,544 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/spf13/cobra"
+)
+
+func getRootCommand() *cobra.Command {
+	return newCommandCLI()
+}
+
+func TestRootCmd(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	if !strings.Contains(result.Output, "Usage:") {
+		t.Error("Expected usage message to be printed out, but the usage message was not found.")
+	}
+
+}
+
+func TestRootCmd_VerboseLong(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "--verbose")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	if !verbose {
+		t.Error("Expected verbose to be true")
+	}
+}
+
+func TestRootCmd_VerboseShort(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "-v")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	if !verbose {
+		t.Error("Expected verbose to be true")
+	}
+}
+
+func TestRootCmd_TrimLong(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "--trim")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	if !trimOutput {
+		t.Error("Expected trimOutput to be true")
+	}
+}
+
+func TestRootCmd_TrimShort(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "-t")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	if !trimOutput {
+		t.Error("Expected trimOutput to be true")
+	}
+}
+
+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, "yq version") {
+		t.Error("expected version message to be printed out, but the message was not found.")
+	}
+}
+
+func TestRootCmd_VersionLong(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "--version")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	if !strings.Contains(result.Output, "yq version") {
+		t.Error("expected version message to be printed out, but the message was not found.")
+	}
+}
+
+func TestReadCmd(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/sample.yaml b.c")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "2\n", result.Output)
+}
+
+func TestReadCmd_ArrayYaml(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml [0].gather_facts")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "false\n", result.Output)
+}
+
+func TestReadCmd_ArrayYaml_NoPath(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `- become: true
+  gather_facts: false
+  hosts: lalaland
+  name: Apply smth
+  roles:
+  - lala
+  - land
+  serial: 1
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadCmd_ArrayYaml_OneElement(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml [0]")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `become: true
+gather_facts: false
+hosts: lalaland
+name: Apply smth
+roles:
+- lala
+- land
+serial: 1
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadCmd_ArrayYaml_Splat(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml [*]")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `- become: true
+  gather_facts: false
+  hosts: lalaland
+  name: Apply smth
+  roles:
+  - lala
+  - land
+  serial: 1
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadCmd_ArrayYaml_SplatKey(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml [*].gather_facts")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := "- false\n"
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadCmd_ArrayYaml_ErrorBadPath(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml [x].gather_facts")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to invalid path")
+	}
+	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestReadCmd_ArrayYaml_Splat_ErrorBadPath(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read examples/array.yaml [*].roles[x]")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to invalid path")
+	}
+	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestReadCmd_Error(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to missing arg")
+	}
+	expectedOutput := `Must provide filename`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestReadCmd_ErrorEmptyFilename(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read  ")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to missing arg")
+	}
+	expectedOutput := `Must provide filename`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestReadCmd_ErrorUnreadableFile(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "read fake-unknown")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to unknown file")
+	}
+	expectedOutput := `open fake-unknown: no such file or directory`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestReadCmd_ErrorBadPath(t *testing.T) {
+	content := `b:
+  d:
+    e:
+      - 3
+      - 4
+    f:
+      - 1
+      - 2
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("read %s b.d.*.[x]", filename))
+	if result.Error == nil {
+		t.Fatal("Expected command to fail due to invalid path")
+	}
+	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestReadCmd_Verbose(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "-v read examples/sample.yaml b.c")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "2\n", result.Output)
+}
+
+func TestReadCmd_NoTrim(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "--trim=false read examples/sample.yaml b.c")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "2\n\n", result.Output)
+}
+
+func TestReadCmd_ToJson(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "-j read examples/sample.yaml b.c")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	assertResult(t, "2\n", result.Output)
+}
+
+func TestNewCmd(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "new b.c 3")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 3
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestNewCmd_Error(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "new b.c")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to missing arg")
+	}
+	expectedOutput := `Must provide <path_to_update> <value>`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestNewCmd_Verbose(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "-v new b.c 3")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 3
+`
+	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
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write %s b.c 7", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 7
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestWriteCmd_EmptyArray(t *testing.T) {
+	content := `b: 3`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write %s a []", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b: 3
+a: []
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestWriteCmd_Error(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "write")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to missing arg")
+	}
+	expectedOutput := `Must provide <filename> <path_to_update> <value>`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestWriteCmd_ErrorUnreadableFile(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "write fake-unknown a.b 3")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to unknown file")
+	}
+	expectedOutput := `open fake-unknown: no such file or directory`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestWriteCmd_Verbose(t *testing.T) {
+	content := `b:
+  c: 3
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("-v write %s b.c 7", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+  c: 7
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestWriteCmd_Inplace(t *testing.T) {
+	content := `b:
+  c: 3
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write -i %s b.c 7", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	gotOutput := readTempYamlFile(filename)
+	expectedOutput := `b:
+  c: 7`
+	assertResult(t, expectedOutput, gotOutput)
+}
+
+func TestWriteCmd_Append(t *testing.T) {
+	content := `b:
+  - foo
+`
+	filename := writeTempYamlFile(content)
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("write %s b[+] 7", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `b:
+- foo
+- 7
+`
+	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 TestMergeCmd(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "merge examples/data1.yaml examples/data2.yaml")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `a: simple
+b:
+- 1
+- 2
+c:
+  test: 1
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestMergeCmd_Error(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "merge examples/data1.yaml")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to missing arg")
+	}
+	expectedOutput := `Must provide at least 2 yaml files`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestMergeCmd_ErrorUnreadableFile(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "merge examples/data1.yaml fake-unknown")
+	if result.Error == nil {
+		t.Error("Expected command to fail due to unknown file")
+	}
+	expectedOutput := `open fake-unknown: no such file or directory`
+	assertResult(t, expectedOutput, result.Error.Error())
+}
+
+func TestMergeCmd_Verbose(t *testing.T) {
+	cmd := getRootCommand()
+	result := runCmd(cmd, "-v merge examples/data1.yaml examples/data2.yaml")
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `a: simple
+b:
+- 1
+- 2
+c:
+  test: 1
+`
+	assertResult(t, expectedOutput, result.Output)
+}
+
+func TestMergeCmd_Inplace(t *testing.T) {
+	filename := writeTempYamlFile(readTempYamlFile("examples/data1.yaml"))
+	defer removeTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := runCmd(cmd, fmt.Sprintf("merge -i %s examples/data2.yaml", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	gotOutput := readTempYamlFile(filename)
+	expectedOutput := `a: simple
+b:
+- 1
+- 2
+c:
+  test: 1`
+	assertResult(t, expectedOutput, gotOutput)
+}

coverage.sh

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-go test -coverprofile=coverage.out && go tool cover -html=coverage.out

data_navigator.go

@@ -1,8 +1,11 @@
 package main
 
 import (
-	"gopkg.in/yaml.v2"
+	"fmt"
+	"sort"
 	"strconv"
+
+	"gopkg.in/yaml.v2"
 )
 
 func entryInSlice(context yaml.MapSlice, key interface{}) *yaml.MapItem {
@@ -15,9 +18,7 @@ func entryInSlice(context yaml.MapSlice, key interface{}) *yaml.MapItem {
 	return nil
 }
 
-func writeMap(context interface{}, paths []string, value interface{}) yaml.MapSlice {
+func getMapSlice(context interface{}) yaml.MapSlice {
-	log.Debugf("writeMap for %v for %v with value %v\n", paths, context, value)
-
 	var mapSlice yaml.MapSlice
 	switch context.(type) {
 	case yaml.MapSlice:
@@ -25,6 +26,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
@@ -40,7 +60,7 @@ func writeMap(context interface{}, paths []string, value interface{}) yaml.MapSl
 
 	log.Debugf("\tchild.Value %v\n", child.Value)
 
-	remainingPaths := paths[1:len(paths)]
+	remainingPaths := paths[1:]
 	child.Value = updatedChildValue(child.Value, remainingPaths, value)
 	log.Debugf("\tReturning mapSlice %v\n", mapSlice)
 	return mapSlice
@@ -52,7 +72,7 @@ func updatedChildValue(child interface{}, remainingPaths []string, value interfa
 	}
 
 	_, nextIndexErr := strconv.ParseInt(remainingPaths[0], 10, 64)
-	if nextIndexErr != nil {
+	if nextIndexErr != nil && remainingPaths[0] != "+" {
 		// must be a map
 		return writeMap(child, remainingPaths, value)
 	}
@@ -63,13 +83,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{}
+	array, _ := getArray(context)
-	switch context.(type) {
-	case []interface{}:
-		array = context.([]interface{})
-	default:
-		array = make([]interface{}, 1)
-	}
 
 	if len(paths) == 0 {
 		return array
@@ -78,10 +92,18 @@ func writeArray(context interface{}, paths []string, value interface{}) []interf
 	log.Debugf("\tarray %v\n", array)
 
 	rawIndex := paths[0]
-	index, err := strconv.ParseInt(rawIndex, 10, 64)
+	var index int64
-	if err != nil {
+	// the append array indicator
-		die("Error accessing array: %v", err)
+	if rawIndex == "+" {
+		index = int64(len(array))
+	} else {
+		index, _ = strconv.ParseInt(rawIndex, 10, 64)
 	}
+	// writeArray is only called by updatedChildValue which handles parsing the
+	// index, as such this renders this dead code.
+	// if err != nil {
+	// 	return array, fmt.Errorf("Error accessing array: %v", err)
+	// }
 	for index >= int64(len(array)) {
 		array = append(array, nil)
 	}
@@ -89,13 +111,13 @@ func writeArray(context interface{}, paths []string, value interface{}) []interf
 
 	log.Debugf("\tcurrentChild %v\n", currentChild)
 
-	remainingPaths := paths[1:len(paths)]
+	remainingPaths := paths[1:]
 	array[index] = updatedChildValue(currentChild, remainingPaths, value)
 	log.Debugf("\tReturning array %v\n", array)
 	return array
 }
 
-func readMap(context yaml.MapSlice, head string, tail []string) interface{} {
+func readMap(context yaml.MapSlice, head string, tail []string) (interface{}, error) {
 	if head == "*" {
 		return readMapSplat(context, tail)
 	}
@@ -108,21 +130,25 @@ func readMap(context yaml.MapSlice, head string, tail []string) interface{} {
 	return calculateValue(value, tail)
 }
 
-func readMapSplat(context yaml.MapSlice, tail []string) interface{} {
+func readMapSplat(context yaml.MapSlice, tail []string) (interface{}, error) {
 	var newArray = make([]interface{}, len(context))
 	var i = 0
 	for _, entry := range context {
 		if len(tail) > 0 {
-			newArray[i] = recurse(entry.Value, tail[0], tail[1:len(tail)])
+			val, err := recurse(entry.Value, tail[0], tail[1:])
+			if err != nil {
+				return nil, err
+			}
+			newArray[i] = val
 		} else {
 			newArray[i] = entry.Value
 		}
 		i++
 	}
-	return newArray
+	return newArray, nil
 }
 
-func recurse(value interface{}, head string, tail []string) interface{} {
+func recurse(value interface{}, head string, tail []string) (interface{}, error) {
 	switch value.(type) {
 	case []interface{}:
 		if head == "*" {
@@ -130,37 +156,147 @@ func recurse(value interface{}, head string, tail []string) interface{} {
 		}
 		index, err := strconv.ParseInt(head, 10, 64)
 		if err != nil {
-			die("Error accessing array: %v", err)
+			return nil, fmt.Errorf("Error accessing array: %v", err)
 		}
 		return readArray(value.([]interface{}), index, tail)
 	case yaml.MapSlice:
 		return readMap(value.(yaml.MapSlice), head, tail)
 	default:
-		return nil
+		return nil, nil
 	}
 }
 
-func readArray(array []interface{}, head int64, tail []string) interface{} {
+func readArray(array []interface{}, head int64, tail []string) (interface{}, error) {
 	if head >= int64(len(array)) {
-		return nil
+		return nil, nil
 	}
 
 	value := array[head]
-
 	return calculateValue(value, tail)
 }
 
-func readArraySplat(array []interface{}, tail []string) interface{} {
+func readArraySplat(array []interface{}, tail []string) (interface{}, error) {
 	var newArray = make([]interface{}, len(array))
 	for index, value := range array {
-		newArray[index] = calculateValue(value, tail)
+		val, err := calculateValue(value, tail)
+		if err != nil {
+			return nil, err
+		}
+		newArray[index] = val
 	}
-	return newArray
+	return newArray, nil
 }
 
-func calculateValue(value interface{}, tail []string) interface{} {
+func calculateValue(value interface{}, tail []string) (interface{}, error) {
 	if len(tail) > 0 {
-		return recurse(value, tail[0], tail[1:len(tail)])
+		return recurse(value, tail[0], tail[1:])
 	}
-	return value
+	return value, nil
+}
+
+func mapToMapSlice(data map[interface{}]interface{}) yaml.MapSlice {
+	var mapSlice yaml.MapSlice
+
+	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)
+	}
+
+	// because the parsing of the yaml was done via a map the order will be inconsistent
+	// apply order to allow a consistent output
+	sort.SliceStable(mapSlice, func(i, j int) bool { return mapSlice[i].Key.(string) < mapSlice[j].Key.(string) })
+	return mapSlice
+}
+
+func deleteMap(context interface{}, paths []string) yaml.MapSlice {
+	log.Debugf("deleteMap for %v for %v\n", paths, context)
+
+	mapSlice := getMapSlice(context)
+
+	if len(paths) == 0 {
+		return mapSlice
+	}
+
+	var found bool
+	var index int
+	var child yaml.MapItem
+	for index, child = range mapSlice {
+		if child.Key == paths[0] {
+			found = true
+			break
+		}
+	}
+
+	if !found {
+		return mapSlice
+	}
+
+	remainingPaths := paths[1:]
+
+	var newSlice yaml.MapSlice
+	if len(remainingPaths) > 0 {
+		newChild := yaml.MapItem{Key: child.Key}
+		newChild.Value = deleteChildValue(child.Value, remainingPaths)
+
+		newSlice = make(yaml.MapSlice, len(mapSlice))
+		for i := range mapSlice {
+			item := mapSlice[i]
+			if i == index {
+				item = newChild
+			}
+			newSlice[i] = item
+		}
+	} else {
+		// Delete item from slice at index
+		newSlice = append(mapSlice[:index], mapSlice[index+1:]...)
+		log.Debugf("\tDeleted item index %d from mapSlice", index)
+	}
+
+	log.Debugf("\t\tlen: %d\tcap: %d\tslice: %v", len(mapSlice), cap(mapSlice), mapSlice)
+	log.Debugf("\tReturning mapSlice %v\n", mapSlice)
+	return newSlice
+}
+
+func deleteArray(context interface{}, paths []string, index int64) interface{} {
+	log.Debugf("deleteArray for %v for %v\n", paths, context)
+
+	array, ok := getArray(context)
+	if !ok {
+		// did not get an array
+		return context
+	}
+
+	if index >= int64(len(array)) {
+		return array
+	}
+
+	remainingPaths := paths[1:]
+	if len(remainingPaths) > 0 {
+		// Recurse into the array element at index
+		array[index] = deleteMap(array[index], remainingPaths)
+	} else {
+		// Delete the array element at index
+		array = append(array[:index], array[index+1:]...)
+		log.Debugf("\tDeleted item index %d from array, leaving %v", index, array)
+	}
+
+	log.Debugf("\tReturning array: %v\n", array)
+	return array
+}
+
+func deleteChildValue(child interface{}, remainingPaths []string) interface{} {
+	log.Debugf("deleteChildValue for %v for %v\n", remainingPaths, child)
+
+	idx, nextIndexErr := strconv.ParseInt(remainingPaths[0], 10, 64)
+	if nextIndexErr != nil {
+		// must be a map
+		log.Debugf("\tdetected a map, invoking deleteMap\n")
+		return deleteMap(child, remainingPaths)
+	}
+
+	log.Debugf("\tdetected an array, so traversing element with index %d\n", idx)
+	return deleteArray(child, remainingPaths, idx)
 }

data_navigator_test.go

@@ -2,18 +2,11 @@ package main
 
 import (
 	"fmt"
-	"github.com/op/go-logging"
-	"gopkg.in/yaml.v2"
-	"os"
 	"sort"
 	"testing"
-)
 
-func TestMain(m *testing.M) {
+	yaml "gopkg.in/yaml.v2"
-	backend.SetLevel(logging.ERROR, "")
+)
-	logging.SetBackend(backend)
-	os.Exit(m.Run())
-}
 
 func TestReadMap_simple(t *testing.T) {
 	var data = parseData(`
@@ -21,7 +14,8 @@ func TestReadMap_simple(t *testing.T) {
 b:
   c: 2
 `)
-	assertResult(t, 2, readMap(data, "b", []string{"c"}))
+	got, _ := readMap(data, "b", []string{"c"})
+	assertResult(t, 2, got)
 }
 
 func TestReadMap_splat(t *testing.T) {
@@ -31,7 +25,8 @@ mapSplat:
   item1: things
   item2: whatever
 `)
-	var result = readMap(data, "mapSplat", []string{"*"}).([]interface{})
+	res, _ := readMap(data, "mapSplat", []string{"*"})
+	result := res.([]interface{})
 	var actual = []string{result[0].(string), result[1].(string)}
 	sort.Strings(actual)
 	assertResult(t, "[things whatever]", fmt.Sprintf("%v", actual))
@@ -47,7 +42,8 @@ mapSplatDeep:
     cats: apples
 `)
 
-	var result = readMap(data, "mapSplatDeep", []string{"*", "cats"}).([]interface{})
+	res, _ := readMap(data, "mapSplatDeep", []string{"*", "cats"})
+	result := res.([]interface{})
 	var actual = []string{result[0].(string), result[1].(string)}
 	sort.Strings(actual)
 	assertResult(t, "[apples bananas]", fmt.Sprintf("%v", actual))
@@ -59,7 +55,8 @@ func TestReadMap_key_doesnt_exist(t *testing.T) {
 b:
   c: 2
 `)
-	assertResult(t, nil, readMap(data, "b.x.f", []string{"c"}))
+	got, _ := readMap(data, "b.x.f", []string{"c"})
+	assertResult(t, nil, got)
 }
 
 func TestReadMap_recurse_against_string(t *testing.T) {
@@ -67,7 +64,8 @@ func TestReadMap_recurse_against_string(t *testing.T) {
 ---
 a: cat
 `)
-	assertResult(t, nil, readMap(data, "a", []string{"b"}))
+	got, _ := readMap(data, "a", []string{"b"})
+	assertResult(t, nil, got)
 }
 
 func TestReadMap_with_array(t *testing.T) {
@@ -78,7 +76,64 @@ b:
     - 3
     - 4
 `)
-	assertResult(t, 4, readMap(data, "b", []string{"d", "1"}))
+	got, _ := readMap(data, "b", []string{"d", "1"})
+	assertResult(t, 4, got)
+}
+
+func TestReadMap_with_array_and_bad_index(t *testing.T) {
+	var data = parseData(`
+---
+b:
+  d:
+    - 3
+    - 4
+`)
+	_, err := readMap(data, "b", []string{"d", "x"})
+	if err == nil {
+		t.Fatal("Expected error due to invalid path")
+	}
+	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
+	assertResult(t, expectedOutput, err.Error())
+}
+
+func TestReadMap_with_mapsplat_array_and_bad_index(t *testing.T) {
+	var data = parseData(`
+---
+b:
+  d:
+    e:
+      - 3
+      - 4
+    f:
+      - 1
+      - 2
+`)
+	_, err := readMap(data, "b", []string{"d", "*", "x"})
+	if err == nil {
+		t.Fatal("Expected error due to invalid path")
+	}
+	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
+	assertResult(t, expectedOutput, err.Error())
+}
+
+func TestReadMap_with_arraysplat_map_array_and_bad_index(t *testing.T) {
+	var data = parseData(`
+---
+b:
+  d:
+    - names:
+        - fred
+        - smith
+    - names:
+        - sam
+        - bo
+`)
+	_, err := readMap(data, "b", []string{"d", "*", "names", "x"})
+	if err == nil {
+		t.Fatal("Expected error due to invalid path")
+	}
+	expectedOutput := `Error accessing array: strconv.ParseInt: parsing "x": invalid syntax`
+	assertResult(t, expectedOutput, err.Error())
 }
 
 func TestReadMap_with_array_out_of_bounds(t *testing.T) {
@@ -89,7 +144,8 @@ b:
     - 3
     - 4
 `)
-	assertResult(t, nil, readMap(data, "b", []string{"d", "3"}))
+	got, _ := readMap(data, "b", []string{"d", "3"})
+	assertResult(t, nil, got)
 }
 
 func TestReadMap_with_array_out_of_bounds_by_1(t *testing.T) {
@@ -100,7 +156,8 @@ b:
     - 3
     - 4
 `)
-	assertResult(t, nil, readMap(data, "b", []string{"d", "2"}))
+	got, _ := readMap(data, "b", []string{"d", "2"})
+	assertResult(t, nil, got)
 }
 
 func TestReadMap_with_array_splat(t *testing.T) {
@@ -113,7 +170,8 @@ e:
     name: Sam
     thing: dog
 `)
-	assertResult(t, "[Fred Sam]", fmt.Sprintf("%v", readMap(data, "e", []string{"*", "name"})))
+	got, _ := readMap(data, "e", []string{"*", "name"})
+	assertResult(t, "[Fred Sam]", fmt.Sprintf("%v", got))
 }
 
 func TestWrite_really_simple(t *testing.T) {
@@ -157,7 +215,8 @@ b:
 `)
 
 	updated := writeMap(data, []string{"b", "d", "f"}, "4")
-	assertResult(t, "4", readMap(updated, "b", []string{"d", "f"}))
+	got, _ := readMap(updated, "b", []string{"d", "f"})
+	assertResult(t, "4", got)
 }
 
 func TestWrite_array(t *testing.T) {
@@ -179,7 +238,8 @@ b:
 `)
 
 	updated := writeMap(data, []string{"b", "0"}, "4")
-	assertResult(t, "4", readMap(updated, "b", []string{"0"}))
+	got, _ := readMap(updated, "b", []string{"0"})
+	assertResult(t, "4", got)
 }
 
 func TestWrite_new_array_deep(t *testing.T) {
@@ -192,7 +252,8 @@ b:
 - c: "4"`
 
 	updated := writeMap(data, []string{"b", "0", "c"}, "4")
-	assertResult(t, expected, yamlToString(updated))
+	got, _ := yamlToString(updated)
+	assertResult(t, expected, got)
 }
 
 func TestWrite_new_map_array_deep(t *testing.T) {
@@ -202,7 +263,8 @@ b:
 `)
 
 	updated := writeMap(data, []string{"b", "d", "0"}, "4")
-	assertResult(t, "4", readMap(updated, "b", []string{"d", "0"}))
+	got, _ := readMap(updated, "b", []string{"d", "0"})
+	assertResult(t, "4", got)
 }
 
 func TestWrite_add_to_array(t *testing.T) {
@@ -216,8 +278,8 @@ b:
 - bb`
 
 	updated := writeMap(data, []string{"b", "1"}, "bb")
-
+	got, _ := yamlToString(updated)
-	assertResult(t, expected, yamlToString(updated))
+	assertResult(t, expected, got)
 }
 
 func TestWrite_with_no_tail(t *testing.T) {
@@ -246,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))
+}

docs/404.html

@@ -1,32 +1,46 @@
 
+
+
+
 <!DOCTYPE html>
-<html class="no-js">
+<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">
       
       
       
       
-        <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.5.4">
+        <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-56ade86843.js"></script>
+      <link rel="stylesheet" href="/assets/stylesheets/application.bcabdff3.css">
-    
-    
-      <link rel="stylesheet" href="/assets/stylesheets/application-b1a1975878.css">
-      
       
     
     
+      <script src="/assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
       
@@ -39,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -60,38 +71,46 @@
   <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">
           
-          <a href="/" title="Yaml" class="md-icon md-icon--home md-header-nav__button">
+            <i class="md-icon"></i>
-          </a>
           
+        </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">
-        <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>
           
-<div class="md-search" data-md-component="search">
+            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-  <div class="md-search__overlay"></div>
+            
+<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" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <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">close</button>
+      <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" 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__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
@@ -101,17 +120,18 @@
   </div>
 </div>
           
+        
       </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
+      
-        <div class="md-header-nav__source">
+        <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">
-  <a href="https://github.com/mikefarah/yaml" 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">
@@ -120,13 +140,13 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
-          
+          </div>
         </div>
-      </div>
+      
     </div>
   </nav>
 </header>
@@ -134,6 +154,8 @@
     <div class="md-container">
       
         
+      
+      
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
@@ -143,10 +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">
+    <span class="md-nav__button md-logo">
       
-      <i class="md-icon md-icon--home md-nav__button"></i>
+        <i class="md-icon"></i>
       
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -156,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">
@@ -165,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -214,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
@@ -233,6 +269,18 @@
   </li>
 
     
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="/merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
   </ul>
 </nav>
                   </div>
@@ -262,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>
       
@@ -286,8 +334,9 @@
       
     </div>
     
-      <script src="/assets/javascripts/application-0b7df094bf.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

@@ -0,0 +1 @@
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(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

@@ -0,0 +1 @@
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(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.multi.js

@@ -0,0 +1 @@
+!function(e,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(e.lunr)}(this,function(){return function(e){e.multiLanguage=function(){for(var i=Array.prototype.slice.call(arguments),t=i.join("-"),r="",n=[],s=[],p=0;p<i.length;++p)"en"==i[p]?(r+="\\w",n.unshift(e.stopWordFilter),n.push(e.stemmer),s.push(e.stemmer)):(r+=e[i[p]].wordCharacters,n.unshift(e[i[p]].stopWordFilter),n.push(e[i[p]].stemmer),s.push(e[i[p]].stemmer));var o=e.trimmerSupport.generateTrimmer(r);return e.Pipeline.registerFunction(o,"lunr-multi-trimmer-"+t),n.unshift(o),function(){this.pipeline.reset(),this.pipeline.add.apply(this.pipeline,n),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add.apply(this.searchPipeline,s))}}}});

docs/assets/javascripts/lunr/lunr.no.js

@@ -0,0 +1 @@
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(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.stemmer.support.js

@@ -0,0 +1 @@
+!function(r,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(r.lunr)}(this,function(){return function(r){r.stemmerSupport={Among:function(r,t,i,s){if(this.toCharArray=function(r){for(var t=r.length,i=new Array(t),s=0;s<t;s++)i[s]=r.charCodeAt(s);return i},!r&&""!=r||!t&&0!=t||!i)throw"Bad Among initialisation: s:"+r+", substring_i: "+t+", result: "+i;this.s_size=r.length,this.s=this.toCharArray(r),this.substring_i=t,this.result=i,this.method=s},SnowballProgram:function(){var r;return{bra:0,ket:0,limit:0,cursor:0,limit_backward:0,setCurrent:function(t){r=t,this.cursor=0,this.limit=t.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},getCurrent:function(){var t=r;return r=null,t},in_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e<=s&&e>=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor++,!0}return!1},in_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e<=s&&e>=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor--,!0}return!1},out_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e>s||e<i)return this.cursor++,!0;if(e-=i,!(t[e>>3]&1<<(7&e)))return this.cursor++,!0}return!1},out_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e>s||e<i)return this.cursor--,!0;if(e-=i,!(t[e>>3]&1<<(7&e)))return this.cursor--,!0}return!1},eq_s:function(t,i){if(this.limit-this.cursor<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor+s)!=i.charCodeAt(s))return!1;return this.cursor+=t,!0},eq_s_b:function(t,i){if(this.cursor-this.limit_backward<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor-t+s)!=i.charCodeAt(s))return!1;return this.cursor-=t,!0},find_among:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=t[a],m=l;m<_.s_size;m++){if(n+l==u){f=-1;break}if(f=r.charCodeAt(n+l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){if(o>=(_=t[s]).s_size){if(this.cursor=n+_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n+_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},find_among_b:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit_backward,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=(m=t[a]).s_size-1-l;_>=0;_--){if(n-l==u){f=-1;break}if(f=r.charCodeAt(n-1-l)-m.s[_])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var m=t[s];if(o>=m.s_size){if(this.cursor=n-m.s_size,!m.method)return m.result;var b=m.method();if(this.cursor=n-m.s_size,b)return m.result}if((s=m.substring_i)<0)return 0}},replace_s:function(t,i,s){var e=s.length-(i-t),n=r.substring(0,t),u=r.substring(i);return r=n+s+u,this.limit+=e,this.cursor>=i?this.cursor+=e:this.cursor>t&&(this.cursor=t),e},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>r.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),r.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}});

docs/assets/javascripts/lunr/lunr.sv.js

@@ -0,0 +1 @@
+!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(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,32 +1,46 @@
 
+
+
+
 <!DOCTYPE html>
-<html class="no-js">
+<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">
       
       
       
       
-        <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.5.4">
+        <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-56ade86843.js"></script>
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-b1a1975878.css">
-      
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
       
@@ -39,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -60,40 +71,46 @@
   <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">
           
-          <a href=".." title="Yaml" class="md-icon md-icon--home md-header-nav__button">
+            <i class="md-icon"></i>
-          </a>
           
+        </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">
-        <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
+        </div>
-          
-        </span>
       </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">
+            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-  <div class="md-search__overlay"></div>
+            
+<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" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <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">close</button>
+      <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" 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__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
@@ -103,17 +120,18 @@
   </div>
 </div>
           
+        
       </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
+      
-        <div class="md-header-nav__source">
+        <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">
-  <a href="https://github.com/mikefarah/yaml" 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,13 +140,13 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
-          
+          </div>
         </div>
-      </div>
+      
     </div>
   </nav>
 </header>
@@ -136,6 +154,8 @@
     <div class="md-container">
       
         
+      
+      
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
@@ -145,10 +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">
+    <span class="md-nav__button md-logo">
       
-      <i class="md-icon md-icon--home md-nav__button"></i>
+        <i class="md-icon"></i>
       
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -158,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">
@@ -167,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -216,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
@@ -274,6 +308,18 @@
   </li>
 
     
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
   </ul>
 </nav>
                   </div>
@@ -320,6 +366,8 @@
             <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>
                 
@@ -331,7 +379,7 @@
 </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>
@@ -345,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>
@@ -389,6 +437,20 @@ b:
           </a>
         
         
+          <a href="../merge/" title="Merge" 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>
+                Merge
+              </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>
   
@@ -397,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>
       
@@ -421,8 +483,9 @@ b:
       
     </div>
     
-      <script src="../assets/javascripts/application-0b7df094bf.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,32 +1,46 @@
 
+
+
+
 <!DOCTYPE html>
-<html class="no-js">
+<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">
       
       
       
       
-        <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.5.4">
+        <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-56ade86843.js"></script>
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-b1a1975878.css">
-      
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
       
@@ -39,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -60,40 +71,46 @@
   <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">
           
-          <a href=".." title="Yaml" class="md-icon md-icon--home md-header-nav__button">
+            <i class="md-icon"></i>
-          </a>
           
+        </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">
-        <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
+        </div>
-          
-        </span>
       </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">
+            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-  <div class="md-search__overlay"></div>
+            
+<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" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <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">close</button>
+      <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" 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__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
@@ -103,17 +120,18 @@
   </div>
 </div>
           
+        
       </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
+      
-        <div class="md-header-nav__source">
+        <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">
-  <a href="https://github.com/mikefarah/yaml" 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,13 +140,13 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
-          
+          </div>
         </div>
-      </div>
+      
     </div>
   </nav>
 </header>
@@ -136,6 +154,8 @@
     <div class="md-container">
       
         
+      
+      
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
@@ -145,10 +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">
+    <span class="md-nav__button md-logo">
       
-      <i class="md-icon md-icon--home md-nav__button"></i>
+        <i class="md-icon"></i>
       
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -158,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">
@@ -167,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -216,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 md-nav__item--active">
@@ -253,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>
@@ -274,6 +315,18 @@
   </li>
 
     
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
   </ul>
 </nav>
                   </div>
@@ -306,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>
@@ -320,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;
+<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>
@@ -344,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>
@@ -355,9 +417,24 @@ 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>
+                
                   
                 
               
@@ -375,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>
@@ -384,7 +461,7 @@ b.e[0].name: Howdy Partner
                 <span class="md-footer-nav__direction">
                   Previous
                 </span>
-                Write/Update
+                Delete
               </span>
             </div>
           </a>
@@ -412,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>
       
@@ -436,8 +513,9 @@ b.e[0].name: Howdy Partner
       
     </div>
     
-      <script src="../assets/javascripts/application-0b7df094bf.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,574 @@
+
+
+
+
+<!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="#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="#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|json_file&gt; &lt;path_to_delete&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:
+  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="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,32 +1,46 @@
 
+
+
+
 <!DOCTYPE html>
-<html class="no-js">
+<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">
       
       
       
       
-        <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.5.4">
+        <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-56ade86843.js"></script>
+      <link rel="stylesheet" href="./assets/stylesheets/application.bcabdff3.css">
-    
-    
-      <link rel="stylesheet" href="./assets/stylesheets/application-b1a1975878.css">
-      
       
     
     
+      <script src="./assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
       
@@ -39,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -60,40 +71,46 @@
   <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">
           
-          <a href="." title="Yaml" class="md-icon md-icon--home md-header-nav__button">
+            <i class="md-icon"></i>
-          </a>
           
+        </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">
-        <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
+        </div>
-          
-        </span>
       </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">
+            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-  <div class="md-search__overlay"></div>
+            
+<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" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <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">close</button>
+      <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" 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__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
@@ -103,17 +120,18 @@
   </div>
 </div>
           
+        
       </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
+      
-        <div class="md-header-nav__source">
+        <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">
-  <a href="https://github.com/mikefarah/yaml" 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,13 +140,13 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
-          
+          </div>
         </div>
-      </div>
+      
     </div>
   </nav>
 </header>
@@ -136,6 +154,8 @@
     <div class="md-container">
       
         
+      
+      
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
@@ -145,10 +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">
+    <span class="md-nav__button md-logo">
       
-      <i class="md-icon md-icon--home md-nav__button"></i>
+        <i class="md-icon"></i>
       
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -158,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">
@@ -167,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -208,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">
+  <a href="#install" title="Install" class="md-nav__link">
-    download latest binary
+    Install
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#get-the-source" title="get the source" class="md-nav__link">
-    get the source
   </a>
   
 </li>
@@ -259,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
@@ -278,6 +305,18 @@
   </li>
 
     
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
   </ul>
 </nav>
                   </div>
@@ -299,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">
+  <a href="#install" title="Install" class="md-nav__link">
-    download latest binary
+    Install
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#get-the-source" title="get the source" class="md-nav__link">
-    get the source
   </a>
   
 </li>
@@ -326,17 +358,26 @@
             <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>
+<h2 id="install">Install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h2>
-<h3 id="get-the-source">get the source<a class="headerlink" href="#get-the-source" title="Permanent link">&para;</a></h3>
+<p>On MacOS:</p>
-<pre><code class="bash">go get github.com/mikefarah/yaml
+<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>On Ubuntu and other Linux distros supporting <code>snap</code> packages:</p>
-<p><a href="https://github.com/mikefarah/yaml">View on GitHub</a></p>
+<pre><code>snap install yq
+</code></pre>
+
+<p>or, <a href="https://github.com/mikefarah/yq/releases/latest">Download latest binary</a> or alternatively:</p>
+<pre><code>go get github.com/mikefarah/yq
+</code></pre>
+
+<p><a href="https://github.com/mikefarah/yq">View on GitHub</a></p>
                 
                   
                 
@@ -378,9 +419,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>
       
@@ -402,8 +443,9 @@
       
     </div>
     
-      <script src="./assets/javascripts/application-0b7df094bf.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

@@ -0,0 +1,574 @@
+
+
+
+
+<!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>Merge - 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">
+                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>
+            
+<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">
+    <a href="../delete/" title="Delete" class="md-nav__link">
+      Delete
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../create/" title="Create" class="md-nav__link">
+      Create
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../convert/" title="Convert" class="md-nav__link">
+      Convert
+    </a>
+  </li>
+
+    
+      
+      
+      
+
+  
+
+
+  <li class="md-nav__item 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">
+        Merge
+      </label>
+    
+    <a href="./" title="Merge" class="md-nav__link md-nav__link--active">
+      Merge
+    </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="#updating-files-in-place" title="Updating files in-place" class="md-nav__link">
+    Updating files in-place
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#overwrite-values" title="Overwrite values" class="md-nav__link">
+    Overwrite values
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#overwrite-values-with-arrays" title="Overwrite values with arrays" class="md-nav__link">
+    Overwrite values with arrays
+  </a>
+  
+</li>
+      
+      
+      
+    </ul>
+  
+</nav>
+    
+  </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="#updating-files-in-place" title="Updating files in-place" class="md-nav__link">
+    Updating files in-place
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#overwrite-values" title="Overwrite values" class="md-nav__link">
+    Overwrite values
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#overwrite-values-with-arrays" title="Overwrite values with arrays" class="md-nav__link">
+    Overwrite values with arrays
+  </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/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>yq m &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>
+<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
+b: [1, 2]
+</code></pre>
+
+<p>and data2.yaml file of:</p>
+<pre><code class="yaml">a: other
+c:
+  test: 1
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq m data1.yaml data2.yaml
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">a: simple
+b: [1, 2]
+c:
+  test: 1
+</code></pre>
+
+<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 data1.yaml file of:</p>
+<pre><code class="yaml">a: simple
+b: [1, 2]
+</code></pre>
+
+<p>and data2.yaml file of:</p>
+<pre><code class="yaml">a: other
+c:
+  test: 1
+</code></pre>
+
+<p>then</p>
+<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>
+<h3 id="overwrite-values">Overwrite values<a class="headerlink" href="#overwrite-values" title="Permanent link">&para;</a></h3>
+<p>Given a data1.yaml file of:</p>
+<pre><code class="yaml">a: simple
+b: [1, 2]
+</code></pre>
+
+<p>and data2.yaml file of:</p>
+<pre><code class="yaml">a: other
+c:
+  test: 1
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq m -x data1.yaml data2.yaml
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">a: other
+b: [1, 2]
+c:
+  test: 1
+</code></pre>
+
+<h3 id="overwrite-values-with-arrays">Overwrite values with arrays<a class="headerlink" href="#overwrite-values-with-arrays" title="Permanent link">&para;</a></h3>
+<p>Given a data1.yaml file of:</p>
+<pre><code class="yaml">a: simple
+b: [1, 2]
+</code></pre>
+
+<p>and data3.yaml file of:</p>
+<pre><code class="yaml">b: [2, 3, 4]
+c:
+  test: 2
+  other: true
+d: false
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq m -x data1.yaml data3.yaml
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">a: simple
+b: [2, 3, 4]
+c:
+  test: 2
+  other: true
+d: false
+</code></pre>
+
+<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>
+                
+                  
+                
+              
+              
+                
+              
+            </article>
+          </div>
+        </div>
+      </main>
+      
+        
+<footer class="md-footer">
+  
+    <div class="md-footer-nav">
+      <nav class="md-footer-nav__inner md-grid">
+        
+          <a href="../convert/" title="Convert" 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>
+                Convert
+              </span>
+            </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/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,124 +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\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/#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"
-        }
-    ]
-}

docs/read/index.html

@@ -1,32 +1,46 @@
 
+
+
+
 <!DOCTYPE html>
-<html class="no-js">
+<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">
       
       
       
       
-        <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.5.4">
+        <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-56ade86843.js"></script>
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-b1a1975878.css">
-      
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
       
@@ -39,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -60,40 +71,46 @@
   <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">
           
-          <a href=".." title="Yaml" class="md-icon md-icon--home md-header-nav__button">
+            <i class="md-icon"></i>
-          </a>
           
+        </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">
-        <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
+        </div>
-          
-        </span>
       </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">
+            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-  <div class="md-search__overlay"></div>
+            
+<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" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <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">close</button>
+      <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" 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__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
@@ -103,17 +120,18 @@
   </div>
 </div>
           
+        
       </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
+      
-        <div class="md-header-nav__source">
+        <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">
-  <a href="https://github.com/mikefarah/yaml" 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,13 +140,13 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
-          
+          </div>
         </div>
-      </div>
+      
     </div>
   </nav>
 </header>
@@ -136,6 +154,8 @@
     <div class="md-container">
       
         
+      
+      
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
@@ -145,10 +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">
+    <span class="md-nav__button md-logo">
       
-      <i class="md-icon md-icon--home md-nav__button"></i>
+        <i class="md-icon"></i>
       
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -158,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">
@@ -167,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -234,13 +256,6 @@
     Splat
   </a>
   
-</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>
-  
 </li>
       
         <li class="md-nav__item">
@@ -257,6 +272,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>
@@ -283,6 +305,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
@@ -302,6 +336,18 @@
   </li>
 
     
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
   </ul>
 </nav>
                   </div>
@@ -339,13 +385,6 @@
     Splat
   </a>
   
-</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>
-  
 </li>
       
         <li class="md-nav__item">
@@ -362,6 +401,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>
@@ -376,10 +422,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>
@@ -390,13 +438,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>
@@ -411,7 +459,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>
@@ -419,17 +467,6 @@ 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>
-<p>Given a sample.yaml file of:</p>
-<pre><code class="yaml">b.x:
-  c: 2
-</code></pre>
-
-<p>then</p>
-<pre><code class="bash">yaml r sample.yaml \&quot;b.x\&quot;.c
-</code></pre>
-
-<p>will output the value of '2'.</p>
 <h3 id="arrays">Arrays<a class="headerlink" href="#arrays" title="Permanent link">&para;</a></h3>
 <p>You can give an index to access a specific element:
 e.g.: given a sample file of</p>
@@ -442,10 +479,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:
@@ -457,7 +495,7 @@ 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>
@@ -465,6 +503,22 @@ e.g.: given a sample file of</p>
 - 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>
+                
                   
                 
               
@@ -519,9 +573,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>
       
@@ -543,8 +597,9 @@ e.g.: given a sample file of</p>
       
     </div>
     
-      <script src="../assets/javascripts/application-0b7df094bf.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,189 @@
+{
+    "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\nor, \nDownload latest binary\n or alternatively:\n\n\ngo get github.com/mikefarah/yq\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  or,  Download latest binary  or alternatively:  go get github.com/mikefarah/yq  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\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/#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|json_file> <path> <new value>\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\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\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/#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|json_file> <path_to_delete>\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\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\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/#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.\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 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\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 be used with any 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|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\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.",
+            "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"
+        }
+    ]
+}

docs/sitemap.xml

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

docs/write/index.html

@@ -1,32 +1,46 @@
 
+
+
+
 <!DOCTYPE html>
-<html class="no-js">
+<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">
       
       
       
       
-        <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.5.4">
+        <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-56ade86843.js"></script>
+      <link rel="stylesheet" href="../assets/stylesheets/application.bcabdff3.css">
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/application-b1a1975878.css">
-      
       
     
     
+      <script src="../assets/javascripts/modernizr.1aa3b519.js"></script>
     
     
       
@@ -39,9 +53,6 @@
     
   </head>
   
-  
-  
-  
     <body>
   
     <svg class="md-svg">
@@ -60,40 +71,46 @@
   <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">
           
-          <a href=".." title="Yaml" class="md-icon md-icon--home md-header-nav__button">
+            <i class="md-icon"></i>
-          </a>
           
+        </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">
-        <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
+        </div>
-          
-        </span>
       </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">
+            <label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
-  <div class="md-search__overlay"></div>
+            
+<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" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
+      <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">close</button>
+      <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" 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__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
@@ -103,17 +120,18 @@
   </div>
 </div>
           
+        
       </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
+      
-        <div class="md-header-nav__source">
+        <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">
-  <a href="https://github.com/mikefarah/yaml" 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,13 +140,13 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
-          
+          </div>
         </div>
-      </div>
+      
     </div>
   </nav>
 </header>
@@ -136,6 +154,8 @@
     <div class="md-container">
       
         
+      
+      
       <main class="md-main">
         <div class="md-main__inner md-grid" data-md-component="container">
           
@@ -145,10 +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">
+    <span class="md-nav__button md-logo">
       
-      <i class="md-icon md-icon--home md-nav__button"></i>
+        <i class="md-icon"></i>
       
-    Yaml
+    </span>
+    Yq
   </label>
   
     <div class="md-nav__source">
@@ -158,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">
@@ -167,7 +189,7 @@
       </div>
     
     <div class="md-source__repository">
-      mikefarah/yaml
+      mikefarah/yq
     </div>
   </a>
 
@@ -246,6 +268,13 @@
     Adding new fields
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#appending-value-to-an-array-field" title="Appending value to an array field" class="md-nav__link">
+    Appending value to an array field
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -269,6 +298,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>
@@ -283,6 +319,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
@@ -302,6 +350,18 @@
   </li>
 
     
+      
+      
+      
+
+
+  <li class="md-nav__item">
+    <a href="../merge/" title="Merge" class="md-nav__link">
+      Merge
+    </a>
+  </li>
+
+    
   </ul>
 </nav>
                   </div>
@@ -339,6 +399,13 @@
     Adding new fields
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#appending-value-to-an-array-field" title="Appending value to an array field" class="md-nav__link">
+    Appending value to an array field
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -362,6 +429,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>
@@ -376,10 +450,12 @@
             <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|json_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>
@@ -390,7 +466,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>
@@ -399,7 +475,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>
@@ -410,7 +486,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>
@@ -420,6 +496,29 @@
     - new thing
 </code></pre>
 
+<h3 id="appending-value-to-an-array-field">Appending value to an array field<a class="headerlink" href="#appending-value-to-an-array-field" title="Permanent link">&para;</a></h3>
+<p>Given a sample.yaml file of:</p>
+<pre><code class="yaml">b:
+  c: 2
+  d:
+    - new thing
+    - foo thing
+</code></pre>
+
+<p>then</p>
+<pre><code class="bash">yq w sample.yaml &quot;b.d[+]&quot; &quot;bar thing&quot;
+</code></pre>
+
+<p>will output:</p>
+<pre><code class="yaml">b:
+  c: cat
+  d:
+    - new thing
+    - foo thing
+    - 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="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:
@@ -427,7 +526,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>
@@ -445,7 +544,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>
@@ -456,12 +555,12 @@ 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>
@@ -469,6 +568,21 @@ b.e[0].name: Howdy Partner
   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>
+                
                   
                 
               
@@ -501,13 +615,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">
@@ -523,9 +637,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>
       
@@ -547,8 +661,9 @@ b.e[0].name: Howdy Partner
       
     </div>
     
-      <script src="../assets/javascripts/application-0b7df094bf.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/array.yaml

@@ -0,0 +1,9 @@
+---
+- become: true
+  gather_facts: false
+  hosts: lalaland
+  name: "Apply smth"
+  roles:
+    - lala
+    - land
+  serial: 1

examples/data1.yaml

@@ -0,0 +1,2 @@
+a: simple
+b: [1, 2]

examples/data2.yaml

@@ -0,0 +1,3 @@
+a: other
+c:
+  test: 1

examples/data3.yaml

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

examples/multiline-text.yaml

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

json_converter.go

@@ -2,15 +2,18 @@ package main
 
 import (
 	"encoding/json"
-	"gopkg.in/yaml.v2"
+	"fmt"
+	"strconv"
+
+	yaml "gopkg.in/yaml.v2"
 )
 
-func jsonToString(context interface{}) string {
+func jsonToString(context interface{}) (string, error) {
 	out, err := json.Marshal(toJSON(context))
 	if err != nil {
-		die("error printing yaml as json: ", err)
+		return "", fmt.Errorf("error printing yaml as json: %v", err)
 	}
-	return string(out)
+	return string(out), nil
 }
 
 func toJSON(context interface{}) interface{} {
@@ -26,7 +29,13 @@ func toJSON(context interface{}) interface{} {
 		oldMap := context.(yaml.MapSlice)
 		newMap := make(map[string]interface{})
 		for _, entry := range oldMap {
-			newMap[entry.Key.(string)] = toJSON(entry.Value)
+			if str, ok := entry.Key.(string); ok {
+				newMap[str] = toJSON(entry.Value)
+			} else if i, ok := entry.Key.(int); ok {
+				newMap[strconv.Itoa(i)] = toJSON(entry.Value)
+			} else if b, ok := entry.Key.(bool); ok {
+				newMap[strconv.FormatBool(b)] = toJSON(entry.Value)
+			}
 		}
 		return newMap
 	default:

json_converter_test.go

@@ -10,7 +10,28 @@ func TestJsonToString(t *testing.T) {
 b:
   c: 2
 `)
-	assertResult(t, "{\"b\":{\"c\":2}}", jsonToString(data))
+	got, _ := jsonToString(data)
+	assertResult(t, "{\"b\":{\"c\":2}}", got)
+}
+
+func TestJsonToString_withIntKey(t *testing.T) {
+	var data = parseData(`
+---
+b:
+  2: c
+`)
+	got, _ := jsonToString(data)
+	assertResult(t, `{"b":{"2":"c"}}`, got)
+}
+
+func TestJsonToString_withBoolKey(t *testing.T) {
+	var data = parseData(`
+---
+b:
+  false: c
+`)
+	got, _ := jsonToString(data)
+	assertResult(t, `{"b":{"false":"c"}}`, got)
 }
 
 func TestJsonToString_withArray(t *testing.T) {
@@ -20,5 +41,6 @@ b:
   - item: one
   - item: two
 `)
-	assertResult(t, "{\"b\":[{\"item\":\"one\"},{\"item\":\"two\"}]}", jsonToString(data))
+	got, _ := jsonToString(data)
+	assertResult(t, "{\"b\":[{\"item\":\"one\"},{\"item\":\"two\"}]}", got)
 }

merge.go

@@ -0,0 +1,12 @@
+package main
+
+import (
+	"github.com/imdario/mergo"
+)
+
+func merge(dst, src interface{}, overwrite bool) error {
+	if overwrite {
+		return mergo.MergeWithOverwrite(dst, src)
+	}
+	return mergo.Merge(dst, src)
+}

merge_test.go

@@ -0,0 +1,30 @@
+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,15 +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
-repo_name: 'mikefarah/yaml'
+    - Merge: merge.md
-repo_url: 'https://github.com/mikefarah/yaml'
+repo_name: 'mikefarah/yq'
+repo_url: 'https://github.com/mikefarah/yq'
 
 extra:
   social:

mkdocs/convert.md

@@ -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 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,63 @@
+```
+yq d <yaml_file|json_file> <path_to_delete>
+```
+{!snippets/works_with_json.md!}
+
+### 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
+
+
+{!snippets/keys_with_dots.md!}

mkdocs/index.md

@@ -1,16 +1,20 @@
-# yaml
+# yq
-yaml is a lightweight and portable command-line YAML processor
+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)
+## Install
-
+On MacOS:
-### get the source
+```
-```bash
+brew install yq
-go get github.com/mikefarah/yaml
+```
+On Ubuntu and other Linux distros supporting `snap` packages:
+```
+snap install yq
+```
+or, [Download latest binary](https://github.com/mikefarah/yq/releases/latest) or alternatively:
+```
+go get github.com/mikefarah/yq
 ```
 
-[.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/yq)
-
-[View on GitHub](https://github.com/mikefarah/yaml)
-

mkdocs/merge.md

@@ -0,0 +1,104 @@
+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.
+
+```
+yq m <yaml_file|json_file> <path>...
+```
+{!snippets/works_with_json.md!}
+
+### To Stdout
+Given a data1.yaml file of:
+```yaml
+a: simple
+b: [1, 2]
+```
+and data2.yaml file of:
+```yaml
+a: other
+c:
+  test: 1
+```
+then
+```bash
+yq m data1.yaml data2.yaml
+```
+will output:
+```yaml
+a: simple
+b: [1, 2]
+c:
+  test: 1
+```
+
+### Updating files in-place
+Given a data1.yaml file of:
+```yaml
+a: simple
+b: [1, 2]
+```
+and data2.yaml file of:
+```yaml
+a: other
+c:
+  test: 1
+```
+then
+```bash
+yq m -i data1.yaml data2.yaml
+```
+will update the data1.yaml file so that the value of 'c' is 'test: 1'.
+
+### Overwrite values
+Given a data1.yaml file of:
+```yaml
+a: simple
+b: [1, 2]
+```
+and data2.yaml file of:
+```yaml
+a: other
+c:
+  test: 1
+```
+then
+```bash
+yq m -x data1.yaml data2.yaml
+```
+will output:
+```yaml
+a: other
+b: [1, 2]
+c:
+  test: 1
+```
+
+### Overwrite values with arrays
+Given a data1.yaml file of:
+```yaml
+a: simple
+b: [1, 2]
+```
+and data3.yaml file of:
+```yaml
+b: [2, 3, 4]
+c:
+  test: 2
+  other: true
+d: false
+```
+then
+```bash
+yq m -x data1.yaml data3.yaml
+```
+will output:
+```yaml
+a: simple
+b: [2, 3, 4]
+c:
+  test: 2
+  other: true
+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.

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,18 +43,6 @@ will output
 - apples
 ```
 
-### Handling '.' in the yaml key
-Given a sample.yaml file of:
-```yaml
-b.x:
-  c: 2
-```
-then
-```bash
-yaml r sample.yaml \"b.x\".c
-```
-will output the value of '2'.
-
 ### Arrays
 You can give an index to access a specific element:
 e.g.: given a sample file of
@@ -68,10 +56,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 +74,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,5 +1,5 @@
 ```
-yaml w <yaml_file|json_file> <path> <new value>
+yq w <yaml_file|json_file> <path> <new value>
 ```
 {!snippets/works_with_json.md!}
 
@@ -11,7 +11,7 @@ b:
 ```
 then
 ```bash
-yaml w sample.yaml b.c cat
+yq w sample.yaml b.c cat
 ```
 will output:
 ```yaml
@@ -21,7 +21,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 +34,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
@@ -44,6 +44,31 @@ b:
     - new thing
 ```
 
+### Appending value to an array field
+Given a sample.yaml file of:
+```yaml
+b:
+  c: 2
+  d:
+    - new thing
+    - foo thing
+```
+then
+```bash
+yq w sample.yaml "b.d[+]" "bar thing"
+```
+will output:
+```yaml
+b:
+  c: cat
+  d:
+    - new thing
+    - foo thing
+    - bar thing
+```
+
+Note that the path is in quotes to avoid the square brackets being interpreted by your shell.
+
 ### Updating files in-place
 Given a sample.yaml file of:
 ```yaml
@@ -52,7 +77,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.
 
@@ -73,7 +98,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
@@ -85,14 +110,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
@@ -100,3 +125,5 @@ will output
 my:
   path: -3
 ```
+
+{!snippets/keys_with_dots.md!}

path_parser.go

@@ -16,13 +16,13 @@ func nextYamlPath(path string) (pathElement string, remaining string) {
 	switch path[0] {
 	case '[':
 		// e.g [0].blah.cat -> we need to return "0" and "blah.cat"
-		return search(path[1:len(path)], []uint8{']'}, true)
+		return search(path[1:], []uint8{']'}, true)
 	case '"':
 		// e.g "a.b".blah.cat -> we need to return "a.b" and "blah.cat"
-		return search(path[1:len(path)], []uint8{'"'}, true)
+		return search(path[1:], []uint8{'"'}, true)
 	default:
 		// e.g "a.blah.cat" -> return "a" and "blah.cat"
-		return search(path[0:len(path)], []uint8{'.', '['}, false)
+		return search(path[0:], []uint8{'.', '['}, false)
 	}
 }
 
@@ -39,7 +39,7 @@ func search(path string, matchingChars []uint8, skipNext bool) (pathElement stri
 			if remainingStart > len(path) {
 				remainingStart = len(path)
 			}
-			return path[0:i], path[remainingStart:len(path)]
+			return path[0:i], path[remainingStart:]
 		}
 	}
 	return path, ""

path_parser_test.go

@@ -10,11 +10,12 @@ var parsePathsTests = []struct {
 }{
 	{"a.b", []string{"a", "b"}},
 	{"a.b[0]", []string{"a", "b", "0"}},
+	{"a.b.d[+]", []string{"a", "b", "d", "+"}},
 }
 
-func testParsePath(t *testing.T) {
+func TestParsePath(t *testing.T) {
 	for _, tt := range parsePathsTests {
-		assertResultWithContext(t, tt.expectedPaths, parsePath(tt.path), tt)
+		assertResultComplex(t, tt.expectedPaths, parsePath(tt.path))
 	}
 }
 

precheckin.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-set -e
-
-gofmt -w .
-golint
-./ci.sh
-
-go install

scripts/acceptance.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+# acceptance test
+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/check.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+
+gometalinter \
+  --skip=examples \
+  --tests \
+  --vendor \
+  --disable=aligncheck \
+  --disable=gotype \
+  --disable=goconst \
+  --cyclo-over=20 \
+  --deadline=300s \
+  ./...
+
+gometalinter \
+  --skip=examples \
+  --tests \
+  --vendor \
+  --disable=aligncheck \
+  --disable=gotype \
+  --disable=goconst \
+  --disable=gocyclo \
+  --deadline=300s \
+  ./...

scripts/coverage.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+
+go test -coverprofile=coverage.out
+go tool cover -html=coverage.out -o cover/coverage.html

scripts/devtools.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+go get -u github.com/alecthomas/gometalinter
+go get -u golang.org/x/tools/cmd/goimports
+go get -u github.com/mitchellh/gox
+go get -u github.com/kardianos/govendor
+go get -u github.com/aktau/github-release
+
+# install all the linters
+gometalinter --install --update

scripts/doctools.sh

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

scripts/format.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+find . \( -path ./vendor \) -prune -o -name "*.go" -exec goimports -w {} \;

scripts/publish.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+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="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"
+}
+
+upload() {
+    mapfile -t files < <(find ./build -mindepth 1 -maxdepth 1)
+    for file in "${files[@]}"; do
+        BINARY=$(basename "${file}")
+        echo "--> ${BINARY}"
+        github-release upload \
+            --user "$OWNER" \
+            --repo "$REPO" \
+            --tag "$CURRENT" \
+            --name "${BINARY}" \
+            --file "$file"
+    done
+}
+
+release
+upload

scripts/setup.sh

@@ -0,0 +1,92 @@
+#!/bin/bash
+
+set -eu
+
+find_mgr() {
+    if hash minishift 2>/dev/null; then
+        echo "minishift"
+    else
+        if hash docker-machine 2>/dev/null; then
+            echo "docker-machine"
+        fi
+    fi
+}
+
+get_vm_name() {
+    case "$1" in
+        minishift)
+            echo "minishift"
+            ;;
+        docker-machine)
+            echo "${DOCKER_MACHINE_NAME}"
+            ;;
+        *)
+            ;;
+    esac
+}
+
+is_vm_running() {
+    local vm=$1
+    declare -a running=($(VBoxManage list runningvms | awk '{ print $1 }'))
+    local result='false'
+
+    for rvm in "${running[@]}"; do
+        if [[ "${rvm}" == *"${vm}"* ]]; then
+            result='true'
+        fi
+    done
+    echo "$result"
+}
+
+if hash cygpath 2>/dev/null; then
+    PROJECT_DIR=$(cygpath -w -a "$(pwd)")
+else
+    PROJECT_DIR=$(pwd)
+fi
+
+VM_MGR=$(find_mgr)
+if [[ -z $VM_MGR ]]; then
+    echo "ERROR: No VM Manager found; expected one of ['minishift', 'docker-machine']"
+    exit 1
+fi
+
+VM_NAME=$(get_vm_name "$VM_MGR")
+if [[ -z $VM_NAME ]]; then
+    echo "ERROR: No VM found; try running 'eval $(docker-machine env)'"
+    exit 1
+fi
+
+if ! hash VBoxManage 2>/dev/null; then
+    echo "VirtualBox executable 'VBoxManage' not found in path"
+    exit 1
+fi
+
+avail=$(is_vm_running "$VM_NAME")
+if [[ "$avail" == *"true"* ]]; then
+    res=$(VBoxManage sharedfolder add "${VM_NAME}" --name "${PROJECT}" --hostpath "${PROJECT_DIR}" --transient 2>&1)
+    if [[ -z $res || $res == *"already exists"* ]]; then
+        # no need to show that it already exists
+        :
+    else
+        echo "$res"
+        exit 1
+    fi
+    echo "VM: [${VM_NAME}] -- Added Sharedfolder [${PROJECT}] @Path [${PROJECT_DIR}]"
+else
+    echo "$VM_NAME is not currently running; please start your VM and try again."
+    exit 1
+fi
+
+SSH_CMD="sudo mkdir -p /${PROJECT} ; sudo mount -t vboxsf ${PROJECT} /${PROJECT}"
+case "${VM_MGR}" in
+    minishift)
+        minishift ssh "${SSH_CMD}"
+        echo "VM: [${VM_NAME}] -- Mounted Sharedfolder [${PROJECT}] @VM Path [/${PROJECT}]"
+        ;;
+    docker-machine)
+        docker-machine ssh "${VM_NAME}" "${SSH_CMD}"
+        echo "VM: [${VM_NAME}] -- Mounted Sharedfolder [${PROJECT}] @VM Path [/${PROJECT}]"
+        ;;
+    *)
+        ;;
+esac

scripts/test.sh

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

scripts/xcompile.sh

@@ -3,6 +3,5 @@
 # This assumes that gonative and gox is installed as per the 'one time setup' instructions
 # at https://github.com/inconshreveable/gonative
 
-rm  build/*
+gox -ldflags "${LDFLAGS}" -output="build/{{.Dir}}_{{.OS}}_{{.Arch}}"
-gox -output="build/{{.Dir}}_{{.OS}}_{{.Arch}}"
 

snap/snapcraft.yaml

@@ -0,0 +1,22 @@
+name: yq
+version: 1.14.1
+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