/jq-zsh-plugin

jq zsh plugin

Primary LanguageShellMIT LicenseMIT

jq zsh plugin

Interactively build jq expressions with key completions.

This zsh plugin gives you jq superpowers!

Table of contents

Installation

This plugin requires fzf to be available on your PATH.

The project consists of two components:

  • a jq-repl command
  • a jq.plugin.zsh providing line-editor feature using jq-repl
zplug reegnz/jq-zsh-plugin
antigen bundle reegnz/jq-zsh-plugin
zgen load reegnz/jq-zsh-plugin

Usage

  • type out a command that you expect to produce json on it's standard output
  • press alt + j and interactively write a jq expression
  • press enter, and the jq expression is appended to your initial command!

Key bindings

To bring up the JQ query builder, press alt + j.

During interactive querying, the following shortcuts can be used:

Shortcut Effect
tab Accept the current suggested query
shift + up Scroll up
shift + down Scroll down
alt + up Scroll up full page
alt + down Scroll down full page

Demos

Interactive jq query construction

asciicast

Insert jq query in the middle of a pipeline

asciicast

Troubleshooting

Pressing alt-j creates a symbol in iTerm2

Cmd + , to enter preferences
Go to Profiles, select your profile from the pane on the left hand side, then go to the keys tab.
Set Left Option (⌥) Key to Esc+