tmccombs/hcl2json

hcl2json

镜像概述和主要用途

hcl2json是一个将HCL（HashiCorp配置语言）格式转换为JSON格式的工具，旨在帮助非Go应用程序和脚本更便捷地处理HCL输入文件，例如Terraform配置文件。通过格式转换，可降低非Go环境中解析HCL数据的复杂度。

核心功能和特性

1. 原生HCL转JSON

当未指定任何选项时，工具会将原生HCL文件转换为（几乎）等效的HCL JSON文件，保留原始配置的结构和数据，适用于大多数常规解析场景。

2. JSON Pack格式转换（-pack选项）

通过-pack选项，可将HCL文件转换为https://godoc.org/github.com/hashicorp/hcl2/hclpack%E5%B7%A5%E5%85%B7%E4%BD%BF%E7%94%A8%E7%9A%84JSON Pack格式，该格式包含文档的原始结构信息。需注意，此模式下表达式仅保留源文本内容，可能在部分场景下实用性有限。

注意事项

转换后的JSON文件与原生HCL文件在多数情况下等效，但存在边缘场景可能导致差异，特别是当目标应用依赖HCL的https://github.com/hashicorp/hcl2/blob/master/hcl/hclsyntax/spec.md#static-analysis%E5%8A%9F%E8%83%BD%E6%97%B6%E3%80%82

使用场景和适用范围

• Terraform配置处理：非Go编写的Terraform辅助工具或脚本需解析.tf配置文件时，可通过转换为JSON简化数据提取。
• HCL数据交换：需要在非Go系统间共享HCL配置数据时，通过JSON格式实现跨平台兼容。
• 自动化脚本：Bash、Python等非Go脚本需读取HCL配置时，降低解析难度。

详细使用方法和配置说明

Docker镜像获取

hcl2json的Docker镜像已发布至Docker Hub，可直接拉取使用：

bash
docker pull tmccombs/hcl2json

基础使用示例

1. 常规HCL转JSON（无选项）

将当前目录下的input.hcl文件转换为output.json：

bash
docker run --rm -v $(pwd):/work tmccombs/hcl2json /work/input.hcl /work/output.json

说明：-v $(pwd):/work将本地当前目录挂载至容器内/work目录，实现文件读写；--rm确保容器退出后自动删除。

2. 生成JSON Pack格式（-pack选项）

使用-pack选项转换为hclpack兼容格式，输出至output.pack.json：

bash
docker run --rm -v $(pwd):/work tmccombs/hcl2json -pack /work/input.hcl /work/output.pack.json

其他安装方式（补充说明）

除Docker镜像外，还可通过以下方式获取工具：

• 预编译二进制：访问https://github.com/tmccombs/hcl2json/releases%E4%B8%8B%E8%BD%BD%E5%AF%B9%E5%BA%94%E5%B9%B3%E5%8F%B0%E7%9A%84%E5%8F%AF%E6%89%A7%E8%A1%8C%E6%96%87%E4%BB%B6%E3%80%82
• 源码构建：
  • 通过go get安装（需Go 1.11+，启用模块支持）：

    bash
    GO11MODULE=on go get github.com/tmccombs/hcl2json
    

  • 或克隆仓库手动构建：

    bash
    git clone https://github.com/tmccombs/hcl2json
    cd hcl2json
    go build  # 生成hcl2json可执行文件