jq

What it does

How to write it

jq [OPTIONS] FILTER [FILE ...]

Most used

Nothing matches this filter.

$ run as a normal user# run as root (or with sudo)

1. 1Pretty print an API answer

   $curl -s https://api.github.com/repos/kubernetes/kubernetes | jq .

2. 2Take one value into a shell variable

   $STARS=$(curl -s https://api.github.com/repos/kubernetes/kubernetes | jq -r .stargazers_count)
   $echo "$STARS"

3. 3Names of all pods that are not Running

   $kubectl get pods -A -o json | jq -r '.items[] | select(.status.phase != "Running") | "\(.metadata.namespace)/\(.metadata.name)"'

4. 4Every container image in the cluster, once

   $kubectl get pods -A -o json | jq -r '.items[].spec.containers[].image' | sort -u

5. 5AWS: ID and type of running EC2 instances as a table

   $aws ec2 describe-instances --filters Name=instance-state-name,Values=running | jq -r '.Reservations[].Instances[] | [.InstanceId, .InstanceType] | @tsv'

6. 6Decode a Kubernetes secret

   $kubectl get secret db -o json | jq -r '.data.password | @base64d'

7. 7Change a value and write a new file

   $jq '.replicas = 3 | .image.tag = "v1.4.0"' values.json > values.new.json

8. 8Build JSON safely from shell values (no quoting bugs)

   $jq -n --arg env prod --arg ver "$TAG" '{environment: $env, version: $ver}'
   {
     "environment": "prod",
     "version": "v1.4.0"
   }

9. 9Use jq as a check in a script

   $if curl -s localhost:8080/health | jq -e '.status == "ok"' >/dev/null; then echo healthy; fi

10. 10Count items per group

    $gh api repos/OWNER/REPO/issues --paginate | jq -r 'group_by(.state) | map({state: .[0].state, n: length})'

11. 11Turn JSON lines (logs) into a table

    $jq -r 'select(.level == "error") | [.time, .msg] | @tsv' app.log.json

12. 12Terraform outputs into environment variables

    $terraform output -json | jq -r 'to_entries[] | "export \(.key | ascii_upcase)=\(.value.value)"'

Nothing matches this filter.

Exit codes