jasondavies / plane Goto Github PK

Note: This branch represents a recent rewrite of Plane. Feel free to poke around, but we recommend talking to us before using it in production. See the 0.3.x branch for the previous version.

Plane is a distributed system for running stateful WebSocket backends at scale. Plane is heavily inspired by Figma’s mulitplayer infrastructure, which dynamically spawns a process for each active document.

Use cases include:

• Scaling up authoritative multiplayer backends.
• Running isolated code environments (like REPLs, code notebooks, and LLM agent sandboxes).
• Data-intensive applications that need a dedicated high-RAM process for each active user session.

You can think of Plane as a distributed hashmap, but instead of storing data, it stores running processes. When you ask Plane for the process associated with a key (via an HTTP API), it either returns a URL to an existing process, or starts a new process and returns a URL to that.

Plane will keep the process running for as long as there is an open connection (usually a WebSocket connection) to it. Once all connections to a process have been closed for some time threshold, Plane will shut down the process.

Plane guarantees that only one process will be running for each key at any given time, allowing that process to act as an authoritative source of document state for as long as it is running.

Read more about Plane’s architecture.

• Read the quickstart guide
• Learn about Plane concepts
• See instructions for building and developing Plane locally
• Read about production deployment