# 使用 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
- **版本:** 2.5.1
- **来源摘要:** Generate docs for GitHub actions
- **主页:** <https://github.com/npalm/action-docs>
- **最后更新:** 2026-05-26T23:37:47-04:00
- **已生成:** 2026-08-03T19:37:03+00:00

## 可执行文件

- action-docs (别名)

## 安装行为

- Bottle: 不可用

## 版本和新鲜度

- 页面生成时间: 2026-08-03
- 管理器版本: 2.5.1
## 项目历史与用法

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


## 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
- curated package history
- pkgdb category and tag curation
- cross-ecosystem install command graph