jq
Use when the user needs to query, filter, reshape, extract, create, or construct JSON data — including API responses, config files, log output, or any structured data — or when helping the user write or debug JSON transformations.
Best for CLI workflowsWorks with GitHubLow risk
⌘source
- author
@charmbracelet- language
- Go
★23kstars
1.5kforks
Apr 21, 2026
✦overview.md
Key Features
- ·Built-in JSON query and transformation tool
- ·Supports standard jq flags and file arguments
- ·Processes API responses, config files, and logs
- ·Includes gojq-specific features like arbitrary-precision integers
- ·No external binary required
Use Cases
- →Extracting specific fields from an API response
- →Filtering and reshaping JSON configuration files
- →Parsing and querying structured log output
- →Debugging JSON data transformations
- →Creating or constructing new JSON from existing data
Best for
- ✓CLI workflows
- ✓data pipeline scripting
- ✓debugging JSON data
Not ideal for
- !scenarios requiring strict key ordering
- !one-off manual JSON editing
FAQs
name
jq
description
Use when the user needs to query, filter, reshape, extract, create, or construct JSON data — including API responses, config files, log output, or any structured data — or when helping the user write or debug JSON transformations.
jq — Built-in JSON Processor
Crush ships a built-in jq command (via github.com/itchyny/gojq) available
in the bash tool. No external binary is required.
Supported Flags
| Flag | Description |
|---|---|
-r, --raw-output | Output strings without quotes |
-j, --join-output | Like -r but no trailing newline |
-c, --compact-output | One-line JSON output |
-s, --slurp | Read all inputs into an array |
-n, --null-input | Use null as input (ignore stdin) |
-e, --exit-status | Exit 1 if last output is false or null |
-R, --raw-input | Read each line as a string, not JSON |
--arg name value | Bind $name to a string value |
--argjson name value | Bind $name to a parsed JSON value |
File arguments after the filter are also supported: jq '.foo' file.json.
Differences from Standard jq
The built-in uses gojq, which is a pure-Go jq implementation. Key differences:
- No object key ordering — keys are sorted by default;
keys_unsortedand-Sare unavailable. - Arbitrary-precision integers — large integers keep full precision
$install
1-click copynpx skills add charmbracelet/crush --skill jqSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
5/ 5
excellentVery clear and well structured, with almost no room for misunderstanding.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
5/ 5
very highHighly actionable with clear, concrete steps that an agent can follow directly.