Skip to main content

Requirements

This page is for anyone preparing a workstation for local PRFlow runs. Cloud runs have a separate environment and runner setup path.

Required Local Tools

Install one supported coding client and make these tools available on PATH: The repository must be a Git repository connected to GitHub. Your GitHub identity needs enough access to read the issue and create branches, issue comments and pull requests. You can inspect the main versions and authentication state with:
PRFlow avoids GNU-only command flags, so the standard macOS and BSD command-line tools are supported.

PyYAML Is Advisory for Local Runs

PyYAML is recommended but is not a hard local prerequisite. Install it with:
Without PyYAML, one helper cannot apply severity demotions from deferred-findings blocks in pull-request bodies. The review continues with the findings intact. This can surface and fix more findings than intended, so installing PyYAML avoids unnecessary churn. The local preflight reports missing PyYAML as an advisory and still succeeds. PyYAML remains required by PRFlow’s own test suite, continuous integration and cloud tiers.

Windows Bash Choices

On Windows, use any one of these POSIX Bash environments:
  • Windows Subsystem for Linux (WSL) Bash.
  • Git Bash.
  • MSYS2 Bash.
PRFlow does not require one specific choice. Set the frozen DEVFLOW_BASH environment variable when you need to select the Bash executable explicitly:
A PowerShell-only host with none of these Bash environments cannot run PRFlow’s shell helpers. Windows may also expose Python as python or py -3 without a python3 command. Follow installation troubleshooting if preflight reports that case.

Let Initialization Check the Environment

The recommended init skill runs the bundled preflight after it scaffolds repository files. Missing tools are reported with remedies. They do not undo the scaffold that was already written.