jq

Command-line JSON processor for filtering, transforming, and extracting data from JSON documents and API responses.

42 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Basics

Basic operations

10commands

Filters

Filtering & selection

10commands

Arrays

Array operations

9commands

Objects

Object manipulation

10commands

Install jq (macOS)

$ brew install jq

Install jq using Homebrew on macOS

Install jq (Linux)

$ sudo apt install jq -y

Install jq using APT on Debian/Ubuntu Linux

Check jq version

$ jq --version

Verify jq is installed and display version

Compact JSON

$ cat file.json | jq -c '.'

Output compact single-line JSON

Get value by key

$ cat file.json | jq '.key'

Extract value of a specific key

List all keys

$ cat file.json | jq 'keys'

Get all keys from object

Get length

$ cat file.json | jq '.array | length'

Get length of array or object

Get multiple keys

$ cat file.json | jq '{name: .name, id: .id}'

Extract multiple keys into new object

Get nested value

$ cat file.json | jq '.parent.child'

Extract nested value

Null-safe access

$ cat file.json | jq '.key?'

Access key without error if missing

Pretty print JSON

$ cat file.json | jq '.'

Format and colorize JSON output

Raw string output

$ cat file.json | jq -r '.key'

Output raw strings without quotes

Get value type

$ cat file.json | jq '.key | type'

Get the type of a value

Group by key

$ cat file.json | jq 'group_by(.category)'

Group array elements by key

Check key exists

$ cat file.json | jq '.[] | select(has("key"))'

Filter objects that have a key

Filter by condition

$ cat file.json | jq '.[] | select(.active == true)'

Filter elements matching condition

Filter by string contains

$ cat file.json | jq '.[] | select(.name | contains("search"))'

Filter where string contains value

Filter greater than

$ cat file.json | jq '.[] | select(.count > 10)'

Filter where value greater than

Filter non-null values

$ cat file.json | jq '.[] | select(.key != null)'

Filter out null values

Filter by type

$ cat file.json | jq '.[] | select(type == "string")'

Filter elements by type

Sort array

$ cat file.json | jq 'sort'

Sort array elements

Sort by key

$ cat file.json | jq 'sort_by(.name)'

Sort array by object key

Get unique values

$ cat file.json | jq 'unique'

Remove duplicate values from array

Add to array

$ cat file.json | jq '. + ["new"]'

Add element to array

Get first element

$ cat file.json | jq '.[0]'

Get first element of array

Flatten nested arrays

$ cat file.json | jq 'flatten'

Flatten nested arrays into single array

Iterate array

$ cat file.json | jq '.[]'

Iterate over all array elements

Get last element

$ cat file.json | jq '.[-1]'

Get last element of array

Map array

$ cat file.json | jq '[.[] | .name]'

Transform each array element

Reverse array

$ cat file.json | jq 'reverse'

Reverse array order

Slice array

$ cat file.json | jq '.[2:5]'

Get array elements from index 2 to 4

Limit results

$ cat file.json | jq '.[:10]'

Get first N elements

Add key to object

$ cat file.json | jq '. + {newKey: "value"}'

Add new key-value pair to object

Delete key

$ cat file.json | jq 'del(.key)'

Remove key from object

Array to object

$ cat file.json | jq 'from_entries'

Convert key-value array to object

Merge objects

$ jq -s '.[0] * .[1]' file1.json file2.json

Deep merge two JSON objects

Get all paths

$ cat file.json | jq '[paths]'

Get all paths in JSON structure

Recursive descent

$ cat file.json | jq '.. | .name? // empty'

Find all name fields recursively

Rename key

$ cat file.json | jq '.newName = .oldName | del(.oldName)'

Rename object key

Object to array

$ cat file.json | jq 'to_entries'

Convert object to key-value array

Update key value

$ cat file.json | jq '.key = "new value"'

Update value of existing key

Transform object keys

$ cat file.json | jq 'with_entries(.key |= "prefix_" + .)'

Transform all object keys

Discussion

Loading comments...

