chatwork/yq

yq Docker镜像文档

镜像概述

yq是一款功能强大的命令行工具，专注于YAML、JSON、XML等数据格式的处理，支持数据查询、过滤、转换及修改。本Docker镜像封装了yq工具，提供免本地安装的便捷使用方式，适用于各类操作系统和环境，简化数据处理流程。

核心功能

• 多格式兼容：支持处理YAML、JSON、XML、CSV等多种数据格式
• 灵活查询：采用类jq语法，支持复杂数据结构查询，快速提取目标数据
• 数据转换：支持不同格式间相互转换（如JSON转YAML、YAML转JSON）
• 便捷修改：可直接添加、更新或删除数据结构中的字段及值
• 轻量高效：镜像体积小巧，启动快速，资源占用低，适合集成到自动化流程

使用场景

• CI/CD流程：在自动化部署中处理Kubernetes配置文件、CI流水线配置等
• 配置管理：解析应用配置文件（如提取数据库连接信息、修改服务端口）
• 数据处理：转换API响应数据格式（如将JSON接口响应转为YAML报告）
• 脚本集成：在Shell/Python脚本中嵌入数据处理步骤，无需依赖本地工具链

使用方法

获取镜像

通过Docker Hub拉取最新版本镜像：

bash
docker pull chatwork/yq

基本用法

1. 管道输入处理

通过标准输入（管道）传递数据并处理，示例：

bash
# 处理JSON数据并输出为YAML格式
docker run --entrypoint '' chatwork/yq /bin/sh -c 'echo "{\"hoge\": 1, \"foo\": \"bar\"}" | yq -y .'

输出结果：

yaml
hoge: 1
foo: bar

参数说明：-y 指定输出格式为YAML，. 表示输出完整数据结构

2. 本地文件处理

挂载本地目录至容器，处理文件数据，示例：

bash
# 提取JSON文件中指定字段的值（假设本地有example.json文件）
docker run -v $(pwd):/data --entrypoint '' chatwork/yq /bin/sh -c 'yq .hoge /data/example.json'

若example.json内容为{"hoge": "hello", "world": true}，输出结果：

hello

参数说明：-v $(pwd):/data 将当前目录挂载至容器/data目录，/data/example.json为容器内文件路径

3. 常见高级用法

• JSON转YAML：

  bash
  docker run --entrypoint '' chatwork/yq /bin/sh -c 'echo "{\"name\": \"app\", \"version\": \"1.0.0\"}" | yq -y .'
  

  输出：

  yaml
  name: app
  version: 1.0.0
  

• 修改YAML文件：

  bash
  # 直接修改本地YAML文件（需挂载目录并使用-i参数）
  docker run -v $(pwd):/data --entrypoint '' chatwork/yq /bin/sh -c 'yq ".version = \"2.0.0\"" -i /data/config.yaml'
  

  参数说明：-i 表示直接修改源文件，.version = "2.0.0" 为修改规则

4. 查看帮助文档

获取完整命令参数说明：

bash
docker run chatwork/yq yq --help

注意事项

• 容器内yq可执行路径为/usr/local/bin/yq，可通过--entrypoint yq直接指定工具入口
• 处理本地文件时需确保挂载目录权限正确（避免容器内无读写权限）
• 复杂查询场景可参考yq官方文档获取语法细节