Zizmor is a static analysis tool for GitHub Actions, designed to identify common security vulnerabilities in CI/CD setups. It detects issues such as template injection, accidental credential leakage, excessive permission scopes, and impostor commits. Currently at version 1.23.1, the project maintains an active development pace with frequent releases.
pip install zizmorNo compatibility data collected yet for this library.
This quickstart demonstrates how to run `zizmor` as a command-line tool from Python using `subprocess`. The `--target .` flag scans the current directory for GitHub Actions workflows. A GitHub token (GH_TOKEN) is often necessary for `zizmor` to perform comprehensive 'online audits' and resolve remote actions without hitting GitHub API rate limits.
Refer to release notes when upgrading from versions prior to 1.0.0. For later versions, breaking changes are confined to major version increments.
Provide a GitHub token (e.g., via `GH_TOKEN` environment variable or `--github-token` flag) to authenticate requests and increase the rate limit. Consider running `zizmor` with `--offline-audits` if online checks are not critical or rate limits are a concern.
Ensure your repository meets the GitHub Advanced Security requirements for full integration, or use `advanced-security: false` (if using `zizmor-action`) or rely on console output.
Adjust any automation or tooling that consumes SARIF reports from `zizmor` to account for the updated severity mapping if precise categorization is critical.
Ensure `pip install zizmor` completed successfully and add pip's script directory (e.g., `~/.local/bin` on Linux/macOS or `C:\Users\User\AppData\Roaming\Python\Scripts` on Windows) to your system's PATH, or run it using `python -m zizmor`.
Install the package using `pip install zizmor`. If running from the command line, ensure you are in the correct environment or use `python -m zizmor`.
Provide the necessary argument, for example: `zizmor scan .` to analyze the current directory, or `zizmor scan github.com/owner/repo` for a remote repository.
Review and correct the YAML syntax in your configuration file or GitHub Actions workflow. Use a YAML linter or validator to pinpoint the exact location of the error.
No dependency data recorded yet.