gksoftware/yq

yq

轻量便携的命令行YAML处理器

yq旨在成为YAML文件处理领域的https://github.com/stedolan/jq%E6%88%96sed%E5%B7%A5%E5%85%B7%EF%BC%8C%E6%94%AF%E6%8C%81%E5%A4%9A%E7%A7%8DYAML%E6%93%8D%E4%BD%9C%E5%8F%8A%E6%A0%BC%E5%BC%8F%E8%BD%AC%E6%8D%A2%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E6%97%A5%E5%B8%B8%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E7%AE%A1%E7%90%86%E4%B8%8E%E8%87%AA%E5%8A%A8%E5%8C%96%E8%84%9A%E6%9C%AC%E5%9C%BA%E6%99%AF%E3%80%82

核心功能

• 基于Go语言编写，提供无依赖的独立二进制文件
• 深度读取YAML文件指定路径内容
• 更新YAML文件指定路径的值（自动创建缺失路径）
• 通过脚本文件批量更新YAML
• 基于深度路径或脚本创建新YAML文件
• JSON与YAML格式互转
• 支持管道输入数据（使用'-'）
• 合并多个YAML文件（可选覆盖或填充缺失/null值模式）

使用场景

• 日常YAML配置文件的快速编辑与查询
• 多环境配置文件的合并与统一管理
• 自动化流程中YAML与JSON格式的转换
• 批量修改YAML配置的脚本化操作

配置与部署示例

Docker部署方式

单次操作

bash
docker run -v ${PWD}:/workdir gksoftware/yq yq [flags] <command> FILE...

交互式运行

bash
docker run -it -v ${PWD}:/workdir gksoftware/yq sh

常用命令示例

• 读取指定路径：yq r sample.yaml a.b.c
• 写入指定路径（覆盖原文件）：yq w --inplace sample.yaml a.b.c newValue
• 合并文件（覆盖模式）：yq m --overwrite sample.yaml sample2.yaml
• JSON转YAML：cat sample.json | yq r -
• YAML转JSON：yq r --tojson sample.yaml

更多详细用法请参考http://mikefarah.github.io/yq/%E3%80%82