a TUI playground for exploring jq.

This application utilizes itchyny's implementation of jq written in Go, gojq.

brew install noahgorstein/tap/jqp

sudo port install jqp

Download the relevant asset for your operating system from the latest Github release. Unpack it, then move the binary to somewhere accessible in your PATH, e.g. mv ./jqp /usr/local/bin.

Clone this repo, build from source with cd jqp && go build, then move the binary to somewhere accessible in your PATH, e.g. mv ./jqp /usr/local/bin.

➜ jqp --help
jqp is a TUI to explore the jq command line utility

Usage:
  jqp [flags]

Flags:
      --config string   config file (default is $HOME/.jqp.yaml)
  -f, --file string     path to the input JSON file
  -h, --help            help for jqp
  -t, --theme string    jqp theme
  -v, --version         version for jqp

jqp also supports input from STDIN.

➜ curl "https://api.github.com/repos/stedolan/jq/issues?per_page=2" | jqp 

jqp can be configured with a configuration file. By default, jqp will search your home directory for a YAML file named .jqp.yaml. A path to a YAML configuration file can also be provided to the --config command line flag.

➜ jqp --config ~/my_jqp_config.yaml < data.json

If a configuration option is present in both the configuration file and the command line, the command line option takes precedence. For example, if a theme is specified in the configuration file and via -t/--theme flag, the command line flag will take precedence.

theme: "nord" # controls the color scheme
file: "/path/to/input/file.json" # stdin takes precedence over command line flag and this option

Themes can be specified on the command line via the -t/--theme <themeName> flag. You can also set a theme in your configuration file.

theme: "monokai"

Themes are broken up into light and dark themes. Light themes work best in terminals with a light background and dark themes work best in a terminal with a dark background. If no theme is specified or a non-existant theme is provided, the default theme is used, which was created to work with both terminals with a light and dark background.

• abap
• algol
• arduino
• autumn
• borland
• colorful
• emacs
• friendly
• github
• gruvbox-light
• hrdark
• igor
• lovelace
• manni
• monokai-light
• murphy
• onesenterprise
• paradaiso-light
• pastie
• perldoc
• pygments
• solarized-light
• tango
• trac
• visual_studio
• vulcan
• xcode

• average
• base16snazzy
• doom-one
• doom-one2
• dracula
• fruity
• github-dark
• gruvbox
• monokai
• native
• paradaiso-dark
• rrt
• solarized-dark
• solarized-dark256
• swapoff
• vim
• witchhazel
• xcode-dark

• Bubbletea
• Bubbles
• Lipgloss
• gojq
• chroma

• jqq for inspiration