You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
fx/README.md

95 lines
2.4 KiB
Markdown

<p align="center"><img src="https://user-images.githubusercontent.com/141232/35405308-4b41f446-0238-11e8-86c1-21f407cc8460.png" height="100" alt="fx"></p>
6 years ago
<p align="center"><img src="https://medv.io/assets/fx.gif" width="562" alt="fx example"></p>
_* Function eXecution_
7 years ago
[![Build Status](https://travis-ci.org/antonmedv/fx.svg?branch=master)](https://travis-ci.org/antonmedv/fx)
6 years ago
[![Npm Version](https://badgen.net/npm/v/fx)](https://www.npmjs.com/package/fx)
[![Brew Version](https://badgen.net/homebrew/v/fx)](https://formulae.brew.sh/formula/fx)
7 years ago
Command-line JSON processing tool
## Features
* Formatting and highlighting
6 years ago
* Standalone binary
* Interactive mode 🎉
* Themes support 🎨
7 years ago
## Install
```
$ npm install -g fx
```
6 years ago
Or via Homebrew
```
$ brew install fx
```
7 years ago
7 years ago
Or download standalone binary from [releases](https://github.com/antonmedv/fx/releases) page.
6 years ago
<a href="https://www.patreon.com/antonmedv">
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
</a>
7 years ago
## Usage
6 years ago
Start [interactive mode](https://github.com/antonmedv/fx/blob/master/docs.md#interactive-mode) without passing any arguments.
7 years ago
```
$ curl ... | fx
7 years ago
```
6 years ago
Or by passing filename as first argument.
```
6 years ago
$ fx data.json
6 years ago
```
6 years ago
6 years ago
Pipe into `fx` any JSON and anonymous function for reducing it.
```bash
$ curl ... | fx 'json => json.message'
```
6 years ago
Or same as above but short.
6 years ago
```bash
$ curl ... | fx this.message
$ curl ... | fx .message
```
6 years ago
Pass any numbers of arguments as code.
6 years ago
```bash
$ curl ... | fx 'json => json.message' 'json => json.filter(x => x.startsWith("a"))'
```
Access all lodash (or ramda, etc) methods by using [.fxrc](https://github.com/antonmedv/fx/blob/master/docs.md#using-fxrc) file.
```bash
$ curl ... | fx '_.mapValues(_.groupBy(this, "commit.committer.name"), _.size)'
6 years ago
```
6 years ago
Update JSON using spread operator.
```bash
$ echo '{"count": 0}' | fx '{...this, count: 1}'
{
"count": 1
}
6 years ago
```
6 years ago
Pretty print JSON with dot.
```bash
$ curl ... | fx .
```
6 years ago
## Documentation
6 years ago
6 years ago
See full [documentation](https://github.com/antonmedv/fx/blob/master/docs.md).
7 years ago
## Related
6 years ago
* [xx](https://github.com/antonmedv/xx) - fx-like JSON tool (*go*)
6 years ago
* [ymlx](https://github.com/matthewadams/ymlx) - fx-like YAML cli processor
* [fx-theme-monokai](https://github.com/antonmedv/fx-theme-monokai) monokai theme
6 years ago
* [fx-theme-night](https://github.com/antonmedv/fx-theme-night) night theme
7 years ago
## License
[MIT](https://github.com/antonmedv/fx/blob/master/LICENSE)