---

Title: Getting Started. Description: 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

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

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: `powershell scoop bucket add capysquash https://github.com/CAPYSQUASH/scoop-bucket scoop install capysquash-cli


**Or with WSL + Go:**
`bash
go install github.com/CAPYSQUASH/capysquash-cli/cmd/capysquash@latest

Verify installation: powershell capysquash --version

Pull the image: bash docker pull capysquash/capysquash-cli:latest

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

→ Complete CLI Installation Guide

Your First Optimization

Quick CLI Tutorial

Navigate to Your Project

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:

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:

ORM Integration Guides

Works with your favorite ORM:

Next Steps by Role

Recommended Path

Getting Help

What's Next?

Platform Quickstart →.

Install CLI →.

---

On this page