Quick Start

What this page covers

From zero to first usable Postgram with Docker, health checks, and a first authenticated call.

Core workflow

1. Start the containers:

docker compose up -d --build

2. Check service health:

curl http://127.0.0.1:3100/health

Expected JSON includes:

{
  "status": "ok",
  "postgres": "connected"
}

3. Create your first API key:

./bin/pgm-admin key create \
  --name local \
  --scopes read,write,delete \
  --visibility personal,work,shared

4. Set client auth and store/search one fact:

export PGM_API_URL=http://127.0.0.1:3100
export PGM_API_KEY='<plaintext-key>'
pgm store "Postgram quick start is working" --type=memory --tags quickstart
pgm search "quick start"

Notes

• If health fails, inspect docker compose logs for startup and Postgres boot issues.
• The CLI path above uses the wrapper from the repo; standalone users can also run the @ivotoby/postgram-cli package directly after installation.