macOS
Homebrew確認済み · 100%
brew install helm-docslocal Homebrew formula metadata
brew
helm-docs を Homebrew, Nix, zypper, scoop でインストール
helm-docs のインストール経路、実行ファイル、メタデータ、AI エージェント向けセキュリティノートを確認します。
インストール
追加のインストールコマンド
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
履歴
プロジェクトの歴史と使われ方
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
ソース経路
リポジトリデータから生成
このページは scripts/generate-pkg-sqlite.py が生成した非公開のパッケージ SQLite アーティファクトから av-web によって提供されます。
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