Get started

Requires Docker. This is the shortest verified path; the full options are in the docs.

Run the guided demo

git clone https://github.com/pgquery-narrative/pgquerynarrative.git
cd pgquerynarrative
make demo

Open http://localhost:8080.

Use your own database

The guided demo seeds its own data. To point PgQueryNarrative at a database you already have, see Connect your PostgreSQL.

Other install methods

Container image, release archive, or a source build: see Installation.

Try pqn instead — no server needed

pqn is a separate terminal tool and PostgreSQL extension. It talks to your database directly and doesn't need this server running; see pqn quick start.