go-gitgres

README

go-gitgres

Store Git objects and refs in PostgreSQL. One binary acts as CLI and Git remote-helper.

Uses Go 1.26, go-git, sqlc, and pgx.

Build

make build

Produces gitgres-backend and a git-remote-gitgres symlink. Or: go build -o gitgres-backend ./cmd/backend.

Usage

Apply the schema first (see parent gitgres for createdb). Then:

CLI

./gitgres-backend init "dbname=gitgres_test" myrepo
./gitgres-backend push "dbname=gitgres_test" myrepo /path/to/repo
./gitgres-backend clone "dbname=gitgres_test" myrepo /path/to/dest
./gitgres-backend ls-refs "dbname=gitgres_test" myrepo

Remote helper

Install the binary as git-remote-gitgres in PATH. Then:

git remote add pg gitgres::dbname=gitgres_test/myrepo
git push pg main
git clone gitgres::dbname=gitgres_test/myrepo /path/to/clone

Connecting to Postgres

Connection uses a single libpq-style string: pass it as conninfo to the CLI or to db.OpenPool in code. For a secured Postgres instance, include the options you need in that string (or set PGCONN, PGPASSWORD, etc.):

• TLS: sslmode=require (or verify-full, verify-ca)
• User / password: user=myuser and password=secret, or set PGUSER / PGPASSWORD
• Host / port: host=db.example.com port=5432

Example with TLS:
./gitgres-backend init "host=db.example.com port=5432 dbname=gitgres user=gitgres sslmode=require" myrepo
Prefer PGPASSWORD in the environment instead of putting the password in the string when possible.

Tests

make test
# or
go test ./...

DB tests skip when Postgres is unavailable. For coverage:

make test-coverage
# HTML: go tool cover -html=coverage.out

For full coverage including DB-backed code (uses testcontainers; requires Docker):

make test-integration

Library

Use the storer from Go. See go doc go-gitgres/internal/db, go doc go-gitgres/internal/storer, go doc go-gitgres/internal/backend.

import "go-gitgres/internal/db"
import "go-gitgres/internal/storer"

pool, _ := db.OpenPool(ctx, "dbname=gitgres_test")
s, _ := storer.NewPostgresStorer(ctx, pool, "my-repo")
// s implements storage.Storer for go-git

Examples

The examples directory (vulnerability scan and SBOM with Trivy or Syft+Grype) is a separate Go module so its dependencies do not affect this project. Run from examples/: go run ./trivy ... / go run ./syft-grype .... See examples/README.md.

SQL

Schema and queries live in sql/. Generate Go and lint:

make sqlc       # sqlc generate
make lint-sql   # sqlfluff lint sql/ (pip install sqlfluff)