CAPYSQUASH Logo

CAPYSQUASH

BETA
DOCUMENTATION

LEARN.
BUILD.
SHIP.

EVERYTHING YOU NEED TO MASTER PG-SQUASH

GETTING STARTED

CORE CONCEPTS

GITHUB APP

CLI USAGE

PLATFORMS

ADVANCED

INSTALLATION

GITHUB APP (COMING SOON)

THE EASIEST WAY TO GET STARTED. AUTOMATIC PR CREATION, ZERO CONFIG.

  1. JOIN THE WAITLIST FOR EARLY ACCESS
  2. GET NOTIFIED WHEN THE APP IS READY
  3. INSTALL WITH ONE CLICK
  4. START SQUASHING MIGRATIONS AUTOMATICALLY

CLI INSTALLATION

FOR LOCAL DEVELOPMENT AND CI/CD PIPELINES.

curl -sSL https://get.pgsquash.dev | sh

OR WITH GO:

go install github.com/dominikospritis/pg-squash@latest

QUICK START

1

NAVIGATE TO YOUR PROJECT

cd your-supabase-project
2

RUN PG-SQUASH

pg-squash analyze
3

REVIEW THE OUTPUT

PG-SQUASH WILL SHOW YOU WHICH MIGRATIONS CAN BE SAFELY SQUASHED

4

SQUASH

pg-squash squash --safety=standard

DONE! YOUR MIGRATIONS ARE NOW CLEANED UP.

SAFETY LEVELS

CONSERVATIVE

ONLY SQUASH MIGRATIONS THAT ARE 100% SAFE. BEST FOR PRODUCTION.

  • NO SCHEMA CHANGES
  • NO DATA CHANGES
  • ONLY COMBINES IDENTICAL OPERATIONS

STANDARD (DEFAULT)

BALANCED APPROACH. SAFE FOR MOST TEAMS.

  • COMBINES COMPATIBLE OPERATIONS
  • DOCKER VALIDATION BEFORE COMMIT
  • PRESERVES SCHEMA EQUIVALENCE

AGGRESSIVE

MAXIMUM CLEANUP. USE WITH CAUTION.

  • AGGRESSIVE OPERATION COMBINING
  • REMOVES REDUNDANT CHANGES
  • STILL VALIDATES WITH DOCKER

NEED HELP?

JOIN OUR COMMUNITY OR REACH OUT DIRECTLY