🪧 ClayTablet

A real-time clipboard, drop-box and notepad shared across all your devices.

Copy text on your laptop → it's already on your phone. Drop a file in the browser → grab it from the terminal. No accounts, no cloud sign-up, no vendor lock-in.

🌐 claytablet.online · Docs · Releases · Русский Readme

---

✨ Why ClayTablet?

You know the moment — you copy a long token on your laptop, then have to type it character-by-character on your phone. Or you snap a screenshot on the phone and need it on the PC right now. ClayTablet is one URL that fixes that for every device you own.

• 🚀 Real-time — WebSocket, sub-100ms sync
• 🔐 Self-hostable — one docker compose up and you own your data
• 📱 Everywhere — Web, Desktop (Tauri), Mobile (Expo), CLI, share-target on Android/iOS
• 🔌 Pluggable — drop a Python file into plugins/ to add hooks, cron jobs, custom endpoints
• 🆓 Free forever — MIT, no SaaS upsell, no telemetry by default

---

🎬 In 30 seconds

# Self-host
curl -fsSL https://raw.githubusercontent.com/claytablet/claytablet/main/install.sh | bash
# Opens at http://<your-lan-ip>:8080 — scan the QR with your phone, done.

Or just use the public instance: claytablet.online → type any room name → paste from any device.

---

📸 Screenshots

Web app with text, images, voice notes, chat	Mobile board (responsive)

---

🛠 Features

Content types

• Text — paste with Ctrl+V, type, multi-line, automatic URL detection + YouTube embeds
• Images — Ctrl+V, drag & drop, batch upload, click to preview/copy back
• Voice notes — record in-browser (cross-browser MediaRecorder)
• Files — any type, up to 50 MB, streaming upload
• Drawings — built-in canvas with touch support
• Chat — per-room with nicknames

Sharing & access

• Rooms by URL — claytablet.online/my-room, public boards in the lobby
• Password protection — bcrypt, rate-limited brute-force defence
• Read-only mode — owner writes, guests view
• Personal rooms — tied to OAuth account (Google / Yandex), never auto-expire
• QR codes — share a room with one phone scan
• Custom TTL — 10 min / 1 hour / 24 h / 7 days / forever

Apps

• Web — React 19 + Tailwind v4, dark mode, RU/EN
• Desktop (releases) — Tauri 2 (Windows/Linux/macOS), global hotkeys Ctrl+Shift+V / Ctrl+Shift+C, system tray, auto-updater
• Mobile — React Native + Expo (Android/iOS) — separate repo
• CLI — claytablet Go binary: ls, send, copy, watch, tui (interactive terminal board)
• PWA Share Target — Add to Home Screen on phone → ClayTablet appears in the system Share menu like Google Drive

Hosting & ops

• Docker Compose — one-line deploy with auto-HTTPS via Caddy + Let's Encrypt
• LAN mode — works without internet, prints QR with LAN URL on boot
• Plugin engine — drop plugins/my-plugin/plugin.py with @hook, @scheduled, @http.get decorators
• Custom server — point any web/desktop/mobile client at your self-hosted instance

---

🚀 Quick Start

Option 1 — Public instance (zero setup)

Open claytablet.online, pick a room name, paste from any device.

Option 2 — Self-host with one command

curl -fsSL https://raw.githubusercontent.com/claytablet/claytablet/main/install.sh | bash

Generates a JWT secret, detects your LAN IP, prints a QR code. Edit ~/.claytablet/.env to customise.

Option 3 — Docker Compose

git clone https://github.com/claytablet/claytablet
cd claytablet
cp .env.example .env       # set JWT_SECRET, HOST_URL, ALLOWED_ORIGINS
docker compose up -d --build

Option 4 — Use the public instance from CLI

curl -fsSL https://claytablet.online/claytablet-linux-amd64 -o claytablet && chmod +x claytablet
./claytablet login                    # OAuth in browser
./claytablet send "hello from terminal"
cat error.log | ./claytablet send     # pipe a logfile
./claytablet tui                      # interactive terminal board

---

🔌 Plugins

Drop a folder into plugins/, restart the server, done. No isolation — for self-hosted users who trust their own code.

# plugins/my-plugin/plugin.py
from claytablet_sdk import hook, scheduled, http, api

@hook("on_text_added")
async def on_text(room_id: str, content: str, item_id: str):
    if "TODO" in content:
        await api.add_chat(room_id, "bot", "Don't forget!")

@scheduled("0 9 * * *")             # every day at 9 AM
async def morning_briefing():
    await api.add_text("daily", "☀️ Good morning")

@http.get("/status")
async def status(request):
    return {"ok": True}              # exposed at /api/plugins/my-plugin/status

Full guide: plugins/PLUGIN_API.md

---

🏗 Tech Stack

Layer	Tech
Backend	Python 3.11 · FastAPI · SQLAlchemy + Alembic · SQLite · WebSocket · APScheduler
Frontend	React 19 · Vite · Tailwind v4 · Zustand · TypeScript
Desktop	Tauri 2 (Rust) · Windows / Linux / macOS
Mobile	React Native · Expo SDK 54
CLI	Go 1.22 · Cobra · bubbletea + lipgloss (TUI)
Proxy	Caddy (automatic Let's Encrypt)
Runtime	Docker · Docker Compose
CI	GitHub Actions (backend ruff + pytest, frontend eslint + build, desktop matrix build)

---

🧑‍💻 Development

# Backend
cd backend
pip install -r requirements.txt
uvicorn main:app --reload          # :8000
pytest tests/ -v                   # 27 API tests

# Frontend
cd frontend
npm install
npm run dev                        # :5173 (proxies /api → :8000)
npm run build && npm run lint

# CLI
cd cli && go build ./...           # builds claytablet

# Desktop
cd desktop && npm install && npm run tauri dev

---

⚙️ Environment

Variable	Required	Notes
JWT_SECRET	✅	Use a long random string in prod
HOST_URL	✅	Public URL (e.g. https://claytablet.online)
ALLOWED_ORIGINS	✅	CORS origins, comma-separated
GOOGLE_CLIENT_ID / SECRET	—	Google OAuth
YANDEX_CLIENT_ID / SECRET	—	Yandex OAuth
SENTRY_DSN	—	Backend error tracking
VITE_SENTRY_DSN	—	Frontend error tracking (Vite inlines at build time)
PLUGIN_ADMINS	—	Comma-separated user IDs allowed to edit plugin config
DATA_DIR	—	Storage path (default /app/data)

Full sample: .env.example

---

🤝 Contributing & Open-Source Collaboration

We are actively looking for contributors, co-maintainers, and beta-testers! ClayTablet is a fully open-source project and we would be thrilled to collaborate with you.

Specifically, we need help with testing, polishing, and building native packages for:

• macOS & Windows (Tauri v2 client in desktop/)
• Android & iOS (React Native + Expo client in mobile/)
• Linux, macOS, Windows CLI (Go-based client in cli/)
• Localization (adding new languages to the web, mobile, and desktop apps)

If you'd like to help test the apps on your devices, report bugs, suggest features, or submit pull requests, please join in!

Before submitting a PR:

cd backend && pytest tests/ -v && ruff check .
cd frontend && npm run lint && npm run build

See CONTRIBUTING.md for the full guide. We appreciate any help and are always open to collaboration!

---

📜 License

MIT — do whatever you want, just don't blame me if you break it. See LICENSE.

If ClayTablet saved you time, give the repo a ⭐ — it really helps with discovery.