Skip to content

Commit 0161865

Browse files
BunsDevBunsDev
committed
docs: rewrite README with comparison chart — Knot Code vs Cursor/Windsurf/VS Code
1 parent 804a2df commit 0161865

1 file changed

Lines changed: 72 additions & 39 deletions

File tree

‎README.md‎

Lines changed: 72 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# KnotCode
1+
# Knot Code
22

3-
A browser-based and desktop code editor powered by an AI coding agent via the [OpenClaw](https://github.com/openclaw/openclaw) gateway. Think Cursor, but with your own gateway-integrated agent.
3+
**AI coding, without the bloat.**
4+
5+
A lightweight, AI-native code editor powered by [OpenClaw](https://github.com/openclaw/openclaw). Your agent, your gateway, your data. Browser + Desktop (Tauri).
46

57
```
68
┌──────────────┬──────────────────────────┬─────────────────┐
@@ -13,58 +15,87 @@ A browser-based and desktop code editor powered by an AI coding agent via the [O
1315
└───────────────────────────────────────────────────────────┘
1416
```
1517

18+
## How It Compares
19+
20+
| | **Knot Code** | **Cursor** | **Windsurf** | **VS Code + Copilot** |
21+
| ------------------------ | :-----------------------: | :-------------------: | :-------------: | :-------------------: |
22+
| **App Size** | **8.4 MB** | ~500 MB | ~450 MB | ~400 MB + extensions |
23+
| **RAM (idle)** | **~80 MB** | 500 MB–2 GB | 400 MB–1.5 GB | 300 MB–1 GB |
24+
| **RAM (AI active)** | **~120 MB** | 1–10+ GB | 1–4 GB | 500 MB–2 GB |
25+
| **Startup** | **<1s** | 3–8s | 3–6s | 2–5s |
26+
| **Electron?** | ❌ Tauri (native WebKit) | ✅ Electron | ✅ Electron | ✅ Electron |
27+
| **AI Backend** | Your own gateway | Cursor cloud | Windsurf cloud | GitHub cloud |
28+
| **Data Privacy** | **100% local** | Sent to Cursor | Sent to Codeium | Sent to GitHub |
29+
| **BYO Model** | ✅ Any model via OpenClaw | ❌ Cursor models only | ❌ Limited | ❌ Copilot only |
30+
| **Custom System Prompt** | ✅ Agent Builder wizard | ❌ | ❌ | ❌ |
31+
| **Themes** | 7 built-in | 3 | VS Code themes | VS Code themes |
32+
| **Offline AI** | ✅ Local models supported | ❌ | ❌ | ❌ |
33+
| **Subscription** | **Free forever** | $20/mo | $15/mo | $10/mo |
34+
| **Open Source** | ✅ Apache 2.0 | ❌ Proprietary | ❌ Proprietary | Partially |
35+
36+
> **Why so light?** Knot Code uses Tauri (Rust + native WebKit) instead of Electron. No bundled Chromium. No background processes phoning home. The AI runs through your own [OpenClaw](https://github.com/openclaw/openclaw) gateway — your keys, your models, your data stays on your machine.
37+
1638
## Quick Start
1739

18-
### Web (Vercel)
40+
### Desktop (macOS)
1941

20-
Live at [editor.openknot.ai](https://editor.openknot.ai)
42+
Download the [latest release](https://github.com/OpenKnots/code-editor/releases/latest) (.dmg), or build from source:
2143

2244
```bash
2345
pnpm install
24-
pnpm dev # http://localhost:3080
25-
pnpm build # production build (Vercel)
46+
pnpm run:desktop # dev mode (Tauri + hot reload)
47+
pnpm run:desktop --build # production build (.app + .dmg)
2648
```
2749

28-
Or use the unified run script:
50+
> First Tauri build takes 2-5 minutes (compiling Rust deps). Subsequent builds are fast.
2951
30-
```bash
31-
pnpm run:web # dev server
32-
pnpm run:web --build # production build + start
33-
```
34-
35-
### Desktop (macOS)
52+
### Web (self-hosted)
3653

3754
```bash
3855
pnpm install
39-
pnpm run:desktop # dev mode (Tauri + hot reload)
40-
pnpm run:desktop --build # production build (.app + .dmg)
56+
pnpm dev # http://localhost:3080
57+
pnpm build # static export
4158
```
4259

43-
> First Tauri build takes 2-5 minutes (compiling Rust deps). Subsequent builds are fast.
60+
### Prerequisites
61+
62+
- [OpenClaw](https://github.com/openclaw/openclaw) gateway running locally
63+
- Node.js 20+
64+
- pnpm
4465

4566
### Environment
4667

47-
Copy `.env.example` to `.env.local` and fill in the required values. See the file for detailed descriptions of each variable (WorkOS keys, GitHub tokens, IP allowlist, sponsor gate, etc.).
68+
Copy `.env.example` to `.env` and configure. All variables are optional — the editor works without them, but GitHub auth and plugins need their respective keys.
4869

4970
## Features
5071

51-
See [docs/FEATURES.md](docs/FEATURES.md) for the full feature list with current status and roadmap.
72+
- **AI Agent Chat** — Ask, Agent, and Plan modes with streaming responses
73+
- **Agent Builder** — Choose a persona, customize your system prompt, configure behaviors
74+
- **Inline Edits** — Agent proposes changes, you review diffs and accept/reject per-hunk
75+
- **7 Themes** — Obsidian, Bone, Neon, Catppuccin, VooDoo, CyberNord, PrettyPink
76+
- **Monaco Editor** — Multi-tab, Vim mode, syntax highlighting, ⌘P quick open
77+
- **GitHub Integration** — Device flow auth, commit, push, branch switching
78+
- **Terminal** — Integrated xterm.js with gateway slash commands
79+
- **Spotify + YouTube** — Built-in music and video plugins
80+
- **Desktop Native** — Tauri v2 with local file system access, git operations, OS keychain
81+
82+
See [docs/FEATURES.md](docs/FEATURES.md) for the full feature list and roadmap.
5283

5384
## Architecture
5485

5586
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the technical architecture, data flow, and component map.
5687

5788
## Documentation
5889

59-
| Doc | Description |
60-
| --------------------------------------------- | ------------------------------------------------------------- |
61-
| [FEATURES.md](docs/FEATURES.md) | Feature list, status, and roadmap |
62-
| [ARCHITECTURE.md](docs/ARCHITECTURE.md) | Technical architecture and component map |
63-
| [DEVELOPMENT.md](docs/DEVELOPMENT.md) | Development workflow and conventions |
64-
| [DESKTOP.md](docs/DESKTOP.md) | Tauri desktop build details |
65-
| [AGENT.md](docs/AGENT.md) | AI agent integration |
66-
| [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) | Common issues and fixes |
67-
| [SECURITY.md](docs/SECURITY.md) | Secret handling, incident response, and author privacy policy |
90+
| Doc | Description |
91+
| --------------------------------------------- | ------------------------------------------- |
92+
| [FEATURES.md](docs/FEATURES.md) | Feature list, status, and roadmap |
93+
| [ARCHITECTURE.md](docs/ARCHITECTURE.md) | Technical architecture and component map |
94+
| [DEVELOPMENT.md](docs/DEVELOPMENT.md) | Development workflow and conventions |
95+
| [DESKTOP.md](docs/DESKTOP.md) | Tauri desktop build details |
96+
| [AGENT.md](docs/AGENT.md) | AI agent integration |
97+
| [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) | Common issues and fixes |
98+
| [SECURITY.md](SECURITY.md) | Security policy and vulnerability reporting |
6899

69100
## Keyboard Shortcuts
70101

@@ -73,23 +104,25 @@ See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the technical architecture,
73104
| `⌘P` | Quick file open (fuzzy search) |
74105
| `⌘K` | Inline edit at selection |
75106
| `⌘B` | Toggle file explorer |
76-
| `⌘J` | Toggle agent panel |
77-
| `?` | Keyboard shortcuts overlay |
78-
| `Enter` | Send message (in agent panel) |
107+
| `⌘I` | Toggle agent panel |
108+
| `⌘J` | Toggle terminal |
109+
| `Enter` | Send message / Start chat |
79110
| `Esc` | Close overlays |
80111

81112
## Tech Stack
82113

83114
- **Framework:** Next.js 16 + React 19 + TypeScript 5.9
84-
- **Styling:** Tailwind CSS v4 (CSS variables, no `@apply`)
85-
- **Editor:** Monaco Editor (`@monaco-editor/react`) with optional vim mode (`monaco-vim`)
86-
- **Terminal:** xterm.js (`@xterm/xterm`) with fit addon and web links
87-
- **Icons:** `@iconify/react` with Lucide icon set
88-
- **Auth:** WorkOS AuthKit (`@workos-inc/authkit-nextjs`)
89-
- **Proxy:** Next.js 16 proxy (`proxy.ts`) for IP allowlist, CORS, security headers, and session management
90-
- **Desktop:** Tauri v2 (Rust + system WebKit)
91-
- **Package Manager:** pnpm (always pnpm, never npm/yarn/bun)
115+
- **Desktop:** Tauri v2 (Rust + system WebKit) — no Electron
116+
- **Editor:** Monaco Editor with optional Vim mode
117+
- **Terminal:** xterm.js with fit addon and web links
118+
- **Styling:** Tailwind CSS v4 (CSS custom properties)
119+
- **Icons:** @iconify/react (Lucide icon set)
120+
- **Package Manager:** pnpm
121+
122+
## Contributing
123+
124+
See [CONTRIBUTING.md](CONTRIBUTING.md). PRs welcome.
92125

93126
## License
94127

95-
Private — OpenKnot organization.
128+
[Apache License 2.0](LICENSE) — Copyright 2025-2026 OpenKnots Contributors

0 commit comments

Comments
 (0)