x-cmd pkg | yq - 命令行 YAML处理工具

发布时间:2024年01月21日

简介

yq (YAML Query) 是一个轻量级的 YAML、JSON、XML 处理器,主要用于查询和提取 YAML 数据。
yq 的包来自 mikefarah/yq 项目,语法类似于 jq 。相比 kislyuk/yq ,它不依赖 jq,能处理多种数据格式,包括 YAML、JSON、XML、Properties、CSV 和 TSV。

首次用户

  1. 使用 x yq 即可自动下载并使用

    • 在终端运行 eval "$(curl https://get.x-cmd.com)" 即可完成 x 命令安装, 详情参考 x-cmd 官网
  2. x-cmd 提供1分钟教程,其中包含了 yq 命令常用功能的 demo 示例,可以帮你快速上手 yq 。

  3. 使用案例:

    yq-1min-cn

    # 格式化输出 YAML 数据
    x yq '.' file.yml
    x ascii --yml | x yq '.'
    
    # 从 YAML 数据中获取 "Description" 属性的值
    x ascii --yml | x yq '.[1].Description'
    
    # 修改 YAML 中 "Description" 属性的值
    x ascii --yml | x yq '.[1].Description = "x-cmd" | .[1]'
    
    # 将前 5 个 ascii 码的 "Oct" 属性值加 1
    x ascii --yml | x yq '(.[] | select(.Dec <5)|.Oct + 1)'
    
    # 检测 JSON 中是否含有 `Description` 属性
    x ascii --json | x yq '.[1] | has("Description")'
    
    # 将 YAML 转化为 JSON 格式
    x ascii --yml | x yq -o json
    

支持格式转换

yq 可以把 YAML 数据转为 JSON,ndJSON,CSV 和 TSV 的数据格式;也可以与 XML 数据互相转换。

友好的显示和操作

  1. 提供通用 shell (bash/zsh/fish/powershell) 的补全脚本,可以帮您在使用 yq 命令时自动补全参数和选项。
  2. 可以输出彩色化的 YAML,并保留 YAML 的格式、注释、样式、标签、锚点和别名。
  3. 可以用于自动化流水线的 GitHub Action

语法与 jq 类似

  1. 支持深层次的数据结构:可以使用类似于 jq 的语法来访问和修改 YAML、JSON 和 XML 数据中的任意深度的元素。
  2. 可以查询、修改、合并、排序、编码/解码、加载和计算 YAML、JSON 和 XML 数据,能解析和格式化日期和时间,支持不同时区。

竞品和相关作品

  1. kislyuk/yq

  2. jq:轻量级的 JSON 处理工具,由 Stephen Dolan 于 2012 年使用 C 语言开发。yq 的很大一部分灵感就来源于 jq.

  3. dasel:一个支持众多格式(JSON,CSV,YAML,XML)的命令行方案,我们认为其功能稍逊于 jq,但胜在简单易用,能胜任大多数场景。

进一步阅读

文章来源:https://blog.csdn.net/edwinjhlee/article/details/135731941
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。