# action-docs を Homebrew でインストール

action-docs のインストール経路、実行ファイル、メタデータ、AI エージェント向けセキュリティノートを確認します。

## インストール

```sh
sudo av install brew:action-docs
```

追加のインストールコマンド:

### macOS

- Homebrew (100%):

```sh
brew install action-docs
```

  証拠: local Homebrew formula metadata

## パッケージ情報

- **パッケージキー:** brew:action-docs
- **パッケージマネージャ:** Homebrew
- **パッケージマネージャページ:** <https://formulae.brew.sh/formula/action-docs>
- **バージョン:** 2.5.1
- **ソース概要:** Generate docs for GitHub actions
- **ホームページ:** <https://github.com/npalm/action-docs>
- **リポジトリ:** <https://github.com/npalm/action-docs>
- **ライセンス:** MIT
- **ソースアーカイブ:** <https://registry.npmjs.org/action-docs/-/action-docs-2.5.1.tgz>
- **最終更新:** 2026-05-26T23:37:47-04:00
- **生成日時:** 2026-08-04T22:13:35+00:00

## 実行可能ファイル

- action-docs (cli)
- action-docs (エイリアス)

## 依存関係

- node

## インストール挙動

- post-install フック: 未定義
- Bottle: 利用可能 対象 all

## バージョンと鮮度

- ページ生成日: 2026-08-04
- マネージャ版: 2.5.1
- マネージャ更新日: 2026-05-26
- ローカルデータ: OK
- 上流リポジトリ: https://github.com/npalm/action-docs
- 情報: No cached GitHub release or tag data was available.
## プロジェクトの歴史と使われ方

action-docs is a Node.js CLI and library that generates and updates Markdown documentation for GitHub Actions and workflows from action.yml-style metadata.

### プロジェクトの歴史

The repository was created in 2021, and the official releases begin with 1.0.0 in March 2021. Its README frames the tool around keeping README sections synchronized with GitHub action or workflow definitions.

### 採用の歴史

The README advertises npm installation, CLI use, README update markers, a JavaScript API, and a companion GitHub Action. That adoption path matches the GitHub Actions ecosystem: project authors can run the CLI locally, in npm workflows, or through automation.

### 使われ方

Users add action-docs HTML comment markers to Markdown files, then run action-docs to print generated docs or action-docs --update-readme to update files in place. Options cover source action/workflow files, table-of-contents level, line breaks, and custom README targets.

### パッケージ好きにとっての重要性

action-docs matters to package-manager users because it turns GitHub Actions metadata into reproducible documentation output, a small automation task that fits naturally into npm scripts, Homebrew-installed CLIs, and repository maintenance workflows.

### タイムライン

- 2021-02-20: GitHub repository created.
- 2021-03-07: 1.0.0 release published.
- 2024-02-04: 2.0.0 release published.
- 2024-11-10: 2.5.1 release published.

### Related projects

- Related projects include GitHub Actions documentation generators, README updaters, markdown automation tools, and npalm/action-docs-action.

### ソース

- <https://api.github.com/repos/npalm/action-docs>
- <https://api.github.com/repos/npalm/action-docs/releases>
- <https://raw.githubusercontent.com/npalm/action-docs/master/README.md>


## セキュリティノート

narrow executable package without higher-risk signals.

- **Geiger リスク:** グリーン / 低
- narrow executable package without higher-risk signals

## ソースデータベース詳細

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** action-docs
- **Version Scheme:** 0
- **Revision:** 0
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** stable


## 関連リンク

- [Source-control packages](https://pkg.so/ja/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://pkg.so/ja/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://pkg.so/ja/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://pkg.so/ja/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [node](https://pkg.so/ja/brew/node/) - Runtime dependency declared by Homebrew.
- [mdbook](https://pkg.so/ja/brew/mdbook/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [mkdocs-material](https://pkg.so/ja/brew/mkdocs-material/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [docmd](https://pkg.so/ja/brew/docmd/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [ronn](https://pkg.so/ja/brew/ronn/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [docfx](https://pkg.so/ja/brew/docfx/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [nef](https://pkg.so/ja/brew/nef/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [doxygen](https://pkg.so/ja/brew/doxygen/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation.
- [docutils](https://pkg.so/ja/brew/docutils/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation.
- [action-validator](https://pkg.so/ja/brew/action-validator/) - Package names and metadata indicate a similar tool family. Shared terms: action, actions, cli, developer, developer-tools.
- [reveal-md](https://pkg.so/ja/brew/reveal-md/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, documentation, markdown.
- [actions-languageserver](https://pkg.so/ja/brew/actions-languageserver/) - Both packages touch the same language runtime or ecosystem. Shared terms: actions, cli, developer, developer-tools, github.

## Combined YAML source

View the package source record on GitHub. [combined/action-docs.yml](https://github.com/mxcl/pkgdb/blob/main/combined/action-docs.yml)


## ソース

- pkg.so package database
- Geiger risk classifier
- package-page enrichment
- curated package history
- package version freshness
- pkgdb category and tag curation
- package relationship graph
- cross-ecosystem install command graph