macOS
Homebrew已验证 · 100%
brew install helm-docslocal Homebrew formula metadata
安装
其他安装命令
Linux
Nix已验证 · 92%
nix profile install nixpkgs#helm-docsnixpkgs package indexes · pkgs/by-name/he/helm-docs/package.nix · 来源: api.github.com
openSUSE zypper已验证 · 92%
sudo zypper install helm-docsopenSUSE Tumbleweed package metadata · helm-docs · 来源: download.opensuse.org
Windows
Scoop已验证 · 92%
scoop install main/helm-docsScoop official bucket manifest trees · bucket/helm-docs.json · 来源: api.github.com
概览
软件包摘要
Tool for automatically generating markdown documentation for helm charts
历史
项目历史与用法
helm-docs is a Go command-line tool that auto-generates Markdown documentation from Helm charts. Its README describes generated files that include chart metadata and tables of values, defaults, and descriptions parsed from comments.
The project sits in the practical layer around Helm: once charts became a common packaging format for Kubernetes applications, teams needed generated, reviewable README files that stayed synchronized with `Chart.yaml`, `values.yaml`, and template conventions.
项目历史
The public repository was created in September 2018, during the period when Helm charts were becoming a standard way to distribute Kubernetes applications. GitHub release metadata shows a v0.1.0 release in July 2019.
The tool evolved around Go templates and chart parsing. Its default workflow searches recursively for `Chart.yaml`, reads values files and chart metadata, and renders Markdown through either a default internal template or user-supplied `README.md.gotmpl` files.
采用历史
helm-docs became part of chart-authoring workflows because it is easy to run locally, in containers, and as a pre-commit hook. The README includes pre-commit hook configurations and direct binary usage for regenerating READMEs.
The README documents Homebrew, Scoop, mise, source builds, and container usage, while the supplied package metadata also lists Homebrew, Nix, Scoop, and openSUSE packaging.
使用方式
A chart maintainer runs `helm-docs` in a repository, optionally with `--chart-search-root`, `--template-files`, or `--dry-run`. The tool finds charts, parses metadata and values, and writes generated Markdown back into chart README files.
Comment conventions in `values.yaml` let maintainers document fields next to the defaults they control. That makes the generated table useful for reviewers and users who need to understand chart configuration without reading every template.
为什么软件包爱好者会关心
helm-docs is package-nerd glue: it turns Helm charts from installable bundles into better documented packages. In chart repositories with many values, generated documentation prevents README drift and makes package review less painful.
It is also a good example of a packaging-adjacent CLI that belongs in package managers because teams run it in hooks, CI, release pipelines, and local chart authoring environments.
时间线
- 2018: Public GitHub repository created.
- 2019: v0.1.0 release published.
- 2019: Early 0.x releases iterate on generated chart documentation.
- 2020s: README documents Homebrew, Scoop, mise, source, container, and pre-commit workflows.
Related projects
- Helm is the chart format and command-line ecosystem that helm-docs documents.
- Go templates drive the Markdown rendering model.
- pre-commit is a common workflow integration documented by the project.
- Chart.yaml, values.yaml, and README.md.gotmpl are the main chart files touched by the tool.
来源
安全态势
风险级别：绿色
narrow executable package without higher-risk signals.
风险分类器
绿色 风险 · 低 置信度 · appliance
原因
- narrow executable package without higher-risk signals
信号
- metadata:no-higher-risk-signals
安装行为
- formula 元数据中未记录 Homebrew post-install 钩子。
- Homebrew bottle 元数据适用于 10 个平台目标。
- 构建元数据列出 1 个构建依赖。
建议审查
在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。
可执行文件
已安装的可执行文件
| 命令 | 类型 | 暴露范围 | 备注 |
|---|---|---|---|
helm-docs | cli | 全局可执行文件 |
新鲜度
版本和新鲜度
这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。
页面生成时间2026-07-25
管理器版本1.14.2
管理器更新时间
本地数据OK
上游当前
检测到的最新版本v1.14.2
https://github.com/norwoodj/helm-docs
- 信息No package-manager update timestamp was available.低 置信度
安装元数据
软件包元数据
| 软件包键 | brew:helm-docs |
|---|---|
| 版本 | 1.14.2 |
| 软件包管理器 | Homebrew |
| 软件包管理器页面 | https://formulae.brew.sh/formula/helm-docs |
| 主页 | https://github.com/norwoodj/helm-docs |
| 仓库 | https://github.com/norwoodj/helm-docs |
| 上游文档 | https://github.com/norwoodj/helm-docs#readme |
| 许可证 | GPL-3.0-or-later |
| 源码归档 | https://github.com/norwoodj/helm-docs/archive/refs/tags/v1.14.2.tar.gz |
| 构建依赖 | go |
| Bottle | 可用 (于 arm64_linux, arm64_monterey, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, monterey, sonoma, ventura, x86_64_linux) |
| Homebrew post-install | 未定义 |
| 服务 | 未声明 |
注册表事实
源数据库详情
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | helm-docs |
| Version Scheme | 0 |
| Revision | 0 |
| Head Version | HEAD |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
源数据库匹配
其他软件包管理器记录
匹配项来自外部软件包管理器索引，并与本地 Automic Vault 软件包链接分开显示。
Nix95%
helm-docs
nix profile install nixpkgs#helm-docs- normalized package name match
- 匹配方式：Helm Docs
zypper95%
helm-docs 1.14.2-1.6
A tool for automatically generating markdown documentation for helm charts
https://github.com/norwoodj/helm-docs
sudo zypper install helm-docs- License: GPL-3.0-only
- Category: Unspecified
- Architecture: x86_64
- Source Package: helm-docs
- 1 依赖
- 1 提供
- normalized package name match
- 匹配方式：Helm Docs
Scoop95%
main/helm-docs
scoop install main/helm-docs- normalized package name match
- 匹配方式：Helm Docs
来源线索
由仓库数据生成
此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。
Combined YAML source
View the package source record on GitHub.
使用的来源
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated package history
- external package-manager database matches
- package relationship graph
- package version freshness
- package-page enrichment