# 使用 Homebrew 安装 action-docs

查看 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/zh-hans/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://pkg.so/zh-hans/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://pkg.so/zh-hans/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://pkg.so/zh-hans/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [node](https://pkg.so/zh-hans/brew/node/) - Runtime dependency declared by Homebrew.
- [mdbook](https://pkg.so/zh-hans/brew/mdbook/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [mkdocs-material](https://pkg.so/zh-hans/brew/mkdocs-material/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [docmd](https://pkg.so/zh-hans/brew/docmd/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [ronn](https://pkg.so/zh-hans/brew/ronn/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [docfx](https://pkg.so/zh-hans/brew/docfx/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [nef](https://pkg.so/zh-hans/brew/nef/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [doxygen](https://pkg.so/zh-hans/brew/doxygen/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation.
- [docutils](https://pkg.so/zh-hans/brew/docutils/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation.
- [action-validator](https://pkg.so/zh-hans/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/zh-hans/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/zh-hans/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