# DeepSpace

> Build real-time collaborative apps on Cloudflare Workers. DeepSpace SDK reference and developer documentation.

## Docs

- [Command reference](https://docs.deep.space/cli-reference/commands.md): Every `deepspace` CLI command, with flags and examples.
- [CLI overview](https://docs.deep.space/cli-reference/overview.md): The `deepspace` command - scaffold, develop, test, and deploy.
- [Architecture](https://docs.deep.space/concepts/architecture.md): How DeepSpace apps are structured, deployed, and connected to the platform.
- [Data model](https://docs.deep.space/concepts/data-model.md): Collections, records, the envelope shape, and how data flows from your worker to the client.
- [Deployment](https://docs.deep.space/concepts/deployment.md): How DeepSpace deploys your app to Cloudflare Workers for Platforms.
- [Permissions](https://docs.deep.space/concepts/permissions.md): Role-based access control on collections, evaluated server-side in your Durable Object.
- [Real-time sync](https://docs.deep.space/concepts/realtime-sync.md): How DeepSpace synchronizes data across clients using WebSockets and Durable Objects.
- [Installation](https://docs.deep.space/get-started/installation.md): Set up your environment, create an account, and log in to the CLI.
- [Introduction](https://docs.deep.space/get-started/introduction.md): What DeepSpace is, who it's for, and why you'd use it.
- [Project structure](https://docs.deep.space/get-started/project-structure.md): A tour of the files in a scaffolded DeepSpace app.
- [Quickstart](https://docs.deep.space/get-started/quickstart.md): Scaffold, run, and deploy a real-time app.
- [AI chat](https://docs.deep.space/guides/ai-chat.md): Streamed multi-turn chat with Claude, GPT, and Cerebras - tool use, persistent history, and context compaction included.
- [Authentication](https://docs.deep.space/guides/authentication.md): Public, gated, and mixed auth configurations for DeepSpace apps.
- [Canvas](https://docs.deep.space/guides/canvas.md): Real-time collaborative canvases with shapes, viewports, and undo/redo.
- [Collaborative editing](https://docs.deep.space/guides/collaborative-editing.md): Sync text and structured fields across clients with Yjs.
- [Custom bindings](https://docs.deep.space/guides/custom-bindings.md): Declare Vectorize, R2, KV, D1, Queues, and other Cloudflare resources for your app.
- [Custom domains](https://docs.deep.space/guides/custom-domains.md): Buy and attach a real domain to your DeepSpace app.
- [Data storage](https://docs.deep.space/guides/data-storage.md): Define a collection, query it from React, and mutate it with optimistic updates.
- [External APIs](https://docs.deep.space/guides/external-apis.md): Call third-party APIs through the platform's integration proxy.
- [File uploads](https://docs.deep.space/guides/file-uploads.md): Let users upload files (avatars, attachments, generated images) to R2.
- [Messaging](https://docs.deep.space/guides/messaging.md): Build a chat surface with channels, direct messages, reactions, and read receipts.
- [Payments](https://docs.deep.space/guides/payments.md): Charge users on a subscription or one-time basis with Stripe Checkout.
- [Presence and cursors](https://docs.deep.space/guides/presence-and-cursors.md): Show who's online and broadcast live cursor, typing, and viewport state.
- [Scheduled jobs](https://docs.deep.space/guides/scheduled-jobs.md): Run cron tasks in a per-app Durable Object.
- [Server actions](https://docs.deep.space/guides/server-actions.md): Privileged worker-side functions that bypass user RBAC for orchestration and admin operations.
- [Testing](https://docs.deep.space/guides/testing.md): Playwright specs, the multi-user fixture, and how to test against real services.
- [DeepSpace SDK](https://docs.deep.space/index.md): Build real-time collaborative apps on Cloudflare Workers. Auth, storage, multiplayer, payments, and one-command deploys.
- [Client auth reference](https://docs.deep.space/sdk-reference/client/auth.md): Hooks, providers, and components for authentication in React.
- [Files reference](https://docs.deep.space/sdk-reference/client/files.md): `useR2Files` and file display helpers.
- [Integrations reference](https://docs.deep.space/sdk-reference/client/integrations.md): The `integration` client and OAuth helpers.
- [Messaging reference](https://docs.deep.space/sdk-reference/client/messaging.md): Channels, messages, reactions, members, and read receipts.
- [Payments reference](https://docs.deep.space/sdk-reference/client/payments.md): `useSubscription`, `useCheckout`, `<PricingTable />`, and the server helpers.
- [Real-time reference](https://docs.deep.space/sdk-reference/client/realtime.md): Presence, Yjs, canvas, game rooms, and cursor color helpers.
- [Records reference](https://docs.deep.space/sdk-reference/client/records.md): Providers, hooks, and the data layer for reading and writing records.
- [Theming reference](https://docs.deep.space/sdk-reference/client/theming.md): Theme providers, helpers, and the user color palette.
- [SDK reference](https://docs.deep.space/sdk-reference/overview.md): Every export from the deepspace package, with signatures and examples.
- [Testing reference](https://docs.deep.space/sdk-reference/testing.md): The Playwright fixture and account helpers from `deepspace/testing`.
- [AI reference](https://docs.deep.space/sdk-reference/worker/ai.md): Provider routing, context compaction, chat-history wrappers, and built-in tools.
- [Worker auth reference](https://docs.deep.space/sdk-reference/worker/auth.md): JWT verification, Better Auth integration, and HMAC primitives.
- [Bindings reference](https://docs.deep.space/sdk-reference/worker/bindings.md): Migration runner, per-tenant metering, and binding manifest exports.
- [Worker cron reference](https://docs.deep.space/sdk-reference/worker/cron.md): `CronRoom`, `CronTask`, and `buildCronContext`.
- [Proxy helpers reference](https://docs.deep.space/sdk-reference/worker/proxy-helpers.md): Helpers for fetching the auth, API, and platform workers.
- [Rooms reference](https://docs.deep.space/sdk-reference/worker/rooms.md): Durable Object base classes - RecordRoom, YjsRoom, CanvasRoom, PresenceRoom, CronRoom, GameRoom.
- [Schemas reference](https://docs.deep.space/sdk-reference/worker/schemas.md): `CollectionSchema`, RBAC types, and the pre-built drop-in collections.
- [Server actions reference](https://docs.deep.space/sdk-reference/worker/server-actions.md): `ActionHandler`, `ActionContext`, `ActionTools`, and `ActionResult`.