Skip to content
View recombyn's full-sized avatar
🎯
Focusing
🎯
Focusing

Block or report recombyn

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
recombyn/README.md

recombyn — open-source canvas + AI Design Agent

Self Host · Cloud · Docs

Recombyn Source Available License Self-host TypeScript Python Security

English   简体中文   日本語

Recombyn is a canvas editor + AI Design Agent (source-available).
Design on an infinite canvas; a LangGraph agent edits layers, shapes, text, and layout through conversation.

Self-host in minutes with Docker Compose (default MySQL + Redis + web + API + Yjs collab). Local dev can use SQLite (empty DATABASE_URL), or PostgreSQL — see docs/postgres-switch.md.


Why Recombyn?

  • Real canvas editing — Frames, shapes, images, video, text; export and share
  • Live multiplayer — Yjs sync for the same project (cursors, selection, undo); share view-only or edit
  • Agent that paints — Conversation plans and applies canvas ops
  • Self-host first — Same stack locally or on a server
  • Composable — Infra seeds + prompt packs + 5 core Agent skills under apps/api/data/public/

Core features

  • Visual editor — selection, layers, fills, export, share
  • Realtime collab — Yjs WebSocket room (apps/collab); Live bar in the editor; WSS via nginx /collab/
  • Design Agent — LangGraph tools / skills; create, edit, and chat with streaming UI
  • Image import — local images → editable canvas nodes
  • Plaza & projects — inspiration feed and saved work (API)

Quick start (self-host)

git clone https://github.com/recombyn/recombine.git
cd recombine
cp apps/api/.env.example apps/api/.env   # add LLM_API_KEY / provider keys
docker compose up -d --build
Service URL
Web http://localhost:3000
API docs http://localhost:8000/docs
MySQL 127.0.0.1:3306 · recombyn / recombyn

More options (env, LLM keys, production hardening): docs/self-hosting.md · Postgres: docs/postgres-switch.md

Local development

docker compose up -d redis   # or: mysql redis
npm install
cp apps/api/.env.example apps/api/.env
npm run dev:api              # empty DATABASE_URL → SQLite
npm run dev:collab           # Yjs WS on :1234 (optional; Vite DEV defaults collab on)
npm run dev:web

Canvas Live / WSS setup: docs/self-hosting.md § Canvas multiplayer · apps/collab/README.md

Repository layout

apps/web/          React canvas + Agent UI + Yjs client
apps/api/          FastAPI — Scene, Agent, plaza, wallet, collab tokens
apps/collab/       Yjs WebSocket server (y-websocket)
apps/docs/         Help / legal site
packages/          Shared builders & schemas
docs/              Architecture + self-hosting
deploy/            Dockerfiles / Nginx
e2e/               Playwright

Documentation

Doc Link
Self-hosting docs/self-hosting.md
PostgreSQL switch docs/postgres-switch.md
Contributing CONTRIBUTING.md
Security SECURITY.md
Code of Conduct CODE_OF_CONDUCT.md
Architecture docs/architecture.md
Maintainer OSS checklist docs/open-source-checklist.md

Community

  • Issues — bug & feature templates under .github/ISSUE_TEMPLATE/
  • PRs — see CONTRIBUTING.md
  • Security — report privately per SECURITY.md

License & model

Recombyn Source Available License v1.0 © Recombyn contributors · NOTICE

Source-available terms (not OSI open source):

  • Personal / private self-host — free
  • Internal org use — permitted
  • Hosted / managed service of Recombyn to third parties (paid or free) — requires commercial authorization ([email protected])

See LICENSE for the full text.

Star us on GitHub ⭐

Open source takes time. If Recombyn helps your work, please hit ⭐ Star in the top-right of the GitHub repo — your support is the best fuel for making it better.

https://github.com/recombyn/recombyn

Popular repositories Loading

  1. recombyn recombyn Public

    Source-available visual design editor + AI Design Agent. Self-host with Docker Compose.

    TypeScript 9 2

  2. recombyn-cad recombyn-cad Public

    Web CAD toolkit (MIT) — React CadWorkbench/CadCanvas with AI CadCommand protocol

    TypeScript 1