CAPYSQUASH

Getting Started

Start optimizing your PostgreSQL migrations with CAPYSQUASH in minutes

Getting Started with CAPYSQUASH

Choose your path: Visual platform for teams or powerful CLI for developers

CAPYSQUASH offers two ways to optimize your PostgreSQL migrations—both powered by the same intelligent pgsquash-engine technology. Pick the path that fits your workflow.

Choose Your Experience

CAPYSQUASH Platform

Visual interface with team collaboration, GitHub automation, and enterprise features

✓ One-click optimization

✓ Visual dashboards & analytics

✓ GitHub PR automation

✓ Team collaboration & RBAC

✓ API access & webhooks

✓ Scheduled cleanups

Platform Quickstart →

Get started in 5 minutes

capysquash-cli

Free command-line tool for developers who prefer terminal workflows

✓ 100% free & open source

✓ Local-first operations

✓ Full feature parity

✓ CI/CD ready

✓ Interactive TUI mode

✓ No account required

Install CLI →

Install in 2 minutes

Not Sure Which to Choose?

Start with the free capysquash-cli to experience the power of migration optimization. You can upgrade to the CAPYSQUASH Platform anytime for team features and automation.

Quick Start Paths

For Teams & Organizations

Sign Up for CAPYSQUASH

Create your account at capysquash.dev

  • Email, Google, or GitHub sign-in
  • No credit card required
  • Free plan includes 3 projects

Create Your First Project

Set up your workspace and connect your repository

  • Name your project
  • Choose safety level
  • Connect GitHub (optional)

Run Your First Analysis

Upload migrations and click "Analyze"

  • See consolidation opportunities
  • Review safety warnings
  • Download optimized migrations

→ Full Platform Quickstart

For Individual Developers

Install with Homebrew:

brew install capysquash/tap/capysquash-cli

Or with Go:

go install github.com/CAPYSQUASH/capysquash-cli/cmd/capysquash@latest

Verify installation:

capysquash --version
# capysquash-cli version 0.9.7

With Scoop:

scoop bucket add capysquash https://github.com/CAPYSQUASH/scoop-bucket
scoop install capysquash-cli

Or with WSL + Go:

go install github.com/CAPYSQUASH/capysquash-cli/cmd/capysquash@latest

Verify installation:

capysquash --version

Pull the image:

docker pull capysquash/capysquash-cli:latest

Run analysis:

docker run -v $(pwd)/migrations:/migrations \
  capysquash/capysquash-cli analyze /migrations

→ Complete CLI Installation Guide

Your First Optimization

Quick CLI Tutorial

cd your-project

Analyze Migrations

capysquash analyze migrations/

You'll see:

  • Current file count
  • Consolidation opportunities
  • Estimated reduction percentage

Squash Migrations

capysquash squash migrations/*.sql \
  --output clean/ \
  --safety standard

Validate Results

capysquash validate migrations/ clean/

Docker validation ensures perfect schema equivalence

Understanding the Basics

Before diving deeper, understand these core concepts:

How It Works

Learn about parsing, dependency analysis, and consolidation

Safety Levels

Choose between conservative, standard, aggressive, and paranoid

Docker Validation

Understand how we guarantee zero breakage

Common Use Cases

Solo Developer

Best choice: capysquash-cli

Perfect for local development, experimentation, and CI/CD integration without needing team features.

Small Team (2-5 people)

Best choice: CAPYSQUASH Platform (Creator or Professional plan)

Get team collaboration, shared projects, and GitHub automation for coordinated migration management.

Agency or Consultancy

Best choice: CAPYSQUASH Platform (Agency plan)

Manage multiple client projects with white-label reports and team member management.

Enterprise Organization

Best choice: CAPYSQUASH Platform (Enterprise plan)

SSO/SAML, advanced security, compliance features, and dedicated support.

Platform-Specific Guides

CAPYSQUASH works seamlessly with popular PostgreSQL platforms:

Supabase

Auto-detects auth, RLS, storage, and realtime patterns

Neon

Optimized for serverless PostgreSQL with branching support

Railway

Fast deploys with Railway-specific optimizations

ORM Integration Guides

Works with your favorite ORM:

Prisma

Preserves Prisma metadata and migration checksums

Drizzle

Maintains Drizzle tracking tables and conventions

Clerk

Protects Clerk authentication tables and JWT patterns

Next Steps by Role

  1. Install capysquash-cli
  2. Run your first analysis
  3. Understand safety levels
  4. Set up CI/CD integration
  5. Explore advanced features
  1. Sign up for CAPYSQUASH
  2. Invite team members
  3. Set up GitHub integration
  4. Configure automated workflows
  5. Review best practices
  1. Understand the architecture
  2. Set up API access
  3. Configure CI/CD pipelines
  4. Set up webhooks
  5. Monitor with analytics
  1. Compare CLI vs Platform
  2. Review enterprise features
  3. Understand compliance & security
  4. Explore subscription plans
  5. Check platform integrations

Getting Help

Documentation

Comprehensive guides and API references

GitHub Discussions

Ask questions and share experiences

Troubleshooting

Common issues and solutions

Contact Support

Get help from our team

What's Next?

For Teams

Platform Quickstart →

For Developers

Install CLI →

How is this guide?

On this page

Getting Started with CAPYSQUASHChoose Your ExperienceQuick Start PathsFor Teams & OrganizationsSign Up for CAPYSQUASHCreate Your First ProjectRun Your First AnalysisFor Individual DevelopersYour First OptimizationQuick CLI TutorialNavigate to Your ProjectAnalyze MigrationsSquash MigrationsValidate ResultsUnderstanding the BasicsCommon Use CasesSolo DeveloperSmall Team (2-5 people)Agency or ConsultancyEnterprise OrganizationPlatform-Specific GuidesORM Integration GuidesNext Steps by RoleRecommended PathRecommended PathRecommended PathRecommended PathGetting HelpWhat's Next?