Skip to main content

​
Quick Start

Get OpenSync running in 5 minutes with one-click deploy.

​
Deploy Backend

1

Deploy to Convex

Click the button below to deploy the Convex backend: Deploy to Convex This creates a new Convex project with all the required tables and functions.
2

Deploy Frontend

Deploy the frontend to Netlify or Vercel: Deploy to Netlify Or use Vercel: Deploy with Vercel
3

Configure Environment

Set the required environment variables in your hosting platform: - VITE_CONVEX_URL - Your Convex deployment URL - WORKOS_API_KEY - Your WorkOS API key - WORKOS_CLIENT_ID - Your WorkOS client ID - WORKOS_COOKIE_PASSWORD - A secure 32+ character secret

​
Get API Key

Once deployed, get your API key to connect plugins:
1

Sign in

Visit your deployed OpenSync instance and sign in
2

Open Settings

Click your profile icon and select Settings
3

Generate Key

Click Generate API Key and copy the key
Your API key provides full access to your sessions. Never share it publicly or commit it to version control.

​
Install Plugin

Install a sync plugin globally on your machine: Then login with your credentials: 
opencode-sync login
# Enter your Convex URL and API key when prompted

​
Verify Setup

Check that everything is working: 
opencode-sync status
You should see: 
Connected: true
Convex URL: https://your-deployment.convex.cloud
Sessions synced: 0
Start coding with OpenCode, Claude Code, Codex, or Cursor and your sessions will sync automatically.