# Install action-docs with Homebrew Generate docs for GitHub actions. Version 2.5.1 via Homebrew; verified 2026-05-26. ## Install ```sh sudo av install brew:action-docs ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install action-docs ``` Evidence: local Homebrew formula metadata ## Package facts - **Package key:** brew:action-docs - **Package manager:** Homebrew - **Package manager page:** - **Version:** 2.5.1 - **Source summary:** Generate docs for GitHub actions - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** MIT - **Source archive:** - **Last updated:** 2026-05-26T23:37:47-04:00 - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - action-docs (cli) - action-docs (alias) ## Dependencies - node ## Install behavior - Post-install hook: not defined - Bottle: available on all ## Freshness - Page generated: 2026-07-08 - Package-manager version: 2.5.1 - Package-manager updated: 2026-05-26 - Local data: ok - Upstream repository: https://github.com/npalm/action-docs - info: No cached GitHub release or tag data was available. ## 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 Notes narrow executable package without higher-risk signals. - **Geiger risk:** green / low - narrow executable package without higher-risk signals ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** action-docs - **Version Scheme:** 0 - **Revision:** 0 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [node](https://www.automicvault.com/pkg/brew/node/) - Runtime dependency declared by Homebrew. - [docfx](https://www.automicvault.com/pkg/brew/docfx/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [docmd](https://www.automicvault.com/pkg/brew/docmd/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [github-markdown-toc](https://www.automicvault.com/pkg/brew/github-markdown-toc/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [go-md2man](https://www.automicvault.com/pkg/brew/go-md2man/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [grip](https://www.automicvault.com/pkg/brew/grip/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [gtree](https://www.automicvault.com/pkg/brew/gtree/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [mdbook](https://www.automicvault.com/pkg/brew/mdbook/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [nef](https://www.automicvault.com/pkg/brew/nef/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [action-validator](https://www.automicvault.com/pkg/brew/action-validator/) - Package names and metadata indicate a similar tool family. Shared terms: action, actions, cli, developer, developer-tools. - [reveal-md](https://www.automicvault.com/pkg/brew/reveal-md/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, documentation, markdown. ## Combined YAML source View the package source record on GitHub. [combined/action-docs.yml](https://github.com/automic-vault/db/blob/main/combined/action-docs.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated package history - package version freshness - av.db category and tag curation - package relationship graph - cross-ecosystem install command graph