clew-code 0.2.27 → 0.2.29
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 +77 -42
- package/dist/main.js +2519 -2504
- package/docs/architecture.html +90 -91
- package/docs/changelog.html +141 -150
- package/docs/cli-reference.html +89 -90
- package/docs/commands.html +13 -9
- package/docs/daemon.html +62 -62
- package/docs/generated/providers.html +625 -0
- package/docs/generated/tools.html +559 -0
- package/docs/index.html +10 -13
- package/docs/internals/long-term-memory-design.md +173 -89
- package/docs/js/main.js +438 -437
- package/docs/personal-profile.html +113 -0
- package/docs/providers.html +625 -87
- package/docs/quick-start.html +81 -81
- package/docs/tools.html +551 -175
- package/docs/troubleshooting.html +86 -86
- package/package.json +6 -9
package/docs/quick-start.html
CHANGED
|
@@ -1,81 +1,81 @@
|
|
|
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>Quick Start — Clew Code</title>
|
|
7
|
-
<meta name="description" content="Get started with Clew Code in under a minute.">
|
|
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">Quick Start</span></div>
|
|
22
|
-
|
|
23
|
-
<h1>Quick Start</h1>
|
|
24
|
-
<p class="sub">Get Clew Code running in under a minute.</p>
|
|
25
|
-
|
|
26
|
-
<h2 id="install">1. Install</h2>
|
|
27
|
-
<pre><code class="language-bash">npm install -g clew-code
|
|
28
|
-
</code></pre>
|
|
29
|
-
<p>Requires <a href="https://bun.sh">Bun</a> 1.3+, Node.js 18+, Git, and one provider API key.</p>
|
|
30
|
-
|
|
31
|
-
<h2 id="run">2. Run</h2>
|
|
32
|
-
<pre><code class="language-bash">cd my-project
|
|
33
|
-
clew
|
|
34
|
-
</code></pre>
|
|
35
|
-
<p>On first launch you'll be prompted to select a provider.</p>
|
|
36
|
-
|
|
37
|
-
<h2 id="configure-provider">3. Configure a Provider</h2>
|
|
38
|
-
<p>Inside the REPL, pick your provider and model:</p>
|
|
39
|
-
<pre><code class="language-bash">❯ /model openai
|
|
40
|
-
❯ /model gpt-5.5
|
|
41
|
-
|
|
42
|
-
❯ /model deepseek-v4-pro
|
|
43
|
-
|
|
44
|
-
❯ /model ollama/llama3.3
|
|
45
|
-
</code></pre>
|
|
46
|
-
<p>Or set environment variables before starting:</p>
|
|
47
|
-
<pre><code class="language-bash">export ANTHROPIC_API_KEY=sk-ant-...
|
|
48
|
-
export OPENAI_API_KEY=sk-...
|
|
49
|
-
export GOOGLE_API_KEY=...
|
|
50
|
-
export DEEPSEEK_API_KEY=...
|
|
51
|
-
</code></pre>
|
|
52
|
-
|
|
53
|
-
<h2 id="first-commands">4. Try Commands</h2>
|
|
54
|
-
<pre><code class="language-bash">❯ /help # list everything
|
|
55
|
-
❯ /status # current provider, model, context info
|
|
56
|
-
❯ /
|
|
57
|
-
❯ /mcp list # connected MCP servers
|
|
58
|
-
</code></pre>
|
|
59
|
-
|
|
60
|
-
<h2 id="one-shot">One-Shot Mode</h2>
|
|
61
|
-
<p>Pipe-friendly single-use mode:</p>
|
|
62
|
-
<pre><code class="language-bash">clew -p "summarize CHANGELOG.md"
|
|
63
|
-
</code></pre>
|
|
64
|
-
|
|
65
|
-
<h2 id="resume">Resume Last Session</h2>
|
|
66
|
-
<pre><code class="language-bash">clew --resume last
|
|
67
|
-
</code></pre>
|
|
68
|
-
|
|
69
|
-
<h2 id="next">Next Steps</h2>
|
|
70
|
-
<ul>
|
|
71
|
-
<li><a href="installation.html">Full installation guide</a></li>
|
|
72
|
-
<li><a href="configuration.html">Configuration reference</a></li>
|
|
73
|
-
<li><a href="providers.html">All 27 providers</a></li>
|
|
74
|
-
<li><a href="commands.html">Slash commands</a></li>
|
|
75
|
-
</ul>
|
|
76
|
-
</div>
|
|
77
|
-
</div>
|
|
78
|
-
|
|
79
|
-
<script src="js/main.js"></script>
|
|
80
|
-
</body>
|
|
81
|
-
</html>
|
|
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>Quick Start — Clew Code</title>
|
|
7
|
+
<meta name="description" content="Get started with Clew Code in under a minute.">
|
|
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">Quick Start</span></div>
|
|
22
|
+
|
|
23
|
+
<h1>Quick Start</h1>
|
|
24
|
+
<p class="sub">Get Clew Code running in under a minute.</p>
|
|
25
|
+
|
|
26
|
+
<h2 id="install">1. Install</h2>
|
|
27
|
+
<pre><code class="language-bash">npm install -g clew-code
|
|
28
|
+
</code></pre>
|
|
29
|
+
<p>Requires <a href="https://bun.sh">Bun</a> 1.3+, Node.js 18+, Git, and one provider API key.</p>
|
|
30
|
+
|
|
31
|
+
<h2 id="run">2. Run</h2>
|
|
32
|
+
<pre><code class="language-bash">cd my-project
|
|
33
|
+
clew
|
|
34
|
+
</code></pre>
|
|
35
|
+
<p>On first launch you'll be prompted to select a provider.</p>
|
|
36
|
+
|
|
37
|
+
<h2 id="configure-provider">3. Configure a Provider</h2>
|
|
38
|
+
<p>Inside the REPL, pick your provider and model:</p>
|
|
39
|
+
<pre><code class="language-bash">❯ /model openai
|
|
40
|
+
❯ /model gpt-5.5
|
|
41
|
+
|
|
42
|
+
❯ /model deepseek-v4-pro
|
|
43
|
+
|
|
44
|
+
❯ /model ollama/llama3.3
|
|
45
|
+
</code></pre>
|
|
46
|
+
<p>Or set environment variables before starting:</p>
|
|
47
|
+
<pre><code class="language-bash">export ANTHROPIC_API_KEY=sk-ant-...
|
|
48
|
+
export OPENAI_API_KEY=sk-...
|
|
49
|
+
export GOOGLE_API_KEY=...
|
|
50
|
+
export DEEPSEEK_API_KEY=...
|
|
51
|
+
</code></pre>
|
|
52
|
+
|
|
53
|
+
<h2 id="first-commands">4. Try Commands</h2>
|
|
54
|
+
<pre><code class="language-bash">❯ /help # list everything
|
|
55
|
+
❯ /status # current provider, model, context info
|
|
56
|
+
❯ /peer discover # find other Clew instances on LAN
|
|
57
|
+
❯ /mcp list # connected MCP servers
|
|
58
|
+
</code></pre>
|
|
59
|
+
|
|
60
|
+
<h2 id="one-shot">One-Shot Mode</h2>
|
|
61
|
+
<p>Pipe-friendly single-use mode:</p>
|
|
62
|
+
<pre><code class="language-bash">clew -p "summarize CHANGELOG.md"
|
|
63
|
+
</code></pre>
|
|
64
|
+
|
|
65
|
+
<h2 id="resume">Resume Last Session</h2>
|
|
66
|
+
<pre><code class="language-bash">clew --resume last
|
|
67
|
+
</code></pre>
|
|
68
|
+
|
|
69
|
+
<h2 id="next">Next Steps</h2>
|
|
70
|
+
<ul>
|
|
71
|
+
<li><a href="installation.html">Full installation guide</a></li>
|
|
72
|
+
<li><a href="configuration.html">Configuration reference</a></li>
|
|
73
|
+
<li><a href="providers.html">All 27 providers</a></li>
|
|
74
|
+
<li><a href="commands.html">Slash commands</a></li>
|
|
75
|
+
</ul>
|
|
76
|
+
</div>
|
|
77
|
+
</div>
|
|
78
|
+
|
|
79
|
+
<script src="js/main.js"></script>
|
|
80
|
+
</body>
|
|
81
|
+
</html>
|