
关于
jq 专家用法,涵盖 JSON 查询、过滤、转换和管道集成。面向真实 Shell 工作流的实用模式。
name: jq description: "专业的 jq 使用指南,涵盖 JSON 查询、过滤、转换和管道集成。适用于真实 shell 工作流的实用模式。" category: development risk: safe source: community date_added: "2026-03-28" author: kostakost2 tags: [jq, json, shell, cli, data-transformation, bash] tools: [claude, cursor, gemini]
jq — JSON 查询与转换
概述
jq 是用于查询和重塑 JSON 的标准 CLI 工具。此技能涵盖实用的专家级用法:过滤深层嵌套数据、转换结构、聚合值,以及将 jq 组合到 shell 管道中。每个示例都可以直接复制粘贴用于真实工作流。
何时使用此技能
- 解析来自 API、CLI 工具(AWS、GitHub、kubectl、docker)或日志文件的 JSON 输出时使用
- 转换 JSON 结构(重命名键、展平数组、分组记录)时使用
- 用户需要在 bash 脚本或单行命令中使用
jq时使用 - 解释复杂
jq表达式的含义时使用
工作原理
jq 接受过滤表达式并将其应用于 JSON 输入。过滤器通过管道(|)组合,jq 原生处理数组、对象、字符串、数字、布尔值和 null。
基本选择
# 提取字段
echo '{"name":"alice","age":30}' | jq '.name'
# "alice"
# 嵌套访问
echo '{"user":{"email":"a@b.com"}}' | jq '.user.email'
# 数组索引
echo '[10, 20, 30]' | jq '.[1]'
# 20
# 数组切片
echo '[1,2,3,4,5]' | jq '.[2:4]'
# [3, 4]
# 所有数组元素
echo '[{"id":1},{"id":2}]' | jq '.[]'
使用 select 过滤
# 只保留匹配的元素
echo '[{"role":"admin"},{"role":"user"},{"role":"admin"}]' \
| jq '[.[] | select(.role == "admin")]'
# 数值比较
curl -s https://api.github.com/repos/owner/repo/issues \
| jq '[.[] | select(.comments > 5)]'
# 测试字段存在且非空
jq '[.[] | select(.email != null)]'
# 组合条件
jq '[.[] | select(.active == true and .score >= 80)]'
映射与转换
# 从每个数组元素中提取字段
echo '[{"name":"alice","age":30},{"name":"bob","age":25}]' \
| jq '[.[] | .name]'
# ["alice", "bob"]
# 简写:map()
jq 'map(.name)'
# 为每个元素构建新对象
jq '[.[] | {user: .name, years: .age}]'
# 添加计算字段
jq '[.[] | . + {senior: (.age > 28)}]'
# 重命名键
jq '[.[] | {username: .name, email_address: .email}]'
聚合与归约
# 求所有值的和
echo '[1, 2, 3, 4, 5]' | jq 'add'
# 15
# 对对象中的字段求和
jq '[.[].price] | add'
# 计数元素
jq 'length'
# 最大值 / 最小值
jq 'max_by(.score)'
jq 'min_by(.created_at)'
# reduce:自定义累加器
echo '[1,2,3,4,5]' | jq 'reduce .[] as $x (0; . + $x)'
# 15
# 按字段分组
jq 'group_by(.department)'
# 每组计数
jq 'group_by(.status) | map({status: .[0].status, count: length})'
字符串插值与格式化
# 字符串插值
jq -r '.[] | "\(.name) is \(.age) years old"'
# 格式化为 CSV(无表头)
jq -r '.[] | [.name, .age, .email] | @csv'
# 格式化为 TSV
jq -r '.[] | [.name, .score] | @tsv'
# URL 编码值
jq -r '.query | @uri'
# Base64 编码
jq -r '.data | @base64'
处理键和路径
# 列出所有顶层键
jq 'keys'
# 检查键是否存在
jq 'has("email")'
# 删除键
jq 'del(.password)'
# 从每个元素中删除嵌套键
jq '[.[] | del(.internal_id, .raw_payload)]'
# 递归下降:在树中任意位置查找某个键的所有值
jq '.. | .id? // empty'
# 获取所有叶子路径
jq '[paths(scalars)]'
条件与错误处理
# if-then-else
jq 'if .score >= 90 then "A" elif .score >= 80 then "B" else "C" end'
# 替代运算符:如果为 null 或 false 则使用回退值
jq '.nickname // .name'
# try-catch:跳过错误而不是停止
jq '[.[] | try .nested.value catch null]'
# 使用 // empty 抑制 null 输出
jq '.[] | .optional_field // empty'
实用 Shell 集成
# 从文件读取
jq '.users' data.json
# 紧凑输出(无空白)用于进一步管道传输
jq -c '.[]' records.json | while IFS= read -r record; do
echo "Processing: $record"
done
# 将 shell 变量传入 jq
STATUS="active"
jq --arg s "$STATUS" '[.[] | select(.status == $s)]'
# 传入数字
jq --argjson threshold 42 '[.[] | select(.value > $threshold)]'
# 将多行 JSON 合并为数组
jq -s '.' records.ndjson
# 多文件:将所有文件合并为一个数组
jq -s 'add' file1.json file2.json
# 从命令进行空安全管道
kubectl get pods -o json | jq '.items[] | {name: .metadata.name, status: .status.phase}'
# GitHub CLI:提取 PR 编号
gh pr list --json number,title | jq -r '.[] | "\(.number)\t\(.title)"'
# AWS CLI:列出运行中的实例 ID
aws ec2 describe-instances \
| jq -r '.Reservations[].Instances[] | select(.State.Name=="running") | .InstanceId'
# Docker:显示容器名称和镜像
docker inspect $(docker ps -q) | jq '[.[] | {name: .Name, image: .Config.Image}]'
限制
- 仅在任务明确匹配上述范围时使用此技能。
- 不要将输出视为环境特定验证、测试或专家审查的替代品。
- 如果缺少所需的输入、权限、安全边界或成功标准,请停下来要求澄清。
兼容工具
Claude CodeCursor
标签
运维部署

