macOS
Homebrewverified · 100%
brew install action-docslocal Homebrew formula metadata
brew
Install action-docs with Homebrew
Generate docs for GitHub actions. Version 2.5.1 via Homebrew; verified 2026-05-26.
install
Additional install commands
overview
Package summary
Generate docs for GitHub actions
Project links
Commands and aliases
- action-docs
history
Project history and usage
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.
Project history
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.
Adoption history
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.
How it is used
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.
Why package nerds care
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.
Timeline
- 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.
Sources
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew post-install hook is recorded in formula metadata.
- Homebrew bottle metadata is available for 1 platform targets.
- Installs with 1 runtime dependencies.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
action-docs | cli | global executable |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-07-08
manager version2.5.1
manager updated2026-05-26
local dataok
upstreamnot checked
latest detectednot detected
https://github.com/npalm/action-docs
- infoNo cached GitHub release or tag data was available.https://github.com/npalm/action-docsnone confidence
install metadata
Package metadata
| Package key | brew:action-docs |
|---|---|
| Version | 2.5.1 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/action-docs |
| Homepage | https://github.com/npalm/action-docs |
| Repository | https://github.com/npalm/action-docs |
| Upstream docs | https://github.com/npalm/action-docs#readme |
| License | MIT |
| Source archive | https://registry.npmjs.org/action-docs/-/action-docs-2.5.1.tgz |
| Last updated | 2026-05-26T23:37:47-04:00 |
| Pulse | updated |
| Dependencies | node |
| Bottle | available (on all) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
Source database details
| 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 |
|
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated package history
- package relationship graph
- package version freshness
- package-page enrichment