jq

Command-line JSON processor for filtering, transforming, and extracting data from JSON documents and API responses.

42 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Basics

Basic operations

10commands

Filters

Filtering & selection

10commands

Arrays

Array operations

9commands

Objects

Object manipulation

10commands

Install jq (macOS)

$ brew install jq

Install jq using Homebrew on macOS

Install jq (Linux)

$ sudo apt install jq -y

Install jq using APT on Debian/Ubuntu Linux

Check jq version

$ jq --version

Verify jq is installed and display version

Compact JSON

$ cat file.json | jq -c '.'

Output compact single-line JSON

Get value by key

$ cat file.json | jq '.key'

Extract value of a specific key

List all keys

$ cat file.json | jq 'keys'

Get all keys from object

Get length

$ cat file.json | jq '.array | length'

Get length of array or object

Get multiple keys

$ cat file.json | jq '{name: .name, id: .id}'

Extract multiple keys into new object

Get nested value

$ cat file.json | jq '.parent.child'

Extract nested value

Null-safe access

$ cat file.json | jq '.key?'

Access key without error if missing

Pretty print JSON

$ cat file.json | jq '.'

Format and colorize JSON output

Raw string output

$ cat file.json | jq -r '.key'

Output raw strings without quotes

Get value type

$ cat file.json | jq '.key | type'

Get the type of a value

Group by key

$ cat file.json | jq 'group_by(.category)'

Group array elements by key

Check key exists

$ cat file.json | jq '.[] | select(has("key"))'

Filter objects that have a key

Filter by condition

$ cat file.json | jq '.[] | select(.active == true)'

Filter elements matching condition

Filter by string contains

$ cat file.json | jq '.[] | select(.name | contains("search"))'

Filter where string contains value

Filter greater than

$ cat file.json | jq '.[] | select(.count > 10)'

Filter where value greater than

Filter non-null values

$ cat file.json | jq '.[] | select(.key != null)'

Filter out null values

Filter by type

$ cat file.json | jq '.[] | select(type == "string")'

Filter elements by type

Sort array

$ cat file.json | jq 'sort'

Sort array elements

Sort by key

$ cat file.json | jq 'sort_by(.name)'

Sort array by object key

Get unique values

$ cat file.json | jq 'unique'

Remove duplicate values from array

Add to array

$ cat file.json | jq '. + ["new"]'

Add element to array

Get first element

$ cat file.json | jq '.[0]'

Get first element of array

Flatten nested arrays

$ cat file.json | jq 'flatten'

Flatten nested arrays into single array

Iterate array

$ cat file.json | jq '.[]'

Iterate over all array elements

Get last element

$ cat file.json | jq '.[-1]'

Get last element of array

Map array

$ cat file.json | jq '[.[] | .name]'

Transform each array element

Reverse array

$ cat file.json | jq 'reverse'

Reverse array order

Slice array

$ cat file.json | jq '.[2:5]'

Get array elements from index 2 to 4

Limit results

$ cat file.json | jq '.[:10]'

Get first N elements

Add key to object

$ cat file.json | jq '. + {newKey: "value"}'

Add new key-value pair to object

Delete key

$ cat file.json | jq 'del(.key)'

Remove key from object

Array to object

$ cat file.json | jq 'from_entries'

Convert key-value array to object

Merge objects

$ jq -s '.[0] * .[1]' file1.json file2.json

Deep merge two JSON objects

Get all paths

$ cat file.json | jq '[paths]'

Get all paths in JSON structure

Recursive descent

$ cat file.json | jq '.. | .name? // empty'

Find all name fields recursively

Rename key

$ cat file.json | jq '.newName = .oldName | del(.oldName)'

Rename object key

Object to array

$ cat file.json | jq 'to_entries'

Convert object to key-value array

Update key value

$ cat file.json | jq '.key = "new value"'

Update value of existing key

Transform object keys

$ cat file.json | jq 'with_entries(.key |= "prefix_" + .)'

Transform all object keys

Discussion

Loading comments...