action-docs for Mac 版
为 GitHub Actions 生成文档
action-docs 是什么
action-docs 是一个命令行工具,用来根据 action.yml 定义文件生成和更新 GitHub Actions 或 workflow 的文档。它的核心思路是让文档跟着配置走:在 README 中插入特定注释块后,运行 `action-docs -u` 就能自动更新名称标题、描述、输入、输出、用法和 runs 等章节,避免手动维护文档与 action 定义脱节。除了默认的 action.yml,也可以通过 `-s` 选项或标签中的 `source` 属性指定其他 action 文件;需要更新其他 Markdown 文件时,在命令后加上文件名即可。它还支持将生成的 Markdown 文档直接打印到控制台,方便预览或复制。如果希望在 GitHub workflow 中自动完成 README 更新,可以配合 action-docs-action 使用。这个工具适合维护 GitHub Actions 的开发者,尤其是 action 输入输出经常变动、又不想反复手改 README 的团队。项目采用 MIT 许可证,欢迎贡献。
如何安装 action-docs
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
最近一次更新为 2024-11-10,当前版本 v2.5.1,共记录最近 10 个版本。
| 版本 | 发布日期 | 类型 | 大小 | macOS | Windows | Linux |
|---|---|---|---|---|---|---|
| v2.5.1 | 2024-11-10 | 稳定版 | — | — | — | — |
| v2.5.0 | 2024-10-12 | 稳定版 | — | — | — | — |
| v2.4.3 | 2024-09-03 | 稳定版 | — | — | — | — |
| v2.4.2 | 2024-07-03 | 稳定版 | — | — | — | — |
| v2.4.1 | 2024-04-27 | 稳定版 | — | — | — | — |
| v2.4.0 | 2024-03-13 | 稳定版 | — | — | — | — |
| v2.3.0 | 2024-03-09 | 稳定版 | — | — | — | — |
| v2.2.0 | 2024-03-06 | 稳定版 | — | — | — | — |
| v2.1.0 | 2024-02-16 | 稳定版 | — | — | — | — |
| v2.0.1 | 2024-02-14 | 稳定版 | — | — | — | — |
数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。
二进制包支持平台
Homebrew 官方提供的预编译包(bottle)覆盖:
- all
⚠️ 未提供 Intel Mac 的预编译包,Intel 机型需要通过 brew install --build-from-source 从源码编译。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| action-docs | v2.5.1 | MIT | 命令行 | 8 |
| cobra-cli | v1.3.0 | Apache-2.0 | 命令行 | 2 |
| tygo | v0.2.21 | MIT | 命令行 | 2 |
| swiftplantuml | 0.8.1 | MIT | 命令行 | 2 |
命令行工具中的类似应用
cobra-cli
cobra-cli 是 Cobra 官方提供的命令行生成工具,用来快速创建基于 Cobra 的 Go CLI 应用并为其添加子命令。tygo
tygo 是一个从 Go 源码生成 TypeScript 类型定义的工具,目标是让这件事“开箱即用”。swiftplantuml
SwiftPlantUML 是一个用 Swift 编写的命令行工具和 Swift Package,能从 Swift 代码自动生成 UML 类图。abnfgen
abnfgen 是一款命令行小工具,专门用来按 ABNF 文法生成随机的示例文档。ali
ali 是一个负载测试工具,灵感来自 vegeta 和 jplot,主打实时分析能力。openssl@4
OpenSSL 是一套开源、商用级、功能完整的加密工具箱,主要服务于 TLS(早期称 SSL)、DTLS 和 QUIC 协议。所属分类:命令行工具