suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2025-03-10 02:58:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
mfarah 2015-09-28 10:50:32 +10:00
parent 17e05d14ab
commit 6550822778
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -3,26 +3,32 @@ yaml command line tool written in go
Allows you to read (and soon update) yaml files given a yaml path. Allows you to read (and soon update) yaml files given a yaml path.
Install ## Install
``` ```
go get github.com/mikefarah/yaml go get github.com/mikefarah/yaml
``` ```
Usage: ## Read examples
``` ```
yaml <yaml file> <path> yaml <yaml file> <path>
``` ```
E.g.: ### Basic
Given a sample.yaml file of:
```yaml
b:
c: 2
``` ```
then
```bash
yaml sample.yaml b.c yaml sample.yaml b.c
``` ```
will output the value of '2'. will output the value of '2'.
Arrays: ### Arrays
Just use the index to access a specific element: You can give an index to access a specific element:
e.g.: given e.g.: given a sample file of
``` ```yaml
b: b:
e: e:
- name: fred - name: fred
@ -35,3 +41,7 @@ then
yaml sample.yaml b.e.1.name yaml sample.yaml b.e.1.name
``` ```
will output 'sam' will output 'sam'
## TODO
* Updating yaml files
* Handling '.' in path names