- Go 99.3%
- Makefile 0.7%
|
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
|
||
|---|---|---|
| demo | ||
| internal | ||
| testdata | ||
| .gitattributes | ||
| .gitignore | ||
| .woodpecker.yaml | ||
| config.go | ||
| config_test.go | ||
| COPYING | ||
| flags_test.go | ||
| go.mod | ||
| go.sum | ||
| history.go | ||
| history_test.go | ||
| ijq.1.scd | ||
| keymap.go | ||
| keymap_test.go | ||
| main.go | ||
| main_test.go | ||
| Makefile | ||
| race_test.go | ||
| README.md | ||
| README.srht.html | ||
| ui_test.go | ||
ijq
Interactive jq tool. Like jqplay for the commandline.
Demo
Installation
Install from package manager
Build from source
Install go. To install ijq under /usr/local/bin/ simply run
make install
from the root of the project. To install to another location, set the PREFIX
variable, e.g.
make PREFIX=~/.local install
To generate the man page you will also need to have scdoc installed.
Usage
ijq uses jq under the hood, so make sure you have that installed first.
Read from a file:
ijq file.json
Read from stdin:
curl -s https://api.github.com/users/gpanders | ijq
Press Return to close ijq and print the current filtered output to stdout.
This will also print the current filter to stderr. This allows you to save the
filter for re-use with jq in the future:
ijq file.json 2>filter.jq
# Same output as above
jq -f filter.jq file.json
Pressing Return also saves the filter to a history file
($XDG_DATA_HOME/ijq/history by default). You can browse the history by
deleting everything in the filter field. Change the history file used with the
history-file setting in $XDG_CONFIG_HOME/ijq/config (or
~/.config/ijq/config when $XDG_CONFIG_HOME is unset). Set
history-file to an empty string to disable history entirely.
If $XDG_DATA_HOME is undefined, ~/.local/share/ijq/history is used.
Press Ctrl+s to save the current filter to history without exiting. A
confirmation popup is shown and can be dismissed with any key.
Use Shift plus the arrow keys to move between the different windows. When
either of the input or output views have focus, you can use the arrow keys to
scroll up and down. Vi keys also work, i.e. you can use j/k to scroll up or
down, g to move to the top of the view, G to jump to the bottom of the
view, and Ctrl-F/Ctrl-B to scroll up or down a page at a time.
Press Ctrl-/ to open an overlay menu (Ctrl-? and Ctrl-_ are also
accepted) with some useful actions and configuration options.
Use Esc to go back to the root overlay menu (or close it from the root), and
use q to close the overlay from any subview.
Use Ctrl-C to close the overlay when it is open, or to exit ijq
immediately (discarding all filters and state) when the overlay is closed.
You can configure the colors by setting the JQ_COLORS environment variable.
See the jq documentation for more details.
Contributing
Bugs can be reported on the issue tracker. PRs are accepted on GitHub or Codeberg.
Note for Packagers
Subscribe to release announcements on Codeberg to be notified of new releases, or subscribe to the RSS feed.