Installing pGenie on Linux¶

There are three ways to install pGenie on Linux: using Homebrew, downloading a pre-built binary, or building from source.

Option 1 — Homebrew¶

Homebrew is available on Linux and provides the simplest installation path, handling libpq as a dependency automatically.

Install pre-built binary (fastest)¶

brew install pgenie-io/tap/pgn

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 — Pre-built Binary¶

Pre-built binaries for Linux (x86-64) are available on the pGenie releases page. The binary is distributed as a .tar.gz archive.

Download the latest archive from the releases page:

curl -fsSL https://github.com/pgenie-io/pgenie/releases/latest/download/pgn-linux-x64.tar.gz \
  -o pgn-linux-x64.tar.gz

Extract the binary:
```
tar -xzf pgn-linux-x64.tar.gz
```
Move the binary to a directory on your PATH:
```
sudo mv pgn /usr/local/bin/pgn
```

Install the libpq runtime library. pGenie links dynamically against PostgreSQL's C client library:

# Debian / Ubuntu
sudo apt install libpq5

# Fedora / RHEL
sudo dnf install libpq

# Arch Linux
sudo pacman -S postgresql-libs

Verify the installation:
```
pgn --help
```

Option 3 — From Source¶

Building from source gives you full control.

Prerequisites¶

Install the libpq development headers. The build links against PostgreSQL's C client library:

# Debian / Ubuntu
sudo apt install libpq-dev

# Fedora / RHEL
sudo dnf install libpq-devel

# Arch Linux
sudo pacman -S postgresql-libs

Stack¶

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

Install Stack

Run the official one-line installer:
```
curl -sSL https://get.haskellstack.org/ | sh
```
or
```
wget -qO- 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 (.bashrc, .zshrc, 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 (.bashrc, .zshrc, etc.):
```
export PATH="$HOME/.cabal/bin:$PATH"
```
Verify the installation:
```
pgn --help
```

Docker Requirement¶

Docker must be running as a daemon before invoking pgn:

systemctl start docker
# or
sudo service docker start

Your user should be in the docker group to avoid requiring sudo:

sudo usermod -aG docker $USER
newgrp docker