Tooltip and overlays

Contextual overlays that appear when you need them — function documentation inline, full error messages on demand, and a built-in keyboard reference.

You can't remember how group_by works. Switch to a browser, search jq docs, find the right page.

$ # Was it group_by(.key) or group_by(key) ? $ # Does it return [[...], [...]] or {key: [...]} ? $ # Open browser, search "jq group_by"...

Put your cursor on group_by. The tooltip shows the signature and examples inline.

Query: .users | group_by(.department) ┌─────────────────────────────────────────────┐ │ group_by(path_exp) │ │ Groups array elements by a common value. │ │ Returns: array of arrays │ │ Example: [1,2,3,1] | group_by(.) → [[1,1]] │ └─────────────────────────────────────────────┘

Look up a function

Move your cursor onto any jq function name in the query input. A tooltip appears automatically showing:

  • The function signature
  • A brief description
  • Return type information
  • An inline example

Press Ctrl+T to toggle the tooltip on or off manually.

To disable auto-show, add to ~/.config/jiq/config.toml:

[tooltip]
auto_show = false

Read the full error message

When your query has a syntax error, jiq shows a brief indicator in the results title bar. To see the complete error:

Press Ctrl+E to toggle the error overlay.

Error overlay
jq: error (at <stdin>:1):
Cannot iterate over null (null)
 
Ctrl+E to close | Ctrl+A for AI fix suggestions

The overlay sits above the results and disappears when you fix the error or press Ctrl+E again.

Open the help reference

Press F1 to open a multi-tab help popup showing every keybind organized by category. (? also works when the query input is not in typing mode.)

  • Global keys
  • Input (INSERT + NORMAL)
  • Results pane
  • History
  • AI assistant
  • Search
  • Snippets

Click any tab header to switch, or press Esc to close.

All keys

Key Action
Ctrl+T Toggle function tooltip
Ctrl+E Toggle error overlay
F1 / ? Toggle help popup
Esc Close any overlay