Skip to main content

Documentation Index

Fetch the complete documentation index at: https://pgtofu.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Quick Start

# Clone and set up
git clone https://github.com/accented-ai/pgtofu.git
cd pgtofu
go mod download

# Build and test
go build -o /tmp/pgtofu ./cmd/pgtofu
go test ./...
golangci-lint run

​
Prerequisites

  • Go 1.25 or later
  • Docker (for running PostgreSQL locally)
  • Git

​
Running PostgreSQL Locally

# Standard PostgreSQL
docker run -d --name pgtofu-postgres \
  -e POSTGRES_USER=dev -e POSTGRES_PASSWORD=dev -e POSTGRES_DB=testdb \
  -p 5432:5432 postgres:15

# TimescaleDB (for full feature testing)
docker run -d --name pgtofu-timescale \
  -e POSTGRES_USER=dev -e POSTGRES_PASSWORD=dev -e POSTGRES_DB=testdb \
  -p 5433:5432 timescale/timescaledb:latest-pg15

​
Development Guide

For detailed development information, see CLAUDE.md in the repository. It covers:
  • Architecture overview and data flow
  • Package structure and core types
  • How to add new features and change types
  • Testing patterns and conventions
  • Debugging tips

​
Project Structure

pgtofu/
├── cmd/pgtofu/main.go      # CLI entry point
├── internal/
│   ├── cli/                # Cobra commands
│   ├── schema/             # Data models
│   ├── extractor/          # PostgreSQL → JSON
│   ├── parser/             # SQL files → JSON
│   ├── differ/             # Schema comparison
│   ├── generator/          # DDL generation
│   └── graph/              # Topological sort
└── pkg/database/           # Database connection

​
Running Tests

go test ./...                          # All tests
go test -short ./...                   # Skip database tests
go test -v ./internal/parser/...       # Specific package
go test -v -run TestTableParsing ./... # Specific test
go test -race -coverprofile=cov.out ./...  # With coverage

​
Pull Request Process

  1. Create a branch: git checkout -b feature/your-feature
  2. Make changes and add tests
  3. Verify: 
    go test -race ./...
golangci-lint run
  4. Submit PR with clear description

​
PR Description Template

## What
Summary of changes

## Why
Motivation or issue being fixed

## Testing
How you tested the changes

​
Getting Help

​
Code of Conduct

Be respectful and inclusive. We follow the Contributor Covenant.