clew-code 0.2.21 → 0.2.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -45
- package/dist/main.js +2906 -2722
- package/docs/architecture.html +91 -148
- package/docs/assets/clew-agent-loop.png +0 -0
- package/docs/assets/clew-general-architecture.png +0 -0
- package/docs/assets/clew-mcp-architecture.png +0 -0
- package/docs/assets/clew-p2p-swarm.png +0 -0
- package/docs/changelog.html +150 -0
- package/docs/cli-reference.html +90 -0
- package/docs/commands.html +133 -241
- package/docs/configuration.html +85 -147
- package/docs/contributing.html +91 -0
- package/docs/css/styles.css +272 -152
- package/docs/daemon.html +62 -129
- package/docs/features/bridge-mode.html +61 -66
- package/docs/features/evals.html +57 -149
- package/docs/features/searxng-search.html +58 -118
- package/docs/features/sentry-setup.html +61 -124
- package/docs/index.html +185 -148
- package/docs/installation.html +77 -105
- package/docs/internals/growthbook-ab-testing.html +69 -91
- package/docs/internals/hidden-features.html +81 -143
- package/docs/js/main.js +29 -0
- package/docs/loop.html +69 -181
- package/docs/mcp.html +99 -247
- package/docs/models.html +63 -92
- package/docs/permission-model.html +86 -102
- package/docs/plugins.html +84 -102
- package/docs/providers.html +87 -127
- package/docs/quick-start.html +81 -93
- package/docs/research-memory.html +71 -102
- package/docs/security.html +71 -0
- package/docs/skills.html +67 -117
- package/docs/swarm.html +78 -236
- package/docs/tools.html +183 -171
- package/docs/troubleshooting.html +86 -106
- package/docs/voice-mode.html +79 -0
- package/package.json +1 -1
- package/docs/architecture.th.html +0 -79
- package/docs/clew-code-architecture.html +0 -1126
- package/docs/commands.th.html +0 -269
- package/docs/configuration.th.html +0 -108
- package/docs/daemon.th.html +0 -73
- package/docs/features/bridge-mode.th.html +0 -62
- package/docs/features/evals.th.html +0 -62
- package/docs/features/searxng-search.th.html +0 -67
- package/docs/features/sentry-setup.th.html +0 -69
- package/docs/features/swarm.html +0 -156
- package/docs/generated/providers.html +0 -625
- package/docs/generated/tools.html +0 -558
- package/docs/index.th.html +0 -292
- package/docs/installation.th.html +0 -105
- package/docs/internals/growthbook-ab-testing.th.html +0 -60
- package/docs/internals/hidden-features.th.html +0 -107
- package/docs/loop.th.html +0 -227
- package/docs/mcp.th.html +0 -207
- package/docs/models.th.html +0 -61
- package/docs/permission-model.th.html +0 -67
- package/docs/plugins.th.html +0 -79
- package/docs/prompts-and-features.html +0 -806
- package/docs/providers.th.html +0 -81
- package/docs/quick-start.th.html +0 -89
- package/docs/research-memory.th.html +0 -72
- package/docs/skills.th.html +0 -90
- package/docs/swarm.th.html +0 -280
- package/docs/tools.th.html +0 -84
- package/docs/troubleshooting.th.html +0 -85
package/docs/index.html
CHANGED
|
@@ -1,148 +1,185 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>Clew — AI Coding
|
|
7
|
-
<meta name="description" content="
|
|
8
|
-
<link rel="
|
|
9
|
-
<link rel="preconnect" href="https://fonts.
|
|
10
|
-
<link href="https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet">
|
|
11
|
-
<link rel="stylesheet" href="css/styles.css">
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
<
|
|
15
|
-
|
|
16
|
-
<
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
<
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
<
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
</
|
|
67
|
-
<
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
<
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
<
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
</
|
|
92
|
-
<
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
<
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
</
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
<
|
|
115
|
-
|
|
116
|
-
<
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
</
|
|
124
|
-
<
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
</
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
</
|
|
147
|
-
|
|
148
|
-
</
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Clew Code — Multi-Provider AI Coding Agent</title>
|
|
7
|
+
<meta name="description" content="The open-source AI coding agent with 27 providers, LAN mesh coordination, autonomous agent loop, MCP integration, and 50+ built-in tools.">
|
|
8
|
+
<link rel="icon" type="image/svg+xml" href="assets/clew.svg">
|
|
9
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
10
|
+
<link href="https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600;700&display=swap" rel="stylesheet">
|
|
11
|
+
<link rel="stylesheet" href="css/styles.css">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header class="header"></header>
|
|
15
|
+
<div id="sidebarOverlay" class="sidebar-overlay"></div>
|
|
16
|
+
<aside id="sidebar" class="sidebar"></aside>
|
|
17
|
+
|
|
18
|
+
<div class="content-wrap">
|
|
19
|
+
<div class="content">
|
|
20
|
+
|
|
21
|
+
<section class="hero">
|
|
22
|
+
<div class="badge"><span class="dot"></span> v0.2.22 — Multi-Provider AI Coding Agent</div>
|
|
23
|
+
<h1>Code with <span class="hl">any</span> AI.</h1>
|
|
24
|
+
<p>Clew Code is an open-source AI coding agent that runs in your terminal,
|
|
25
|
+
coordinates across machines on your LAN, and works with 27 different
|
|
26
|
+
AI providers — no lock-in.</p>
|
|
27
|
+
<div class="hero-actions">
|
|
28
|
+
<a href="quick-start.html" class="btn btn-p">Get Started →</a>
|
|
29
|
+
<a href="installation.html" class="btn btn-ghost">Installation</a>
|
|
30
|
+
<a href="https://github.com/ClewCode/ClewCode" class="btn btn-ghost" target="_blank">GitHub</a>
|
|
31
|
+
</div>
|
|
32
|
+
</section>
|
|
33
|
+
|
|
34
|
+
<div class="term">
|
|
35
|
+
<div class="term-bar">
|
|
36
|
+
<span class="term-dot"></span><span class="term-dot"></span><span class="term-dot"></span>
|
|
37
|
+
<span class="term-title">clew</span>
|
|
38
|
+
</div>
|
|
39
|
+
<div class="term-body"><span class="p">❯</span> clew
|
|
40
|
+
<span class="d">│ Starting Clew Code v0.2.22 …</span>
|
|
41
|
+
<span class="d">│ Select a provider:</span>
|
|
42
|
+
<span class="h">│ ● Anthropic</span>
|
|
43
|
+
<span class="h">│ ● OpenAI</span>
|
|
44
|
+
○ Google Gemini
|
|
45
|
+
○ DeepSeek
|
|
46
|
+
○ Ollama (local)
|
|
47
|
+
…
|
|
48
|
+
<span class="p">❯</span> /model deepseek-v4-flash
|
|
49
|
+
|
|
50
|
+
<span class="p">❯</span> /mesh discover
|
|
51
|
+
<span class="d">│ Found 2 peers on LAN</span>
|
|
52
|
+
|
|
53
|
+
<span class="p">❯</span> write a web scraper in Go<span class="term-cursor"></span></div>
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
<div class="stats">
|
|
57
|
+
<div class="stat"><div class="stat-num">27</div><div class="stat-lbl">Providers</div></div>
|
|
58
|
+
<div class="stat"><div class="stat-num">50+</div><div class="stat-lbl">Built-in Tools</div></div>
|
|
59
|
+
<div class="stat"><div class="stat-num">15</div><div class="stat-lbl">Mesh Tools</div></div>
|
|
60
|
+
<div class="stat"><div class="stat-num">7</div><div class="stat-lbl">Permission Modes</div></div>
|
|
61
|
+
</div>
|
|
62
|
+
|
|
63
|
+
<h2 id="features">Features</h2>
|
|
64
|
+
<div class="grid">
|
|
65
|
+
<div class="card">
|
|
66
|
+
<h3><span class="card-icon">🤖</span>27 Providers</h3>
|
|
67
|
+
<p>Anthropic, OpenAI, Google Gemini, DeepSeek, Groq, Mistral, Ollama, OpenRouter, and 19 more. Switch mid-session with <code>/model</code>.</p>
|
|
68
|
+
</div>
|
|
69
|
+
<div class="card">
|
|
70
|
+
<h3><span class="card-icon">🌐</span>LAN Mesh</h3>
|
|
71
|
+
<p>Discover peers, assign tasks, execute remote commands, and coordinate across machines via UDP multicast or file registry.</p>
|
|
72
|
+
<span class="tag">15 tools</span>
|
|
73
|
+
</div>
|
|
74
|
+
<div class="card">
|
|
75
|
+
<h3><span class="card-icon">🔄</span>Autonomous Loop</h3>
|
|
76
|
+
<p>Persistent task queue, lease-based concurrency, exponential-backoff retry, dead-letter management, and cron scheduling.</p>
|
|
77
|
+
</div>
|
|
78
|
+
<div class="card">
|
|
79
|
+
<h3><span class="card-icon">🔌</span>MCP Integration</h3>
|
|
80
|
+
<p>Model Context Protocol via stdio, SSE with OAuth, or DirectConnect for in-process plugin servers.</p>
|
|
81
|
+
</div>
|
|
82
|
+
<div class="card">
|
|
83
|
+
<h3><span class="card-icon">🛠️</span>50+ Built-in Tools</h3>
|
|
84
|
+
<p>Read, Write, Edit, Bash, WebSearch, WebFetch, Browser (Playwright), PR, NotebookEdit, JsonPath, and more.</p>
|
|
85
|
+
</div>
|
|
86
|
+
<div class="card">
|
|
87
|
+
<h3><span class="card-icon">⚡</span>3 Execution Layers</h3>
|
|
88
|
+
<p>Subagents (one-shot), Swarm/Teammates (long-running), Process Mesh (Codex via exec/pty).</p>
|
|
89
|
+
</div>
|
|
90
|
+
<div class="card">
|
|
91
|
+
<h3><span class="card-icon">🧩</span>Skills & Plugins</h3>
|
|
92
|
+
<p>Extend via SKILL.md, plugin manifests with lifecycle hooks at every stage (PreToolUse, PostBash, and more).</p>
|
|
93
|
+
</div>
|
|
94
|
+
<div class="card">
|
|
95
|
+
<h3><span class="card-icon">🔒</span>7 Permission Modes</h3>
|
|
96
|
+
<p>Default, ask, plan, auto, acceptEdits, bypassPermissions, dontAsk — with granular allow/deny rule patterns.</p>
|
|
97
|
+
</div>
|
|
98
|
+
<div class="card">
|
|
99
|
+
<h3><span class="card-icon">📋</span>Plan Mode</h3>
|
|
100
|
+
<p>Full-access planning with bypass permissions. Explore, read, write, and edit freely. Plans persist with progress snapshots.</p>
|
|
101
|
+
</div>
|
|
102
|
+
<div class="card">
|
|
103
|
+
<h3><span class="card-icon">🧠</span>Memory System</h3>
|
|
104
|
+
<p>Persistent auto-memory, topic indexing, session digests with weekly/monthly consolidation — like human memory decay.</p>
|
|
105
|
+
</div>
|
|
106
|
+
<div class="card">
|
|
107
|
+
<h3><span class="card-icon">🌐</span>Web UI & Remote</h3>
|
|
108
|
+
<p>Local WebSocket server with one-time auth tokens, optional NAT-traversal relay, and session management.</p>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="card">
|
|
111
|
+
<h3><span class="card-icon">🎨</span>Image & Video Generation</h3>
|
|
112
|
+
<p>AI-callable tools for DALL-E 3, Imagen 3, OpenRouter image models, and Runway Gen-4. Auto-discovers models from provider APIs.</p>
|
|
113
|
+
</div>
|
|
114
|
+
<div class="card">
|
|
115
|
+
<h3><span class="card-icon">📦</span>Multi-Pass Compaction</h3>
|
|
116
|
+
<p>Automatic chunk-based context compression with recursive re-compaction when context exceeds the model window.</p>
|
|
117
|
+
</div>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
<h2 id="quick-start">Quick Start</h2>
|
|
121
|
+
<div class="code-block-wrap">
|
|
122
|
+
<div class="code-block-header">
|
|
123
|
+
<span>bash</span>
|
|
124
|
+
<button class="copy-btn" onclick="navigator.clipboard.writeText(this.nextElementSibling.textContent);this.textContent='Copied';setTimeout(()=>this.textContent='Copy',1500)">Copy</button>
|
|
125
|
+
</div>
|
|
126
|
+
<pre><code class="language-bash">npm install -g clew-code
|
|
127
|
+
cd my-project
|
|
128
|
+
clew
|
|
129
|
+
|
|
130
|
+
# Inside the REPL:
|
|
131
|
+
# /model openai # pick a provider
|
|
132
|
+
# /help # list all commands
|
|
133
|
+
# /mesh discover # find peers on LAN</code></pre>
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
<h2 id="concepts">Core Concepts</h2>
|
|
137
|
+
<p>Clew Code has several execution layers, each serving a different purpose:</p>
|
|
138
|
+
<div class="grid">
|
|
139
|
+
<div class="card">
|
|
140
|
+
<h3><span class="card-icon">🎯</span>Agent</h3>
|
|
141
|
+
<p>An AI worker with a prompt, model, tools, and permissions. The main chat session is an agent. Custom agents live in <code>.clew/agents/*.md</code>.</p>
|
|
142
|
+
</div>
|
|
143
|
+
<div class="card">
|
|
144
|
+
<h3><span class="card-icon">🧪</span>Subagent</h3>
|
|
145
|
+
<p>A short-lived child agent for independent work like codebase exploration or test triage. The built-in <code>Explore</code> agent is read-only.</p>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="card">
|
|
148
|
+
<h3><span class="card-icon">🐝</span>Teammate / Swarm</h3>
|
|
149
|
+
<p>A longer-lived agent team member with identity, mailbox, task coordination, and optional pane/tmux execution.</p>
|
|
150
|
+
</div>
|
|
151
|
+
<div class="card">
|
|
152
|
+
<h3><span class="card-icon">🌐</span>LAN Mesh</h3>
|
|
153
|
+
<p>A network of Clew instances on the same machine or LAN. <code>/mesh</code> discovers peers, sends messages, and assigns tasks.</p>
|
|
154
|
+
</div>
|
|
155
|
+
<div class="card">
|
|
156
|
+
<h3><span class="card-icon">⚙️</span>Process Mesh</h3>
|
|
157
|
+
<p>Local process-backed worker. Delegates prompts to external CLIs like Codex using exec or pty modes.</p>
|
|
158
|
+
</div>
|
|
159
|
+
<div class="card">
|
|
160
|
+
<h3><span class="card-icon">📡</span>ACP</h3>
|
|
161
|
+
<p>Agent Client Protocol — an external boundary for editors, IDEs, REST clients, or other agents to send work into Clew.</p>
|
|
162
|
+
</div>
|
|
163
|
+
</div>
|
|
164
|
+
</div>
|
|
165
|
+
</div>
|
|
166
|
+
|
|
167
|
+
<button class="back-to-top" id="backToTop" onclick="window.scrollTo({top:0,behavior:'smooth'})">↑</button>
|
|
168
|
+
|
|
169
|
+
<script src="js/main.js"></script>
|
|
170
|
+
<script>
|
|
171
|
+
// Back to top button
|
|
172
|
+
(function(){
|
|
173
|
+
var btn = document.getElementById('backToTop');
|
|
174
|
+
if (!btn) return;
|
|
175
|
+
window.addEventListener('scroll', function(){
|
|
176
|
+
if (window.scrollY > 400) {
|
|
177
|
+
btn.classList.add('visible');
|
|
178
|
+
} else {
|
|
179
|
+
btn.classList.remove('visible');
|
|
180
|
+
}
|
|
181
|
+
});
|
|
182
|
+
})();
|
|
183
|
+
</script>
|
|
184
|
+
</body>
|
|
185
|
+
</html>
|
package/docs/installation.html
CHANGED
|
@@ -1,105 +1,77 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
<
|
|
15
|
-
<
|
|
16
|
-
<
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
<table>
|
|
79
|
-
<tr><th>Channel</th><th>npm Tag</th><th>Description</th></tr>
|
|
80
|
-
<tr><td>stable</td><td><code>latest</code></td><td>Tagged releases (vYYYY.M.D)</td></tr>
|
|
81
|
-
<tr><td>beta</td><td><code>beta</code></td><td>Prereleases (vYYYY.M.D-beta.N)</td></tr>
|
|
82
|
-
<tr><td>dev</td><td><code>dev</code></td><td>Moving main branch</td></tr>
|
|
83
|
-
</table>
|
|
84
|
-
|
|
85
|
-
<h2>Verifying Installation</h2>
|
|
86
|
-
<pre><code>/doctor # Run environment diagnostics
|
|
87
|
-
/status # Check version, model, account, API connectivity</code></pre>
|
|
88
|
-
|
|
89
|
-
<footer class="footer">
|
|
90
|
-
<span>Clew Code 0.2.14 — Open Source</span>
|
|
91
|
-
<div class="footer-links">
|
|
92
|
-
<a href="https://github.com/ClewCode/ClewCode">GitHub</a>
|
|
93
|
-
<a href="https://github.com/ClewCode/ClewCode/issues">Issues</a>
|
|
94
|
-
<a href="https://npmjs.com/package/clew-code">npm</a>
|
|
95
|
-
</div>
|
|
96
|
-
</footer>
|
|
97
|
-
</main>
|
|
98
|
-
<nav class="toc-sidebar"></nav>
|
|
99
|
-
</div>
|
|
100
|
-
</div>
|
|
101
|
-
<script src="js/main.js"></script>
|
|
102
|
-
</body>
|
|
103
|
-
</html>
|
|
104
|
-
|
|
105
|
-
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Installation — Clew Code</title>
|
|
7
|
+
<meta name="description" content="Install Clew Code via npm or build from source.">
|
|
8
|
+
<link rel="icon" type="image/svg+xml" href="assets/clew.svg">
|
|
9
|
+
<link rel="preconnect" href="https://fonts.googleapis.com">
|
|
10
|
+
<link href="https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600;700&display=swap" rel="stylesheet">
|
|
11
|
+
<link rel="stylesheet" href="css/styles.css">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header class="header"></header>
|
|
15
|
+
<div id="sidebarOverlay" class="sidebar-overlay"></div>
|
|
16
|
+
<aside id="sidebar" class="sidebar"></aside>
|
|
17
|
+
|
|
18
|
+
<div class="content-wrap">
|
|
19
|
+
<div class="content">
|
|
20
|
+
|
|
21
|
+
<div class="breadcrumbs"><a href="index.html">Home</a><span class="sep">/</span><span class="current">Installation</span></div>
|
|
22
|
+
|
|
23
|
+
<h1>Installation</h1>
|
|
24
|
+
|
|
25
|
+
<h2 id="npm">Install via npm</h2>
|
|
26
|
+
<pre><code class="language-bash">npm install -g clew-code
|
|
27
|
+
|
|
28
|
+
# Verify installation
|
|
29
|
+
clew --version
|
|
30
|
+
</code></pre>
|
|
31
|
+
|
|
32
|
+
<h2 id="build">Build from Source</h2>
|
|
33
|
+
<pre><code class="language-bash">git clone https://github.com/ClewCode/ClewCode.git
|
|
34
|
+
cd ClewCode
|
|
35
|
+
bun install
|
|
36
|
+
bun run build
|
|
37
|
+
bun run start
|
|
38
|
+
</code></pre>
|
|
39
|
+
|
|
40
|
+
<h2 id="requirements">Requirements</h2>
|
|
41
|
+
<table>
|
|
42
|
+
<thead>
|
|
43
|
+
<tr><th>Dependency</th><th>Minimum Version</th></tr>
|
|
44
|
+
</thead>
|
|
45
|
+
<tbody>
|
|
46
|
+
<tr><td>Bun</td><td>1.3+</td></tr>
|
|
47
|
+
<tr><td>Node.js</td><td>18+</td></tr>
|
|
48
|
+
<tr><td>Git</td><td>Any modern version</td></tr>
|
|
49
|
+
<tr><td>Provider API key</td><td>At least one (see <a href="providers.html">providers</a>)</td></tr>
|
|
50
|
+
</tbody>
|
|
51
|
+
</table>
|
|
52
|
+
|
|
53
|
+
<h2 id="platform">Platform Notes</h2>
|
|
54
|
+
|
|
55
|
+
<h3>macOS</h3>
|
|
56
|
+
<p>Works out of the box on both Apple Silicon and Intel Macs.</p>
|
|
57
|
+
|
|
58
|
+
<h3>Linux</h3>
|
|
59
|
+
<p>No special dependencies required.</p>
|
|
60
|
+
|
|
61
|
+
<h3>Windows</h3>
|
|
62
|
+
<p>Requires Git Bash, WSL, or PowerShell. Some features (e.g., ComputerUse) are Windows-only.</p>
|
|
63
|
+
<pre><code class="language-powershell">Remove-Item -Recurse -Force node_modules
|
|
64
|
+
bun install
|
|
65
|
+
bun run dev
|
|
66
|
+
</code></pre>
|
|
67
|
+
|
|
68
|
+
<h2 id="verify">Verify Installation</h2>
|
|
69
|
+
<pre><code class="language-bash">clew --version
|
|
70
|
+
# Should print v0.2.22 or later
|
|
71
|
+
</code></pre>
|
|
72
|
+
</div>
|
|
73
|
+
</div>
|
|
74
|
+
|
|
75
|
+
<script src="js/main.js"></script>
|
|
76
|
+
</body>
|
|
77
|
+
</html>
|