fx/README.md

Command-line JSON processing tool

Features

• Don't need to learn new syntax
• Plain JavaScript
• Formatting and highlighting

Install

$ npm install -g fx

Usage

Pipe into fx any JSON and anonymous function for reducing it.

$ fx [code ...]

Pretty print JSON without passing any arguments:

$ echo '{"key":"value"}' | fx
{
    "key": "value"
}

Anonymous function

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

$ echo '{"foo": [{"bar": "value"}]}' | fx '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 JSON by this keyword:

$ echo '{"foo": [{"bar": "value"}]}' | fx 'this.foo[0].bar'
"value"

Chain

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

$ echo '{"foo": [{"bar": "value"}]}' | fx 'x => x.foo' 'this[0]' 'this.bar'
"value"

Generator

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

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

Access to JSON through this keyword:

$ echo '["a", "b"]' | fx 'yield* this'
[
    "a",
    "b"
]

$ echo '["a", "b"]' | fx 'yield* this; yield "c";'
[
    "a",
    "b",
    "c"
]

Update

You can update existing JSON using spread operator:

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

Use npm package

Use any npm package by installing it globally:

$ npm install -g lodash
$ cat package.json | fx 'require("lodash").keys(this.dependencies)'

Formatting

If you need something different then JSON (for example arguments for xargs) do not return anything from reducer. Undefined value printed into stderr by default.

echo '[]' | fx 'void 0'
undefined

echo '[1,2,3]' | fx 'this.forEach(x => console.log(x))' 2>/dev/null | xargs echo
1 2 3

Other examples

Convert object to array:

$ cat package.json | fx 'Object.keys(this.dependencies)'
[
    "cardinal",
    "get-stdin",
    "meow"
]

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