Get started with CAPYSQUASH platform in 5 minutes - from signup to your first optimized migration

PLATFORM QUICKSTART: UP AND RUNNING IN 5 MINUTES

Get from zero to your first optimized migration in under 5 minutes. No configuration files, no learning curve, no database expertise required.

This quickstart walks you through the streamlined workflow: sign up, upload migrations, analyze, and download. Simple, visual, and powerful.

WHAT YOU'LL ACCOMPLISH

☑ Create your free CAPYSQUASH account

☑ Set up your first project

☑ Run your first migration analysis

☑ Download optimized migrations

⏱️ Total time: Under 5 minutes

STEP 1: CREATE YOUR ACCOUNT (1 MINUTE)

Head to capysquash.dev and click "Get Started" or "Sign Up".

Choose your sign-up method:

Email + Password (Recommended for first-time users)
Google (Quick one-click signup)
GitHub (Perfect for developers)

No credit card required for the free plan. Start analyzing immediately with 3 projects and 10 analyses per month.

Verify Your Email

Check your inbox for a verification email from CAPYSQUASH.

Click the verification link
You'll be redirected to complete your profile
Takes 30 seconds

Didn't receive it? Check spam folder or click "Resend verification email"

Complete Your Profile

Fill in basic information:

YOUR NAME

How you want to appear in the platform

ORGANIZATION NAME

Your workspace name (e.g., "Acme Startup")

YOUR ROLE

Developer, Tech Lead, CTO, etc. (helps us customize your experience)

Click "Complete Setup" and you're in!

Pro Tip: You can create multiple organizations later if you manage different projects or clients.

Explore the Demo Project (Optional)

CAP YSQUASH automatically creates a demo project for you to explore.

What's in the demo:

Sample "Task Management System" with realistic migrations
Pre-run analysis showing 60% file reduction (10 → 4 files)
Operations breakdown and optimization recommendations
Ready-to-download optimized migrations

Click "Demo Project" from your dashboard to explore the results before analyzing your own migrations.

The demo helps you understand what CAPYSQUASH does without uploading your own files first.

STEP 2: CREATE YOUR FIRST PROJECT (2 MINUTES)

Navigate to Projects

From your dashboard:

Click "Projects" in the sidebar
Click the big "New Project" button

💡 What's a Project? A project represents one database or application. Most teams create separate projects for different environments (Production, Staging, Development) or different applications.

Fill in Project Details

REQUIRED FIELDS

PROJECT NAME

Example: "Production API" or "Mobile Backend"

Production API

DESCRIPTION (OPTIONAL)

Brief description for your team

Main API database for production environment

Configure Settings (Optional)

You can configure these now or later:

Safety Level

Paranoid - Maximum safety, minimal changes
Conservative - Safe for production
Standard ⭐ (Recommended) - Balanced optimization
Aggressive - Maximum consolidation

Database Provider (Optional)

Select your provider: Neon, Supabase, AWS RDS, etc.
Helps with pattern detection

Color & Icon (Optional)

Pick a color for quick visual identification

Our Recommendation: Start with Standard safety level. You can always adjust per-analysis.

Create Project

Click "Create Project" and you're ready to analyze!

You'll be taken to your new project dashboard.

STEP 3: ANALYZE YOUR MIGRATIONS (2 MINUTES)

Upload Migration Files

From your project dashboard, click "Analyze Migrations".

Three ways to upload:

📁 DRAG & DROP

Drag SQL files or a ZIP into the upload area

📂 BROWSE FILES

Click "Browse" and select files from your computer

🔗 GITHUB

Connect repository for automatic uploads

Supported formats:

Individual .sql files
ZIP archives containing SQL files
Numbered migrations (001_create_users.sql)
Timestamp migrations (20250115_add_email.sql)

File limits: Up to 100 files (Free tier), max 10 MB per file

Watch Auto-Detection

Once uploaded, CAPYSQUASH automatically detects your stack:

AUTO-DETECTION IN ACTION

[plugins] Scanning migrations for patterns...
[plugins] Auto-detected: supabase, clerk
[plugins] Found 23 RLS policies to preserve
[plugins] Detected 7 auth schema patterns
[plugins] Ready for optimization in 3.2 seconds

What gets detected automatically:

🟣 Supabase (Auth, RLS, Storage, Realtime)
🔵 Clerk (JWT v2, Organizations)
🟢 Neon (Serverless patterns)
🟡 Auth0 (Custom auth tables)
⚪ NextAuth (Session management)
🔶 Prisma/Drizzle (ORM patterns)

No configuration needed! CAPYSQUASH recognizes everything instantly.

Click "Optimize" and Wait

Click the big "Optimize Now" button
Watch real-time progress (30 seconds to 10 minutes depending on migration count)
See the magic happen!

WHAT HAPPENS DURING OPTIMIZATION

⏱️ Phase 1: Auto-detection (instant)

⏱️ Phase 2: Dependency analysis (30-60 seconds)

⏱️ Phase 3: Smart consolidation (2-5 minutes)

⏱️ Phase 4: Docker validation (3-5 minutes)

☑ Phase 5: Results ready!

Safety Guaranteed: Every optimization is validated by comparing schemas in real PostgreSQL containers. Zero risk.

Review Results

Congratulations! Your first analysis is complete.

What you'll see:

YOUR RESULTS DASHBOARD

287 → 12

Files optimized

95.8%

Reduction

15min → 45s

Deployment time

☑ Perfect schema equivalence verified

⚠️ 3 warnings (non-critical, reviewed)

📊 Operations: 234 consolidated into 45

Explore your results:

📊 Statistics - File reduction, time savings
📁 Before/After - Compare original vs optimized
⚠️ Warnings - Potential issues to review
💡 Recommendations - Best practices suggestions

Download Optimized Migrations

Click "Download" to get your optimized migrations:

Download options:

ZIP Archive ⭐ (Recommended) - All files in one ZIP
Individual Files - Download specific files
Analysis Report - PDF summary

WHAT'S IN THE ZIP?

optimized_migrations.zip
├── 001_create_users_complete.sql
├── 002_create_posts.sql
├── 003_create_comments.sql
├── 004_add_indexes_and_constraints.sql
├── ...
└── MIGRATION_NOTES.md  (explains consolidation)

🎉 YOU'RE DONE!

Congratulations! You've successfully:

☑ Created your CAPYSQUASH account
☑ Set up your first project
☑ Run your first migration analysis
☑ Downloaded optimized migrations

Total time: Under 5 minutes ⚡

UNDERSTANDING AUTHENTICATION

CAPYSQUASH uses different authentication methods depending on how you access it:

🌐 PLATFORM WEB ACCESS

For dashboard and visual interface

Auth Method: Clerk (Email, Google, GitHub)

Used For: Web dashboard, team features, visual workflows

🔑 API KEYS

For programmatic access

Auth Method: API keys (generated in dashboard)

Used For: CI/CD pipelines, webhooks, automation

→ API Authentication Guide

💻 CLI ACCESS

For command-line tool

Auth Method: No auth required (local) OR API keys (platform features)

Used For: Local development, terminal workflows

→ CLI Documentation

Most users only need web authentication (Clerk) for the platform. API keys are optional and only needed for CI/CD automation or custom integrations.