Every handoff starts from scratch
The plan sits in a doc, the mockup in a design tool that has never seen your
components, and the build in a terminal and a browser tab. Screenplay puts all
three on one canvas, next to your code.
Plan it, sketch it, build it
Type a prompt anywhere on the canvas and an agent makes it right there. It
reads your code first, so whatever it makes fits your app.
- Plan it. A plan or a spec, written as a document next to the work. It
stays current as things change.
- Sketch it. Mockups made with your own components, styles and copy.
Compare a few takes before anything gets built.
- Build it. The change runs live in a preview of its own, right beside the
other versions.
- Ship it. Open a pull request for the version you keep.
Chats share memory, files and skills, so what you tell one chat, every chat
knows.
Two ways to run it
| Desktop app | Hosted app (you deploy it) |
|---|
| For | One person on a Mac with Apple silicon | A team, on infrastructure you deploy |
| Chats run in | Git worktrees on your machine | A sandbox VM per chat |
| Agent | Antigravity, Claude Code, Codex or OpenCode, with the login and subscription you already have | The built-in agent, on Anthropic, OpenAI, Google, the Vercel AI Gateway or any OpenAI-compatible endpoint |
| Together | Single user | Shared canvases, live cursors, comments and live frames |
| Start | Quickstart | Self-hosting guide |
Both are the same product, built from this repository.
Run from source
You need Node.js 20 or newer, pnpm 9 and git. The local build runs the full
product with no external services (embedded Postgres, a local Yjs server, and
each chat’s code as a git worktree), plus a coding CLI such as Claude Code for the
agent.
git clone https://github.com/zschiller/screenplay.git
cd screenplay
pnpm install
cd apps/app
NEXT_PUBLIC_SCREENPLAY_PROFILE=desktop NEXT_PUBLIC_YJS_HOST=local NEXT_PUBLIC_BASE_PATH= \
SANDBOX_BACKEND=local SCREENPLAY_DB=pglite BLOB_STORE=local-fs AGENT_ENGINE=external \
ENCRYPTION_KEY=$(openssl rand -hex 32) TERMINAL_AUTH_SECRET=$(openssl rand -hex 32) \
pnpm dev
Then open http://localhost:3000. The
Development guide covers the
multi-user build, the desktop app, and every contributor command.
What’s in this repository
Contributing
Issues and pull requests are welcome. The docs site is the home for all
documentation, so please add and update pages in
apps/docs/content rather than growing this README. The
screenshots above come from the docs and refresh themselves whenever the app
changes.
License
MIT. See LICENSE.
