mirror of
https://github.com/antonmedv/fx
synced 2024-11-09 07:10:38 +00:00
121 lines
3.0 KiB
Markdown
121 lines
3.0 KiB
Markdown
<p align="center"><img src="https://medv.io/assets/fx-logo.png" height="100" alt="fx logo"></p>
|
||
<p align="center"><img src="https://medv.io/assets/fx.gif" width="562" alt="fx example"></p>
|
||
|
||
_* Function eXecution_
|
||
|
||
[](https://travis-ci.org/antonmedv/fx)
|
||
[](https://www.npmjs.com/package/fx)
|
||
[](https://formulae.brew.sh/formula/fx)
|
||
[](https://snapcraft.io/fx)
|
||
|
||
Command-line JSON processing tool
|
||
|
||
## Features
|
||
|
||
* Formatting and highlighting
|
||
* Standalone binary
|
||
* Interactive mode 🎉
|
||
* Themes support 🎨
|
||
|
||
## Install
|
||
|
||
```
|
||
$ npm install -g fx
|
||
```
|
||
Or via Homebrew
|
||
```
|
||
$ brew install fx
|
||
```
|
||
|
||
Or download standalone binary from [releases](https://github.com/antonmedv/fx/releases) page.
|
||
|
||
<p>
|
||
<a href="https://www.patreon.com/antonmedv"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160"></a>
|
||
<a href="https://www.wispay.io/t/ZQb" target="_blank"><img src="https://assets.wispay.io/wgt2_d_b.png" height="60"></a>
|
||
</p>
|
||
|
||
## Usage
|
||
|
||
Start [interactive mode](https://github.com/antonmedv/fx/blob/master/docs.md#interactive-mode) without passing any arguments.
|
||
```
|
||
$ curl ... | fx
|
||
```
|
||
|
||
Or by passing filename as first argument.
|
||
```
|
||
$ fx data.json
|
||
```
|
||
|
||
Pipe into `fx` any JSON and anonymous function for reducing it.
|
||
```bash
|
||
$ curl ... | fx 'json => json.message'
|
||
```
|
||
|
||
Or same as above but short.
|
||
```bash
|
||
$ curl ... | fx this.message
|
||
$ curl ... | fx .message
|
||
```
|
||
|
||
Pass any numbers of arguments as code.
|
||
```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 '_.groupBy("commit.committer.name")' '_.mapValues(_.size)'
|
||
```
|
||
|
||
Update JSON using spread operator.
|
||
```bash
|
||
$ echo '{"count": 0}' | fx '{...this, count: 1}'
|
||
{
|
||
"count": 1
|
||
}
|
||
```
|
||
|
||
Pretty print JSON with dot.
|
||
```bash
|
||
$ curl ... | fx .
|
||
```
|
||
|
||
## Documentation
|
||
|
||
See full [documentation](https://github.com/antonmedv/fx/blob/master/docs.md).
|
||
|
||
## Links
|
||
|
||
* [Discover how to use fx effectively](https://medium.com/@antonmedv/discover-how-to-use-fx-effectively-668845d2a4ea)
|
||
|
||
## Related
|
||
|
||
* [xx](https://github.com/antonmedv/xx) - fx-like JSON tool (*go*)
|
||
* [ymlx](https://github.com/matthewadams/ymlx) - fx-like YAML cli processor
|
||
* [fx-theme-monokai](https://github.com/antonmedv/fx-theme-monokai) – monokai theme
|
||
* [fx-theme-night](https://github.com/antonmedv/fx-theme-night) – night theme
|
||
|
||
## Contributing
|
||
|
||
[](https://gitpod.io/#https://github.com/antonmedv/fx)
|
||
|
||
Or clone locally and run:
|
||
|
||
```bash
|
||
# install dependencies
|
||
npm install
|
||
|
||
# run fx
|
||
node index.js package.json
|
||
|
||
# run the build
|
||
npm run build
|
||
|
||
# try the built binary
|
||
./dist/fx-linux package.json
|
||
```
|
||
|
||
## License
|
||
|
||
[MIT](https://github.com/antonmedv/fx/blob/master/LICENSE)
|