Skip to content
Command-line YAML processor
Branch: master
Clone or download
Latest commit dcf7b42 Feb 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test bang Mar 18, 2018
.gitignore add pkg Jul 1, 2018
.npmrc bang Mar 18, 2018
.travis.yml node 9 -> 8, add Dockerfile Aug 11, 2018
Dockerfile node 9 -> 8, add Dockerfile Aug 11, 2018
LICENSE fixes #2 (#3) Feb 6, 2019
README.md fixed Inspiration (#1) Nov 9, 2018
index.js bang Mar 18, 2018
package-lock.json update package-lock.json Aug 31, 2018
package.json add reduce.js to files, bump to 1.0.7 Aug 31, 2018
reduce.js bang Mar 18, 2018

README.md

Command-line YAML processing tool

Features

  • Plain JavaScript to manipulate document(s)

Install

$ npm install -g ymlx

Usage

Pipe into ymlx any YAML and anonymous function for reducing it.

$ cat my.yaml | ymlx [code ...]

Anonymous function

Use an anonymous function as reducer which gets YAML as an object and processes it:

$ echo 'foo: [bar: value]' | ymlx 'x => x.foo[0].bar'
value

this Binding

If you don't pass anonymous function param => ..., code will be automatically transformed into anonymous function. And you can get access to YAML by this keyword:

$ echo 'foo: [bar: value]' | ymlx 'this.foo[0].bar'
value

Multiple Documents

You can pass a YAML file with multiple documents (using the --- separator), and your commands will be applied to each document.

# test.yml
---
foo:
- bar: value
---
foo:
- bar: another
$ cat test.yml | ymlx 'this.foo[0].bar'
---
value
---
another

Chain

You can pass any number of anonymous functions for reducing JSON:

$ echo 'foo: [bar: value]' | ymlx 'x => x.foo' 'this[0]' 'this.bar'
value

Generator

If passed code contains yield keyword, generator expression will be used:

$ curl ... | ymlx 'for (let user of this) if (user.login.startsWith("a")) yield user'

Access to YAML through this keyword:

# test.yml
- a
- b
$ cat test.yml | ymlx 'yield* this'
- a
- b
$ cat test.yml | ymlx 'yield* this; yield "c";'
- a
- b
- c

Update

You can update existing YAML using spread operator:

$ echo 'count: 0' | ymlx '{...this, count: 1}'
count: 1

Use npm package

Use any npm package by installing globally or in the current working directory:

$ npm install lodash # -g if you want
$ cat 'count: 0' | ymlx 'require("lodash").keys(this)'
- count

Formatting

$ echo '[1,2,3]' | ymlx 'this.reduce((a,n) => a += n.toString(), "concat: ")'
'concat: 123'

Inspiration

ymlx was inspired by fx

Related

  • jq – cli JSON processor on C
  • jsawk – like awk, but for JSON
  • json – another JSON manipulating cli library
  • jl – functional sed for JSON on Haskell

License

MIT

You can’t perform that action at this time.