clew-code 0.3.2 → 0.3.4

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.
Files changed (49) hide show
  1. package/README.md +196 -114
  2. package/dist/generated/version.json +1 -1
  3. package/dist/main.js +2963 -3272
  4. package/package.json +5 -5
  5. package/scripts/bun-run.mjs +33 -0
  6. package/scripts/postbuild-inject-macro.mjs +36 -0
  7. package/docs/.nojekyll +0 -0
  8. package/docs/_config.yml +0 -3
  9. package/docs/architecture.html +0 -90
  10. package/docs/assets/clew-agent-loop.png +0 -0
  11. package/docs/assets/clew-general-architecture.png +0 -0
  12. package/docs/assets/clew-mcp-architecture.png +0 -0
  13. package/docs/assets/clew-p2p-swarm.png +0 -0
  14. package/docs/assets/clew.svg +0 -33
  15. package/docs/changelog.html +0 -141
  16. package/docs/cli-reference.html +0 -89
  17. package/docs/commands.html +0 -161
  18. package/docs/configuration.html +0 -85
  19. package/docs/contributing.html +0 -91
  20. package/docs/css/styles.css +0 -545
  21. package/docs/daemon.html +0 -62
  22. package/docs/features/bridge-mode.html +0 -62
  23. package/docs/features/evals.html +0 -58
  24. package/docs/features/searxng-search.html +0 -59
  25. package/docs/features/sentry-setup.html +0 -62
  26. package/docs/generated/providers.html +0 -625
  27. package/docs/generated/tools.html +0 -559
  28. package/docs/index.html +0 -182
  29. package/docs/installation.html +0 -77
  30. package/docs/internals/claude-ai-backend-dependencies.md +0 -278
  31. package/docs/internals/growthbook-ab-testing.html +0 -70
  32. package/docs/internals/hidden-features.html +0 -82
  33. package/docs/internals/long-term-memory-design.md +0 -173
  34. package/docs/js/main.js +0 -438
  35. package/docs/loop.html +0 -69
  36. package/docs/mcp.html +0 -99
  37. package/docs/models.html +0 -81
  38. package/docs/permission-model.html +0 -86
  39. package/docs/personal-profile.html +0 -113
  40. package/docs/plugins.html +0 -84
  41. package/docs/providers.html +0 -625
  42. package/docs/quick-start.html +0 -81
  43. package/docs/research-memory.html +0 -71
  44. package/docs/security.html +0 -71
  45. package/docs/skills.html +0 -67
  46. package/docs/swarm.html +0 -78
  47. package/docs/tools.html +0 -559
  48. package/docs/troubleshooting.html +0 -86
  49. package/docs/voice-mode.html +0 -79
package/docs/configuration.html DELETED
@@ -1,85 +0,0 @@
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 &lt;id&gt;</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>
package/docs/contributing.html DELETED
@@ -1,91 +0,0 @@
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>