User Guide
Complete guide to using the DevSync.AI dashboard for schema synchronization.
Overview
DevSync.AI dashboard helps you detect schema mismatches between your code and database, visualize differences with detailed reports, generate safe migrations automatically, and apply migrations directly from the dashboard.
Detect Mismatches
Automatically identify differences between code schemas and database schemas.
Generate Migrations
Create SQL migration scripts automatically from detected mismatches.
Apply Safely
Validate and apply migrations with dry-run support and execution tracking.
AI Insights
Get AI-powered explanations of migrations and risk assessments.
Getting Started
Step 1: Sign Up / Log In
- Visit the dashboard homepage
- Click "Get Early Access" or "Sign Up"
- Create an account with email and password
- Verify your email (if required)
- Log in to your account
Step 2: Create a Project
- Click "New Project" in the dashboard
- Enter project details:
- Name: Your project name
- Schema Type: Choose your schema type (Prisma, Supabase, TypeORM, etc.)
- Database Connection (optional): Add later if needed
- Click "Create Project"
Step 3: Run a Scan
To scan your codebase for schema mismatches, use the CLI:
devsync scan \
--project-id <your-project-id> \
--api-url http://localhost:3000 \
--api-key <your-api-key>Scan reports will appear in your project dashboard automatically.
Step 4: View Results
- Navigate to your project
- Click on a scan report
- Review mismatches and suggested fixes
- Generate migrations if needed
Core Features
Project Management
Create and manage your projects. Each project can have multiple scan reports and migrations.
Viewing Projects
See all your projects on the dashboard home page. Project cards show the latest scan status and mismatch count with color-coded indicators.
Creating Projects
Click the "New Project" button, fill in project details, choose your schema type, and optionally add a database connection string.
Scan Reports
View detailed scan reports showing mismatches between your code and database schemas.
Status Types
- Completed: Scan finished successfully
- Pending: Scan in progress
- Failed: Scan encountered an error
Mismatch Severity
- Error: Critical differences that need fixing
- Warning: Important differences to review
- Info: Optional differences
Migration Management
Generate and apply migrations directly from the dashboard with safety checks.
Generating Migrations
- Go to scan report with mismatches
- Click "Generate Migration"
- Review the generated SQL
- Copy, download, or apply directly
Applying Migrations
- Click "Validate (Dry Run)" first
- Review validation result
- If valid, click "Apply Migration"
- Confirm the action
- Wait for execution to complete
- Check execution result