This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Install

Learn how to install GitHub Quick Review (ghqr)

    Install on Linux or macOS

    bash -c "$(curl -fsSL https://raw.githubusercontent.com/microsoft/ghqr/main/scripts/install.sh)"

    Or download the latest release from the releases page.

    Install on Windows

    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/microsoft/ghqr/main/scripts/install.ps1'))

    Or download the latest release from the releases page.

    Install with Docker

    docker pull ghcr.io/microsoft/ghqr:latest

    Run a scan using Docker:

    docker run --rm \
  -e GITHUB_TOKEN="$GITHUB_TOKEN" \
  ghcr.io/microsoft/ghqr:latest \
  scan -o my-org

    Build from Source

    Requires Go 1.24 or higher.

    git clone https://github.com/microsoft/ghqr.git
cd ghqr
make

    The compiled binary is placed in the bin/ directory.