TrueDeck documentation
Published site: https://wutishummus.github.io/TrueDeck/
Built with VitePress. From the repo root:
bash
npm run docs:dev # local server (port 5174)
npm run docs:build # output → docs/.vitepress/dist
npm run docs:preview # preview production buildGitHub Pages deploys automatically via .github/workflows/docs.yml on pushes to docs/** (enable Settings → Pages → Source: GitHub Actions once).
TrueDeck 0.3.x - terminal-first multi-agent coding deck (Electron + React + xterm, Rust truedeck-backend).
TrueDeck runs coding agent CLIs (Grok, Codex, Cursor Agent, Claude, Gemini, and more) as live terminal tabs with VS Code-style pane groups, automatic memory inject, a task board, and a unified MCP hub.
| Audience | Start here |
|---|---|
| New users | Getting started |
| Daily use | User guide · Keyboard shortcuts |
| Contributors | Development · Architecture |
| Agents & tooling | Agents · MCP · Task board |
Table of contents
Start
| Page | Description |
|---|---|
| Getting started | Requirements, install, first launch, first agent, first project |
| User guide | Projects, tabs, panes, task board, settings, session restore, Studio vs TUI |
| Keyboard shortcuts | Complete shortcut reference |
Features
| Page | Description |
|---|---|
| Agents | Supported CLIs, Cursor IDE block, command resolve, spawn path |
| Task board | Kanban tasks, dispatch, task files, env vars, focus file |
| Agent frame | In-terminal TrueDeck chrome (truedeck-frame.mjs) |
| Configuration | Settings, env vars, data dirs, project config |
| MCP | Unified MCP hub and TrueDeck hub tools |
| Memory providers | TrueMemory, MemPalace, OpenMemory, custom backends |
| BridgeSpace parity | Gap matrix vs BridgeSpace; Graphify + orchestration roadmap |
Internals
| Page | Description |
|---|---|
| Architecture | Electron main/preload/renderer, PTY backends, layout, MCP, memory |
| Fast PTY | truedeck-pty Rust sidecar and node-pty fallback |
| Rust backend | Full native backend (truedeck-backend) protocol and build |
| Development | Clone, npm scripts, electron-vite, packaging |
| Troubleshooting | Common issues and fixes |
| Glossary | Terms used in the app and docs |
Version
Documentation targets TrueDeck 0.3.x. Features described here match the Studio UI (npm start) unless noted otherwise for the TUI (npm run tui).
Repo map (quick)
TrueDeck/
src/ # Studio UI (React + xterm + pane groups)
electron/main/ # PTY, tasks, MCP hub, memory, session restore
electron/preload/ # IPC bridge
electron/shared/ # Shared TypeScript types
resources/agent-frame/ # truedeck-frame.mjs
resources/mcp-server/ # truedeck-mcp.mjs
crates/ # Rust backend / PTY
tui/ # Terminal-only deck
docs/ # This documentationLicense
MIT - see the root LICENSE.