Getting Started

Quick Start Guide

Get your first collaborative application running in under 5 minutes.

1. Install the SDK

Terminal

npm install @cosync/studio

2. Create Your First Component

App.tsx

import { CollaborativeText }
from @cosync/studio; export default function Document() { return ( <CollaborativeText roomId="doc-123" userId="user-456" userName="Alice" /> ); }

3. What's Happening?

Real-time Sync

Changes are instantly broadcast to all connected users via WebSocket.

CRDT Engine

Conflict-free replication ensures all users see the same document state.

Presence Detection

See other users' cursors and selections in real-time.

Offline Support

Changes persist locally and sync when connection restores.

Next Steps