Installing pGenie on Windows¶

There are two ways to install pGenie on Windows: downloading a pre-built binary or building from source.

Option 1 — Pre-built Binary¶

A pre-built binary for Windows (x86-64) is available on the pGenie releases page. The binary is a standalone .exe file.

Download the latest binary from the releases page:

Invoke-WebRequest -Uri "https://github.com/pgenie-io/pgenie/releases/latest/download/pgn-windows-x86_64.exe" `
  -OutFile pgn.exe

Move pgn.exe to a directory on your PATH. A common choice is C:\tools\ or any directory you have already added to your user PATH. You can also add its current location to your PATH via the System Properties dialog or your PowerShell profile:
```
# Add the current directory to PATH permanently (current user)
[System.Environment]::SetEnvironmentVariable(
  "Path",
  "$([System.Environment]::GetEnvironmentVariable('Path','User'));$PWD",
  "User"
)
```
Verify the installation (open a new terminal after updating PATH):
```
pgn --help
```

Option 2 — From Source¶

Building from source gives you full control.

Stack¶

Stack manages the compiler and dependencies entirely on its own, making it the fastest path to building pGenie from source. No separate toolchain installation is required.

Install Stack¶

Download and run the Stack installer for Windows from the official Stack installation guide, or use Scoop:

scoop install stack

Build and install pGenie¶

Clone the repository:

git clone https://github.com/pgenie-io/pgenie.git
cd pgenie

Install the pgn executable:
```
stack install
```
Stack will download the required GHC version automatically if needed, compile pGenie, and install the pgn binary into %APPDATA%\stack\bin.

Ensure %APPDATA%\stack\bin is on your PATH. Add it via the System Properties dialog or your PowerShell profile:

[System.Environment]::SetEnvironmentVariable(
  "Path",
  "$([System.Environment]::GetEnvironmentVariable('Path','User'));$env:APPDATA\stack\bin",
  "User"
)

Verify the installation (open a new terminal after updating PATH):
```
pgn --help
```

Cabal¶

Cabal is the standard Haskell build tool. It requires a GHC compiler to be installed separately, which you can obtain via GHCup.

Prerequisites¶

Download and run the GHCup installer for Windows from get-ghcup.haskell.org. The installer will set up GHC and Cabal.

Build and install pGenie¶

Clone the repository:

git clone https://github.com/pgenie-io/pgenie.git
cd pgenie

Install the pgn executable:
```
cabal install
```
Cabal will compile pGenie and install the pgn binary into %APPDATA%\cabal\bin.

Ensure %APPDATA%\cabal\bin is on your PATH. Add it via the System Properties dialog or your PowerShell profile:

[System.Environment]::SetEnvironmentVariable(
  "Path",
  "$([System.Environment]::GetEnvironmentVariable('Path','User'));$env:APPDATA\cabal\bin",
  "User"
)

Verify the installation (open a new terminal after updating PATH):
```
pgn --help
```

Docker Requirement¶

Install Docker Desktop and ensure the Docker daemon is running before invoking pgn.