Skip to content

Commit a688523

Browse files
hlsitechioclaude
andcommitted
docs: rewrite README with comprehensive feature documentation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d9e3103 commit a688523

1 file changed

Lines changed: 89 additions & 3 deletions

File tree

README.md

Lines changed: 89 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# T3 Code
22

3-
T3 Code is a minimal web GUI for coding agents. Currently Codex-first, with Claude Code support coming soon.
3+
T3 Code is a modern web GUI for coding agents. Currently Codex-first, with Claude Code support coming soon.
44

55
## How to use
66

@@ -11,13 +11,99 @@ T3 Code is a minimal web GUI for coding agents. Currently Codex-first, with Clau
1111
npx t3
1212
```
1313

14-
You can also just install the desktop app. It's cooler.
14+
You can also install the desktop app for the full experience.
1515

1616
Install the [desktop app from the Releases page](https://github.com/pingdotgg/t3code/releases)
1717

18+
## Features
19+
20+
### Integrated Terminal
21+
- GPU-accelerated rendering via WebGL (xterm.js + `@xterm/addon-webgl`)
22+
- Optimized I/O with debounced input/output buffering
23+
- Per-thread terminal sessions with persistent history
24+
- Fallback to DOM renderer when WebGL is unavailable
25+
26+
### Browser Integration (Desktop)
27+
- Built-in browser view powered by Chrome DevTools Protocol (CDP)
28+
- Navigate, observe, interact, and extract content from web pages
29+
- Element observation with attribute, label, and text extraction
30+
- Screenshot capture and action execution (click, type, scroll)
31+
- Side-by-side or stacked layout with the chat view
32+
33+
### Canvas (React Code Preview)
34+
- Live React component preview with Babel JSX transform
35+
- Thread-level canvas state with file management (`App.jsx`, `styles.css`, `canvas.md`)
36+
- Device preview modes: Desktop, Tablet, Mobile
37+
- Agent-driven streaming updates to canvas files
38+
39+
### Lab Workspace
40+
- Experimental workspace surfaces for new layouts and interactions
41+
- Browser + chat side-by-side (responsive stacking on smaller screens)
42+
- Thread-specific lab instances
43+
44+
### Document Upload
45+
- Attach documents to chat threads (`.txt`, `.md`, `.pdf`, `.docx`)
46+
- Up to 16 documents per thread, 8 MB per file
47+
- Automatic text extraction from PDFs and Word documents
48+
- Document context injected into agent prompts (32K char limit)
49+
50+
### Code Formatting
51+
- Automatic Prettier formatting for code blocks in chat
52+
- Supports JavaScript, TypeScript, HTML, CSS, Markdown, YAML, and more
53+
- 7 Prettier plugins with graceful fallback
54+
55+
### IDE Integrations
56+
- Open projects directly in your editor of choice:
57+
- **Cursor**`cursor`
58+
- **VS Code**`code`
59+
- **Windsurf**`windsurf`
60+
- **OpenCode**`opencode`
61+
- **Zed**`zed`
62+
- **File Manager** — system default
63+
64+
### GitHub Integration
65+
- OAuth Device Flow authentication (RFC 8628) — no PAT required
66+
- GitHub CLI (`gh`) token support
67+
- Personal Access Token manual entry
68+
- Configurable GitHub actions automation, PR auto-merge, and security workflows
69+
70+
### MCP Server Infrastructure
71+
- App Operator MCP server for project context, canvas mutations, and action execution
72+
- Lab Browser MCP server for browser observation, actions, and screenshot capture
73+
- Standard Model Context Protocol for agent tool integration
74+
75+
### Project Management
76+
- Multi-project sidebar with favorites and thread previews
77+
- Thread status tracking (Working, Completed, Pending Approval)
78+
- Project onboarding with branch, worktree, and environment mode options
79+
- Folder picker integration for adding new projects
80+
81+
### Settings
82+
- 8 configurable sections: Appearance, Codex, Canvas, Models, GitHub, Responses, Keybindings, Safety
83+
- Searchable settings with section navigation
84+
- Keyboard shortcuts editor
85+
- Model and reasoning effort selection
86+
- Service tier configuration (Auto/Fast/Flex)
87+
88+
### Provider Health
89+
- Startup-time Codex CLI health checks (version + auth probes)
90+
- Minimum version enforcement (>=0.37.0)
91+
- Status indicators: Ready, Limited, Attention
92+
93+
## Architecture
94+
95+
T3 Code is a monorepo built with:
96+
97+
- **Desktop** — Electron 40.6 with CDP browser integration
98+
- **Server** — Node.js with Effect-ts service composition
99+
- **Web** — React + Vite 8 + TanStack Router
100+
- **Contracts** — Shared schemas (Effect Schema) for type-safe RPC
101+
- **Shared** — Common utilities and models
102+
- **Package Manager** — Bun 1.3.9
103+
18104
## Some notes
19105

20-
We are very very early in this project. Expect bugs.
106+
We are very early in this project. Expect bugs.
21107

22108
We are not accepting contributions yet.
23109

0 commit comments

Comments
 (0)