clew-code 0.2.21 → 0.2.22
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/dist/main.js +1861 -1856
- 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 +156 -265
- package/docs/configuration.html +85 -147
- package/docs/contributing.html +91 -0
- package/docs/css/styles.css +425 -425
- 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 +137 -125
- 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 +69 -110
- 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 +152 -151
- 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/configuration.html
CHANGED
|
@@ -1,147 +1,85 @@
|
|
|
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
|
-
<tr><
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
<tr><td><code
|
|
56
|
-
<tr><td><code>--
|
|
57
|
-
<tr><td><code>--
|
|
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
|
-
<tr><td><code>CLEWCODE_NO_RESPAWN</code></td><td>Disable process respawn</td></tr>
|
|
87
|
-
<tr><td><code>CODE_INDEX=1</code></td><td>Enable fuzzy code search tool</td></tr>
|
|
88
|
-
<tr><td><code>AGENT_TRIGGERS=1</code></td><td>Enable autonomous scheduled task triggers</td></tr>
|
|
89
|
-
<tr><td><code>SENTRY_DSN</code></td><td>Enable Sentry error reporting (opt-in)</td></tr>
|
|
90
|
-
<tr><td><code>TAVILY_API_KEY</code></td><td>Tavily web search (highest priority)</td></tr>
|
|
91
|
-
<tr><td><code>BRAVE_API_KEY</code></td><td>Brave web search</td></tr>
|
|
92
|
-
<tr><td><code>SERPER_API_KEY</code></td><td>Serper web search</td></tr>
|
|
93
|
-
<tr><td><code>SEARXNG_INSTANCE_URL</code></td><td>Self-hosted SearXNG URL</td></tr>
|
|
94
|
-
</table>
|
|
95
|
-
|
|
96
|
-
<h2>Settings File</h2>
|
|
97
|
-
<p>Config file at <code>~/.clew/settings.json</code> (TypeBox-validated). Stores:</p>
|
|
98
|
-
<ul>
|
|
99
|
-
<li>Default provider and model</li>
|
|
100
|
-
<li>Permission mode and rules</li>
|
|
101
|
-
<li>Workspace directories</li>
|
|
102
|
-
<li>Plugin and MCP server configs</li>
|
|
103
|
-
<li>Theme and UI preferences</li>
|
|
104
|
-
<li>Session persistence settings</li>
|
|
105
|
-
</ul>
|
|
106
|
-
|
|
107
|
-
<h2>Config Paths</h2>
|
|
108
|
-
<table>
|
|
109
|
-
<tr><th>Path</th><th>Content</th></tr>
|
|
110
|
-
<tr><td><code>~/.clew/settings.json</code></td><td>Main configuration (TypeBox schema)</td></tr>
|
|
111
|
-
<tr><td><code>~/.clew/credentials/</code></td><td>Stored credentials</td></tr>
|
|
112
|
-
<tr><td><code>~/.clew/sessions/</code></td><td>Session persistence</td></tr>
|
|
113
|
-
<tr><td><code>~/.clew/logs/</code></td><td>Debug and error logs</td></tr>
|
|
114
|
-
<tr><td><code>~/.clew/skills/</code></td><td>User-installed skills</td></tr>
|
|
115
|
-
<tr><td><code>.clew/skills/</code></td><td>Project-level skills</td></tr>
|
|
116
|
-
</table>
|
|
117
|
-
|
|
118
|
-
<h2>In-Session Configuration</h2>
|
|
119
|
-
<pre><code>/config # Open config panel (aliases: settings)
|
|
120
|
-
/theme # Change the theme
|
|
121
|
-
/color # Set prompt bar color
|
|
122
|
-
/keybindings # Edit keybindings
|
|
123
|
-
/permissions # Manage permission rules</code></pre>
|
|
124
|
-
|
|
125
|
-
<h2>Build Configuration</h2>
|
|
126
|
-
<p>Build via <code>bun run build</code> with compile-time feature defines:</p>
|
|
127
|
-
<pre><code># In src/main.tsx:
|
|
128
|
-
--define.TRANSCRIPT_CLASSIFIER=true # Enables auto permission mode
|
|
129
|
-
--define.CHICAGO_MCP=true # Enables Chicago MCP features
|
|
130
|
-
--define.VOICE_MODE=true # Enables voice input support</code></pre>
|
|
131
|
-
|
|
132
|
-
<footer class="footer">
|
|
133
|
-
<span>Clew Code 0.2.14 — Open Source</span>
|
|
134
|
-
<div class="footer-links">
|
|
135
|
-
<a href="https://github.com/ClewCode/ClewCode">GitHub</a>
|
|
136
|
-
<a href="https://github.com/ClewCode/ClewCode/issues">Issues</a>
|
|
137
|
-
</div>
|
|
138
|
-
</footer>
|
|
139
|
-
</main>
|
|
140
|
-
<nav class="toc-sidebar"></nav>
|
|
141
|
-
</div>
|
|
142
|
-
</div>
|
|
143
|
-
<script src="js/main.js"></script>
|
|
144
|
-
</body>
|
|
145
|
-
</html>
|
|
146
|
-
|
|
147
|
-
|
|
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>Configuration — Clew Code</title>
|
|
7
|
+
<meta name="description" href="Configure Clew Code via settings.json, environment variables, and CLI flags.">
|
|
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">Configuration</span></div>
|
|
22
|
+
|
|
23
|
+
<h1>Configuration</h1>
|
|
24
|
+
|
|
25
|
+
<h2 id="settings">settings.json</h2>
|
|
26
|
+
<p>Shared settings live in <code>.clew/settings.json</code> (checked into the repo) and private settings live in <code>.clew/settings.local.json</code> (gitignored).</p>
|
|
27
|
+
<pre><code class="language-json">{
|
|
28
|
+
"permission": "default",
|
|
29
|
+
"provider": "openai",
|
|
30
|
+
"model": "gpt-5.5",
|
|
31
|
+
"theme": "dark",
|
|
32
|
+
"autoUpdate": true
|
|
33
|
+
}
|
|
34
|
+
</code></pre>
|
|
35
|
+
|
|
36
|
+
<h2 id="env">Environment Variables</h2>
|
|
37
|
+
<p>Set provider API keys as environment variables:</p>
|
|
38
|
+
<pre><code class="language-bash">export ANTHROPIC_API_KEY=sk-ant-...
|
|
39
|
+
export OPENAI_API_KEY=sk-...
|
|
40
|
+
export GOOGLE_API_KEY=...
|
|
41
|
+
export DEEPSEEK_API_KEY=sk-...
|
|
42
|
+
export GROQ_API_KEY=gsk_...
|
|
43
|
+
export MISTRAL_API_KEY=...
|
|
44
|
+
export OPENROUTER_API_KEY=...
|
|
45
|
+
export OLLAMA_HOST=http://localhost:11434
|
|
46
|
+
</code></pre>
|
|
47
|
+
<p>The app also reads from <code>.env</code> files in the project root.</p>
|
|
48
|
+
|
|
49
|
+
<h2 id="cli-flags">CLI Flags</h2>
|
|
50
|
+
<table>
|
|
51
|
+
<thead>
|
|
52
|
+
<tr><th>Flag</th><th>Description</th></tr>
|
|
53
|
+
</thead>
|
|
54
|
+
<tbody>
|
|
55
|
+
<tr><td><code>-p, --prompt</code></td><td>One-shot mode: run a prompt and exit</td></tr>
|
|
56
|
+
<tr><td><code>--resume <id></code></td><td>Resume a previous session (use <code>last</code> for most recent)</td></tr>
|
|
57
|
+
<tr><td><code>--version</code></td><td>Print version and exit</td></tr>
|
|
58
|
+
</tbody>
|
|
59
|
+
</table>
|
|
60
|
+
|
|
61
|
+
<h2 id="permission">Permission Mode</h2>
|
|
62
|
+
<p>Set the permission mode in settings or switch at runtime:</p>
|
|
63
|
+
<pre><code class="language-bash">❯ /permissions plan # full-access planning mode
|
|
64
|
+
❯ /permissions auto # auto-approve safe tools
|
|
65
|
+
</code></pre>
|
|
66
|
+
<p>See <a href="permission-model.html">Permission Model</a> for all modes.</p>
|
|
67
|
+
|
|
68
|
+
<h2 id="mcp">MCP Configuration</h2>
|
|
69
|
+
<p>MCP servers are configured in <code>.mcp.json</code> at the project root:</p>
|
|
70
|
+
<pre><code class="language-json">{
|
|
71
|
+
"mcpServers": {
|
|
72
|
+
"filesystem": {
|
|
73
|
+
"command": "npx",
|
|
74
|
+
"args": ["-y", "@modelcontextprotocol/server-filesystem", "."]
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
</code></pre>
|
|
79
|
+
<p>See <a href="mcp.html">MCP docs</a> for details.</p>
|
|
80
|
+
</div>
|
|
81
|
+
</div>
|
|
82
|
+
|
|
83
|
+
<script src="js/main.js"></script>
|
|
84
|
+
</body>
|
|
85
|
+
</html>
|
|
@@ -0,0 +1,91 @@
|
|
|
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>Contributing — Clew Code</title>
|
|
7
|
+
<meta name="description" content="How to contribute to Clew Code.">
|
|
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">Contributing</span></div>
|
|
22
|
+
|
|
23
|
+
<h1>Contributing</h1>
|
|
24
|
+
<p class="sub">Thank you for your interest in contributing to Clew Code.</p>
|
|
25
|
+
|
|
26
|
+
<h2 id="scope">Scope of Contributions</h2>
|
|
27
|
+
<p>Contributions should be limited to material you have the right to submit and license.</p>
|
|
28
|
+
<p><strong>Do not contribute:</strong></p>
|
|
29
|
+
<ul>
|
|
30
|
+
<li>Proprietary source code</li>
|
|
31
|
+
<li>Leaked or copied code</li>
|
|
32
|
+
<li>Private documentation</li>
|
|
33
|
+
<li>Credentials, API keys, tokens, or secrets</li>
|
|
34
|
+
<li>Material copied from Anthropic's proprietary products or private services</li>
|
|
35
|
+
<li>Code that violates third-party licenses or terms</li>
|
|
36
|
+
</ul>
|
|
37
|
+
|
|
38
|
+
<h2 id="good-first-issues">Good First Issues</h2>
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Add a new provider adapter in <code>src/services/ai/</code></li>
|
|
41
|
+
<li>Write tests for untested tools</li>
|
|
42
|
+
<li>Fix docs, add examples</li>
|
|
43
|
+
<li>Build a plugin or MCP server</li>
|
|
44
|
+
<li>Improve Windows support</li>
|
|
45
|
+
</ul>
|
|
46
|
+
|
|
47
|
+
<h2 id="development">Development Setup</h2>
|
|
48
|
+
<h3>Prerequisites</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>Node.js >= 18.0.0</li>
|
|
51
|
+
<li>Bun >= 1.0.0</li>
|
|
52
|
+
<li>Git</li>
|
|
53
|
+
</ul>
|
|
54
|
+
|
|
55
|
+
<h3>Getting Started</h3>
|
|
56
|
+
<pre><code class="language-bash">git clone https://github.com/ClewCode/ClewCode.git
|
|
57
|
+
cd ClewCode
|
|
58
|
+
bun install
|
|
59
|
+
bun run build
|
|
60
|
+
bun run start
|
|
61
|
+
</code></pre>
|
|
62
|
+
|
|
63
|
+
<h3>Development Commands</h3>
|
|
64
|
+
<pre><code class="language-bash">bun run dev # Live reload with tsx
|
|
65
|
+
bun run build # Build to dist/
|
|
66
|
+
bun test # Run tests (Vitest)
|
|
67
|
+
bun x tsc --noEmit # Type-check
|
|
68
|
+
bun run check:ci # Full CI check (lint + test + typecheck)
|
|
69
|
+
</code></pre>
|
|
70
|
+
|
|
71
|
+
<h3>Code Style</h3>
|
|
72
|
+
<p>This project uses <strong>Biome</strong> for formatting and linting:</p>
|
|
73
|
+
<pre><code class="language-bash">bun run format # Format code
|
|
74
|
+
bun run lint # Lint code
|
|
75
|
+
bun run check # Full check with auto-fix
|
|
76
|
+
</code></pre>
|
|
77
|
+
|
|
78
|
+
<h2 id="ci">CI Pipeline</h2>
|
|
79
|
+
<ul>
|
|
80
|
+
<li>Pushing a <code>v*</code> tag triggers the release workflow</li>
|
|
81
|
+
<li>CI runs: typecheck → build → GitHub Release → npm publish</li>
|
|
82
|
+
</ul>
|
|
83
|
+
|
|
84
|
+
<h2 id="license">License</h2>
|
|
85
|
+
<p>Contributor-authored modifications and original additions may be licensed under the terms described in <code>LICENSE.md</code>. Read <code>LICENSE.md</code> and <code>SECURITY.md</code> before contributing.</p>
|
|
86
|
+
</div>
|
|
87
|
+
</div>
|
|
88
|
+
|
|
89
|
+
<script src="js/main.js"></script>
|
|
90
|
+
</body>
|
|
91
|
+
</html>
|