# 使用 Homebrew, Nix, zypper, scoop 安装 helm-docs 查看 helm-docs 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。 ## 安装 ```sh sudo av install brew:helm-docs ``` 其他安装命令: ### macOS - Homebrew (100%): ```sh brew install helm-docs ``` 证据: local Homebrew formula metadata ### Linux - Nix (92%): ```sh nix profile install nixpkgs#helm-docs ``` 证据: nixpkgs package indexes: pkgs/by-name/he/helm-docs/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - zypper (92%): ```sh sudo zypper install helm-docs ``` 证据: openSUSE Tumbleweed package metadata: helm-docs from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst ### Windows - Scoop (92%): ```sh scoop install main/helm-docs ``` 证据: Scoop official bucket manifest trees: bucket/helm-docs.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 ## 软件包事实 - **软件包键:** brew:helm-docs - **软件包管理器:** Homebrew - **版本:** 1.14.2 - **来源摘要:** Tool for automatically generating markdown documentation for helm charts - **主页:** - **仓库:** - **最后更新:** 2026-07-27T14:32:24+02:00 - **已生成:** 2026-08-03T19:37:03+00:00 ## 可执行文件 - helm-docs (别名) ## 安装行为 - Bottle: 不可用 ## 版本和新鲜度 - 页面生成时间: 2026-08-03 - 管理器版本: 1.14.2 ## 项目历史与用法 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. - **Geiger 风险:** 绿色 / 低 - narrow executable package without higher-risk signals ## 其他软件包管理器记录 - Nix - helm-docs: normalized package name match | nixpkgs package indexes: pkgs/by-name/he/helm-docs/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - zypper - helm-docs - 1.14.2-1.9: normalized package name match | openSUSE Tumbleweed package metadata: helm-docs from https://download.opensuse.org/tumbleweed/repo/oss/repodata/50b07339cb64c8ed4091bdbabddadc1ff5737b090e478818a195b40d8a3292861a879139b4a3987c31109699fde9fbf4a716367ddf4eef77da75f96e3193d6ed-primary.xml.zst | A tool for automatically generating markdown documentation for helm charts | https://github.com/norwoodj/helm-docs - Scoop - main/helm-docs: normalized package name match | Scoop official bucket manifest trees: bucket/helm-docs.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 ## Combined YAML source View the package source record on GitHub. [combined/helm-docs.yml](https://github.com/mxcl/pkgdb/blob/main/combined/helm-docs.yml) ## 来源 - pkg.so package database - Geiger risk classifier - curated package history - pkgdb category and tag curation - external package-manager database matches - cross-ecosystem install command graph