pGenie

Type-safe PostgreSQL client code generator. This repository contains the source code for the pgn CLI tool.

📚 Full documentation: pgenie.io/docs

Quick Start

New to pGenie? The Learn pGenie in Y minutes tutorial gets you up and running fast.

Want to explore a working project right away? Check out the demo repository — a ready-to-run project you can clone and experiment with immediately.

Installation

From a Binary Distribution

Pre-built binaries are available for common platforms. See the Installation Guide for instructions.

Building from Source

Prerequisites

• Docker — Must be installed and running. pGenie uses Docker to analyze SQL in a real PostgreSQL environment.
• libpq — Required for building the Haskell bindings to PostgreSQL. On Debian/Ubuntu, install with sudo apt-get install libpq-dev, on macOS with brew install libpq.

Using Stack

Stack is the quickest way to build and install pGenie from source.

1. Install Stack

2. Clone the repository and build:

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

Using Cabal

Cabal is the preferred option for Haskell developers already familiar with the ecosystem:

1. Install Cabal

2. Clone the repository and build:

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