helm-docs for Mac 版
用于自动生成 Helm 图表的 Markdown 文档的工具
helm-docs 是什么
helm-docs 是一个从 Helm Chart 自动生成 Markdown 文档的工具。它会解析 Chart 的元数据,并读取 values.yaml 中每个字段的默认值以及注释里的描述,最终生成一份包含 Chart 基本信息和 values 表格的 README。文档生成完全由 Go template 驱动,工具会提供若干子模板供自定义模板文件(默认 README.md.gotmpl)引用;如果没有提供模板,则使用内置的默认模板输出格式合理的 README。
它最实用的地方在于能从注释中自动提取字段描述,省去手动维护 values 文档的麻烦。对于列表、对象等复杂字段以及部分简单字段,工具会按既定规则决定是否纳入表格,即使没有描述注释也能处理某些字段。
这个工具适合需要为多个 Helm Chart 维护文档的开发者,尤其是 Chart 数量多、values 结构复杂、文档容易过时的场景。它支持递归查找当前目录下的 Chart.yaml 并为每个 Chart 生成文档,也可以通过 Docker 挂载目录运行,还提供 pre-commit hook 在提交时自动更新文档。此外,它支持用 .helmdocsignore 文件忽略特定 Chart 目录。
它最实用的地方在于能从注释中自动提取字段描述,省去手动维护 values 文档的麻烦。对于列表、对象等复杂字段以及部分简单字段,工具会按既定规则决定是否纳入表格,即使没有描述注释也能处理某些字段。
这个工具适合需要为多个 Helm Chart 维护文档的开发者,尤其是 Chart 数量多、values 结构复杂、文档容易过时的场景。它支持递归查找当前目录下的 Chart.yaml 并为每个 Chart 生成文档,也可以通过 Docker 挂载目录运行,还提供 pre-commit hook 在提交时自动更新文档。此外,它支持用 .helmdocsignore 文件忽略特定 Chart 目录。
如何安装 helm-docs
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
最近一次更新为 2024-07-08,当前版本 v1.14.2,共记录最近 10 个版本。
| 版本 | 发布日期 | 类型 | 大小 | macOS | Windows | Linux |
|---|---|---|---|---|---|---|
| v1.14.2 | 2024-07-08 | 稳定版 | 3.0 MB | 下载 | 下载 | 下载 |
| v1.14.1 | 2024-07-08 | 稳定版 | 3.0 MB | 下载 | 下载 | 下载 |
| v1.14.0 | 2024-07-08 | 稳定版 | 3.0 MB | 下载 | 下载 | 下载 |
| v1.13.1 | 2024-03-02 | 稳定版 | 3.0 MB | 下载 | 下载 | 下载 |
| v1.13.0 | 2024-02-24 | 稳定版 | 3.0 MB | 下载 | 下载 | 下载 |
| v1.12.0 | 2023-12-21 | 稳定版 | 3.1 MB | 下载 | 下载 | 下载 |
| v1.11.3 | 2023-10-10 | 稳定版 | 3.0 MB | 下载 | 下载 | 下载 |
| v1.11.2 | 2023-09-19 | 稳定版 | 2.8 MB | 下载 | 下载 | 下载 |
| v1.11.0 | 2022-06-29 | 稳定版 | 2.6 MB | 下载 | 下载 | 下载 |
| v1.10.0 | 2022-05-10 | 稳定版 | 2.6 MB | 下载 | 下载 | 下载 |
数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。
二进制包支持平台
Homebrew 官方提供的预编译包(bottle)覆盖:
- Apple 芯片 · 最新 macOS
- Apple 芯片 · macOS 26 Tahoe
- Apple 芯片 · macOS 15 Sequoia
- Apple 芯片 · macOS 14 Sonoma
- Apple 芯片 · macOS 13 Ventura
- arm64_monterey
- Intel · macOS 14 Sonoma
- Intel · macOS 13 Ventura
- Intel · macOS 12 Monterey
- Linux · ARM64
- Linux · x86_64
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| helm-docs | v1.14.2 | GPL-3.0-or-later | 命令行 | 161 |
| vals | v0.51.0 | Apache-2.0 | 命令行 | 98 |
| chart-testing | v3.15.0 | Apache-2.0 | 命令行 | 342 |
| helm-ls | v0.5.4 | MIT | 命令行 | 57 |
DevOps 与云服务中的类似应用
vals
vals 是一个用于管理配置值和密钥的工具,核心思路是用统一的 URI 引用(ref+ 协议)屏蔽不同后端之间的差异。chart-testing
chart-testing(简称 ct)是一款专门用于测试 Helm chart 的命令行工具,主要面向提交 Pull Request 的场景,帮助开发者在…helm-ls
helm-ls 是一个 Helm 语言服务器协议(LSP)的实现,为 Helm chart 开发提供编辑器级别的智能支持。nova-fairwinds
Nova 是一款面向 Kubernetes 集群的开源扫描工具,用来发现集群中已经过时或废弃的 Helm chart。timoni
Timoni 是一个面向 Kubernetes 的包管理器,底层由 CUE 驱动,设计上受到 Helm 启发。yoke
Yoke 是一个面向 Kubernetes 的基础设施即代码(IaC)包部署工具,思路借鉴 Helm,但走得更远。所属分类:DevOps 与云服务、命令行工具