Installation

Fx is a powerful tool that comprises two primary components: a terminal JSON viewer and a JSON processor. The terminal JSON viewer is developed in Go and functions independently without the need for additional runtime dependencies. On the other hand, if you prefer the command-line JSON processor, which is designed in JavaScript, ensure that you have either Node.js or Deno installed.

Full Installation

Depending on your system or preferences, use one of the following methods:

brew

brew install fx

snap

snap install fx

scoop

scoop install fx

pacman

pacman -S fx

pkg

pkg install fx

go

go install github.com/antonmedv/fx@latest

docker

docker run -it --rm -v .:/data:ro antonmedv/fx file.json

Binary Download

For a straightforward download of the latest binary, visit the GitHub releases page. Alternatively, execute the following command in your terminal:

curl https://fx.wtf/install.sh | sh

Installation on Windows

For Windows users:

Install Go and run the following command:

go install github.com/antonmedv/fx@latest

Autocomplete

To enable autocompletion, add the following line to your .bashrc or .zshrc:

bash

source <(fx --comp bash)

zsh

source <(fx --comp zsh)

fish

fx --comp fish | source

Supported shells include bash, zsh, and fish.

GitHub Actions

In a CI environment, fx can be implemented with the following command:

curl ... | npx fx .field

The npm variant of fx is compact and doesn't need additional dependencies.

Node & Deno

npm

npm install -g fx

deno

deno install -A npm:fx

Note

Remember, the JavaScript iteration of fx operates in a non-interactive mode. It solely offers JSON processing functionalities.