Installing pGenie on macOS¶

There are two ways to install pGenie on macOS: using Homebrew or building from source.

Option 1 — Homebrew (Recommended)¶

The Homebrew tap provides two installation modes.

Install pre-built binary (fastest)¶

brew install pgenie-io/tap/pgn

This installs a pre-built binary for your Mac architecture (Apple Silicon or Intel) with no additional dependencies.

Build from source via Homebrew¶

brew install --HEAD pgenie-io/tap/pgn

This builds from the latest master branch and can take several minutes during the first build.

Option 2 — From Source¶

Building from source gives you full control and avoids the Gatekeeper warning.

Prerequisites¶

Install the libpq library via Homebrew:

brew install libpq

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

Run the official one-line installer:
```
curl -sSL https://get.haskellstack.org/ | sh
```
For platform-specific instructions and alternative install methods, see the official Stack installation guide.

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 ~/.local/bin/.
Ensure ~/.local/bin is on your PATH. Add the following to your shell profile (.zshrc, .bashrc, etc.):
```
export PATH="$HOME/.local/bin:$PATH"
```
Verify the installation:
```
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.

Install the Haskell toolchain via GHCup:
```
curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
```
Follow the prompts. GHCup will install GHC and Cabal.

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 ~/.cabal/bin/.
Ensure ~/.cabal/bin is on your PATH. Add the following to your shell profile (.zshrc, .bashrc, etc.):
```
export PATH="$HOME/.cabal/bin:$PATH"
```
Verify the installation:
```
pgn --help
```

Docker Requirement¶

Docker must be running before invoking pgn. With Docker Desktop, the Docker icon should appear in the macOS menu bar. With Colima, ensure you have run colima start.