# 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
- **Version:** 2.5.1
- **Source summary:** Generate docs for GitHub actions
- **Homepage:** <https://github.com/npalm/action-docs>
- **Last updated:** 2026-05-26T23:37:47-04:00
- **Generated:** 2026-08-03T19:37:03+00:00

## Executables

- action-docs (alias)

## Install behavior

- Bottle: not available

## Freshness

- Page generated: 2026-08-03
- Package-manager version: 2.5.1
## 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

- <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>


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- 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)


## Sources

- pkg.so package database
- Geiger risk classifier
- curated package history
- pkgdb category and tag curation
- cross-ecosystem install command graph