action-tools is a CLI toolkit for working with GitHub Actions and reusable workflows.
> action-tools gendocs action --help
Usage: action-tools gendocs action [OPTIONS]
Generate README.md from GitHub Actions action.yml
Options:
--input PATH Path to action.yml [default: ./action.yml]
--output PATH Path for generated README [default:
./README.md]
--usage-examples-dir DIRECTORY Path to directory containing custom usage
examples to include
--help Show this message and exit.
> action-tools usage --help
Usage: action-tools usage [OPTIONS] TARGET
Search GitHub for repositories that reference a reusable workflow or action.
TARGET must be a reference to a GitHub Action or reusable workflow as would
be specified in a job or step's `uses` directive.
Options:
--token TEXT GitHub token for authentication
--help Show this message and exit.
Example Usage:
action-tools usage "my-org/my-repo/.github/workflows/build.yml"
action-tools usage "my-org/my-action/action-dir"
action-tools usage "my-org/my-action@v1.2.3"
Example Output:
some-org/some-repo
some-org/another-repo
Before you begin, ensure you have the following installed:
You can verify installation with:
uv --versionTo initialize your development environment, run:
make initThis will:
- Create a virtual environment in
.venvusinguv venv - Install all dependencies declared in
pyproject.tomlviauv sync
After setup, confirm the CLI is working by running:
action-tools --help
This should output the base-level usage instructions for the CLI, similar to:
Usage: action-tools [OPTIONS] COMMAND [ARGS]...
...
Refer to make help for a summary of all available development commands, including those for for linting, formatting, and testing.