npm - clew-code - Versions diffs - 0.2.21 → 0.2.22 - Mend

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.

Files changed (66) hide show

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/features/searxng-search.html CHANGED Viewed

@@ -1,119 +1,59 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>SearXNG Search — Clew</title>
-  <meta name="description" content="Self-hosted privacy-respecting web search via Docker SearXNG.">
-  <link rel="preconnect" href="https://fonts.googleapis.com">
-  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-  <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">
-  <link rel="stylesheet" href="../css/styles.css">
-  <link rel="icon" type="image/svg+xml" href="../assets/clew.svg">
-</head>
-<body>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>SearXNG Search — Clew Code</title>
+<meta name="description" content="Private, self-hosted web search via SearXNG integration.">
+<link rel="icon" type="image/svg+xml" href="../assets/clew.svg">
+<link rel="preconnect" href="https://fonts.googleapis.com">
+<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">
+<link rel="stylesheet" href="../css/styles.css">
+</head>
+<body>
 <header class="header"></header>
-<div class="app">
-  <aside class="sidebar" id="sidebar"></aside>
-  <div class="sidebar-overlay" id="sidebarOverlay"></div>
-  <div class="content-wrap">
-    <main class="content">
-      <div class="breadcrumbs"><a href="../index.html">Home</a><span class="sep">/</span><a href="../index.html#features">Features</a><span class="sep">/</span><span>SearXNG Search</span></div>
-      <h1>SearXNG Search</h1>
-      <p class="section-subtitle">Self-hosted, privacy-respecting web search via Docker</p>
-      <div class="callout callout-tip">
-        <strong>TL;DR</strong>
-        Run <code>cd searxng && start.bat</code> to start the search engine, then use <code>/searxng on</code> from the CLI.
-      </div>
-      <h2>Overview</h2>
-      <p>SearXNG is a free, privacy-respecting metasearch engine. This project provides a Docker-based setup so you can run your own instance locally, avoiding reliance on public instances (which increasingly return 403/429 due to Cloudflare/anti-bot protection).</p>
-      <h2>Quick Start</h2>
-      <pre><code>cd searxng
-start.bat</code></pre>
-      <p>Starts SearXNG on <a href="http://localhost:18889">http://localhost:18889</a>.</p>
-      <h3>Slash Command</h3>
-      <table>
-        <tr><th>Command</th><th>Action</th></tr>
-        <tr><td><code>/searxng on</code></td><td>Start the Docker container</td></tr>
-        <tr><td><code>/searxng off</code></td><td>Stop the Docker container</td></tr>
-        <tr><td><code>/searxng status</code></td><td>Check if running</td></tr>
-        <tr><td><code>/searxng restart</code></td><td>Restart the container</td></tr>
-      </table>
-      <h3>Manual Docker Commands</h3>
-      <pre><code>docker compose -f searxng/docker-compose.yml up -d
-docker compose -f searxng/docker-compose.yml down
-docker compose -f searxng/docker-compose.yml logs -f</code></pre>
-      <h2>Files</h2>
-      <table>
-        <tr><th>File</th><th>Purpose</th></tr>
-        <tr><td><code>searxng/docker-compose.yml</code></td><td>Container definition, port 188899 8080</td></tr>
-        <tr><td><code>searxng/.env</code></td><td>Host, port, and secret key</td></tr>
-        <tr><td><code>searxng/config/settings.yml</code></td><td>SearXNG configuration with JSON API enabled</td></tr>
-        <tr><td><code>searxng/limiter.toml</code></td><td>Rate limiter — relaxed for local network IPs</td></tr>
-        <tr><td><code>searxng/start.bat</code></td><td>Start wrapper</td></tr>
-        <tr><td><code>searxng/stop.bat</code></td><td>Stop wrapper</td></tr>
-        <tr><td><code>searxng/restart.bat</code></td><td>Restart wrapper</td></tr>
-        <tr><td><code>searxng/logs.bat</code></td><td>Log tail wrapper</td></tr>
-      </table>
-      <h2>How It Works</h2>
-      <ol>
-        <li>SearXNG runs in Docker on <code>localhost:18889</code></li>
-        <li>The project's <code>.env</code> sets <code>SEARXNG_INSTANCE_URL=http://localhost:18889</code></li>
-        <li><code>selectBestDirectProvider()</code> in <code>WebSearchTool.ts</code> auto-detects this and prioritises SearXNG</li>
-        <li>The <code>SearXNGProvider</code> sends GET requests with <code>format=json</code> and parses results</li>
-      </ol>
-      <h2>Engines Enabled</h2>
-      <ul>
-        <li><strong>DuckDuckGo</strong> — primary general search (no API key needed)</li>
-        <li><strong>Google</strong> — general search</li>
-        <li><strong>Wikipedia</strong> — infobox and article results</li>
-        <li><strong>StackOverflow</strong> — technical Q&amp;A</li>
-        <li><strong>GitHub</strong> — repository search</li>
-        <li><strong>Wikidata</strong> — structured data infoboxes</li>
-      </ul>
-      <h2>Provider Selection Priority</h2>
-      <ol>
-        <li><strong>Tavily</strong> — requires <code>TAVILY_API_KEY</code></li>
-        <li><strong>Brave</strong> — requires <code>BRAVE_API_KEY</code></li>
-        <li><strong>Serper</strong> — requires <code>SERPER_API_KEY</code></li>
-        <li><strong>SearXNG</strong> — only if <code>SEARXNG_INSTANCE_URL</code> is explicitly set</li>
-        <li><strong>DuckDuckGo</strong> — always available, free, no API key</li>
-      </ol>
-      <h2>Troubleshooting</h2>
-      <h3>Container won't start</h3>
-      <pre><code>docker compose -f searxng/docker-compose.yml logs</code></pre>
-      <h3>No results returned</h3>
-      <p>Check that engines are not failing by visiting <a href="http://localhost:18889">http://localhost:18889</a> and performing a search in the web UI.</p>
-      <h3>Port conflict</h3>
-      <p>Change <code>SEARXNG_PORT</code> in <code>searxng/.env</code> and update <code>SEARXNG_INSTANCE_URL</code> in <code>.env</code> to match.</p>
-      <h2>Updating</h2>
-      <pre><code>cd searxng
-docker compose pull
-docker compose up -d</code></pre>
-      <footer class="footer">
-        <span>Clew Code 0.2.14</span>
-        <div class="footer-links">
-          <a href="https://github.com/ClewCode/ClewCode">GitHub</a>
-          <a href="https://github.com/ClewCode/ClewCode/issues">Issues</a>
-        </div>
-      </footer>
-    </main>
-    <nav class="toc-sidebar"></nav>
-  </div>
-</div>
-<script src="../js/main.js"></script>
-</body>
-</html>
+<div id="sidebarOverlay" class="sidebar-overlay"></div>
+<aside id="sidebar" class="sidebar"></aside>
+<div class="content-wrap">
+<div class="content">
+<div class="breadcrumbs"><a href="../index.html">Home</a><span class="sep">/</span><span class="current">SearXNG Search</span></div>
+<h1>SearXNG Search</h1>
+<p class="sub">Private, self-hosted web search integration using SearXNG.</p>
+<h2 id="overview">Overview</h2>
+<p>Clew Code integrates with <a href="https://docs.searxng.org/">SearXNG</a>, a privacy-respecting, self-hosted metasearch engine. This gives the AI access to web search results without relying on third-party search APIs.</p>
+<h2 id="setup">Setup</h2>
+<ol>
+  <li>Deploy SearXNG (Docker is recommended):<pre><code class="language-bash">docker run --name searxng -d -p 8888:8080 \
+  -e BASE_URL=http://localhost:8888/ \
+  searxng/searxng</code></pre></li>
+  <li>Configure SearXNG to enable JSON API:<pre><code class="language-yaml"># /etc/searxng/settings.yml
+search:
+  formats:
+    - html
+    - json</code></pre></li>
+  <li>Set the SearXNG URL in Clew Code:<pre><code class="language-bash">export SEARXNG_URL=http://localhost:8888</code></pre></li>
+</ol>
+<h2 id="using">Using SearXNG</h2>
+<pre><code class="language-bash">❯ /searxng search "your query here"
+</code></pre>
+<p>The search results are automatically available to the AI as context.</p>
+<h2 id="benefits">Benefits</h2>
+<ul>
+  <li>Complete privacy — no search data sent to third parties</li>
+  <li>Aggregates results from multiple engines (Google, Bing, DuckDuckGo, etc.)</li>
+  <li>Self-hosted and fully可控</li>
+  <li>Works offline or on air-gapped networks</li>
+</ul>
+</div>
+</div>
+<script src="../js/main.js"></script>
+</body>
+</html>

package/docs/features/sentry-setup.html CHANGED Viewed

@@ -1,125 +1,62 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Sentry Error Reporting — Clew</title>
-  <meta name="description" content="Opt-in Sentry crash/error telemetry for Clew — default off, privacy-first.">
-  <link rel="preconnect" href="https://fonts.googleapis.com">
-  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-  <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">
-  <link rel="stylesheet" href="../css/styles.css">
-  <link rel="icon" type="image/svg+xml" href="../assets/clew.svg">
-</head>
-<body>
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>Sentry Setup — Clew Code</title>
+<meta name="description" content="Error tracking and performance monitoring with Sentry.">
+<link rel="icon" type="image/svg+xml" href="../assets/clew.svg">
+<link rel="preconnect" href="https://fonts.googleapis.com">
+<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">
+<link rel="stylesheet" href="../css/styles.css">
+</head>
+<body>
 <header class="header"></header>
-<div class="app">
-  <aside class="sidebar" id="sidebar"></aside>
-  <div class="sidebar-overlay" id="sidebarOverlay"></div>
-  <div class="content-wrap">
-    <main class="content">
-      <div class="breadcrumbs"><a href="../index.html">Home</a><span class="sep">/</span><a href="../index.html#features">Features</a><span class="sep">/</span><span>Sentry Setup</span></div>
-      <h1>Sentry Error Reporting</h1>
-      <p class="section-subtitle">Optional, opt-in crash and error telemetry — <strong>completely disabled by default</strong>. No data leaves your machine unless you explicitly set <code>SENTRY_DSN</code>.</p>
-      <div class="callout callout-tip">
-        <strong>TL;DR</strong>
-        <code>SENTRY_DSN=https://key@sentry.io/123 claude</code> — that's it. Without it, zero network requests, zero telemetry.
-      </div>
-      <h2>Quick Start</h2>
-      <h3>Self-hosted Sentry</h3>
-      <pre><code>SENTRY_DSN=https://public_key@your-sentry.example.com/123 claude</code></pre>
-      <h3>Sentry Cloud</h3>
-      <pre><code>SENTRY_DSN=https://public_key@o123456.ingest.sentry.io/789 claude</code></pre>
-      <h3>Disable (default)</h3>
-      <pre><code>clew</code></pre>
-      <h2>Environment Variables</h2>
-      <table>
-        <tr><th>Variable</th><th>Required</th><th>Default</th><th>Description</th></tr>
-        <tr><td><code>SENTRY_DSN</code></td><td><strong>yes</strong></td><td>—</td><td>Sentry DSN to enable. Without this, everything is no-op.</td></tr>
-        <tr><td><code>SENTRY_ENVIRONMENT</code></td><td>no</td><td><code>NODE_ENV</code> or <code>production</code></td><td>Environment tag in Sentry dashboard</td></tr>
-        <tr><td><code>SENTRY_RELEASE</code></td><td>no</td><td>auto from package.json</td><td>Release version tag</td></tr>
-        <tr><td><code>SENTRY_SAMPLE_RATE</code></td><td>no</td><td><code>1.0</code></td><td>Error sample rate (0.0–1.0)</td></tr>
-      </table>
-      <h2>What Gets Sent</h2>
-      <p>Only error metadata — <strong>never prompts, responses, file contents, or command output</strong>:</p>
-      <ul>
-        <li>Error name, message, and stack trace (without local variable values)</li>
-        <li>Runtime info: OS platform, Node/Bun version</li>
-        <li>Mode: REPL, non-interactive, MCP server</li>
-        <li>Provider and model name (when applicable)</li>
-        <li>Version and release tag</li>
-      </ul>
-      <h2>What Does NOT Get Sent</h2>
-      <table>
-        <tr><th>Category</th><th>Examples</th></tr>
-        <tr><td><strong>Prompts</strong></td><td>user input, AI system prompts</td></tr>
-        <tr><td><strong>Responses</strong></td><td>model output, streaming chunks</td></tr>
-        <tr><td><strong>File content</strong></td><td>Read/Edit/Write payload, command stdout/stderr</td></tr>
-        <tr><td><strong>Credentials</strong></td><td>API keys, tokens, passwords, cookies</td></tr>
-        <tr><td><strong>Auth headers</strong></td><td>Authorization, x-api-key, Cookie, Set-Cookie</td></tr>
-        <tr><td><strong>OAuth tokens</strong></td><td>access_token, refresh_token, id_token</td></tr>
-        <tr><td><strong>Environment dump</strong></td><td>entire env block (individual vars may appear as tags)</td></tr>
-        <tr><td><strong>Local paths</strong></td><td>home directory anonymized to <code>[HOME]</code></td></tr>
-        <tr><td><strong>Breadcrumbs</strong></td><td>user actions are not tracked</td></tr>
-        <tr><td><strong>User identity</strong></td><td>user field stripped from all events</td></tr>
-      </table>
-      <h2>Privacy Scrubber</h2>
-      <p>Every event passes through a <code>beforeSend</code> hook that:</p>
-      <ol>
-        <li><strong>Scrubs strings</strong> — removes API key patterns (<code>sk-*</code>, <code>Bearer</code> tokens), auth headers, cookie values</li>
-        <li><strong>Strips stack frame variables</strong> — removes <code>vars</code>, <code>pre_context</code>, <code>context_line</code>, <code>post_context</code></li>
-        <li><strong>Removes breadcrumbs</strong> — user actions are never tracked</li>
-        <li><strong>Cleans request data</strong> — removes headers, cookies, query strings</li>
-        <li><strong>Anonymizes home directory</strong> — replaces paths with <code>[HOME]</code></li>
-        <li><strong>Drops oversized strings</strong> — over 2000 chars truncated</li>
-        <li><strong>Recursively scrubs nested objects</strong> — drops keys named prompt, response, content, message, input, output, text, body, data, payload, token, key, secret, password, auth, cookie</li>
-      </ol>
-      <h2>Checking Status</h2>
-      <pre><code># When disabled
-Sentry Telemetry: Disabled (set SENTRY_DSN to enable)
-# When enabled
-Sentry Telemetry: Enabled</code></pre>
-      <div class="callout callout-info">
-        <strong>DSN Masking</strong>
-        The DSN is masked in the UI — only the first 8 and last 4 characters of the key are shown. The full DSN is never displayed in any output.
-      </div>
-      <h2>Files</h2>
-      <table>
-        <tr><th>File</th><th>Purpose</th></tr>
-        <tr><td><code>src/utils/sentry.ts</code></td><td>Core wrapper — init, capture, close, scrubber</td></tr>
-        <tr><td><code>src/utils/sentry.test.ts</code></td><td>Unit tests (11 tests)</td></tr>
-        <tr><td><code>src/entrypoints/init.ts</code></td><td>Calls <code>initSentry()</code> at startup</td></tr>
-        <tr><td><code>src/utils/gracefulShutdown.ts</code></td><td>Calls <code>closeSentry()</code> before exit</td></tr>
-        <tr><td><code>src/utils/log.ts</code></td><td><code>logError()</code> sends to Sentry when enabled</td></tr>
-        <tr><td><code>src/components/SentryErrorBoundary.tsx</code></td><td>React error boundary for render crashes</td></tr>
-        <tr><td><code>src/components/App.tsx</code></td><td>Wraps app tree in <code>SentryErrorBoundary</code></td></tr>
-        <tr><td><code>src/utils/doctorDiagnostic.ts</code></td><td><code>/doctor</code> Sentry status display</td></tr>
-      </table>
-      <footer class="footer">
-        <span>Clew Code 0.2.14</span>
-        <div class="footer-links">
-          <a href="https://github.com/ClewCode/ClewCode">GitHub</a>
-          <a href="https://github.com/ClewCode/ClewCode/issues">Issues</a>
-        </div>
-      </footer>
-    </main>
-    <nav class="toc-sidebar"></nav>
-  </div>
-</div>
-<script src="../js/main.js"></script>
-</body>
-</html>
+<div id="sidebarOverlay" class="sidebar-overlay"></div>
+<aside id="sidebar" class="sidebar"></aside>
+<div class="content-wrap">
+<div class="content">
+<div class="breadcrumbs"><a href="../index.html">Home</a><span class="sep">/</span><span class="current">Sentry Setup</span></div>
+<h1>Sentry Setup</h1>
+<p class="sub">Error tracking and performance monitoring via Sentry integration.</p>
+<h2 id="overview">Overview</h2>
+<p>Clew Code integrates with <a href="https://sentry.io/">Sentry</a> for error tracking, crash reporting, and performance monitoring. This helps developers identify and fix issues in production deployments.</p>
+<h2 id="configuration">Configuration</h2>
+<p>Set your Sentry DSN as an environment variable:</p>
+<pre><code class="language-bash">export SENTRY_DSN=https://your-dsn@sentry.io/your-project
+</code></pre>
+<p>Or configure it in <code>.clew/settings.json</code>:</p>
+<pre><code class="language-json">{
+  "sentry": {
+    "dsn": "https://your-dsn@sentry.io/your-project",
+    "environment": "production",
+    "tracesSampleRate": 0.1
+  }
+}
+</code></pre>
+<h2 id="features">What's Tracked</h2>
+<ul>
+  <li>Unhandled exceptions and promise rejections</li>
+  <li>Provider API errors with contextual information</li>
+  <li>Tool execution failures</li>
+  <li>Session-level performance traces</li>
+  <li>MCP server connection errors</li>
+</ul>
+<h2 id="verify">Verifying Setup</h2>
+<p>Run the doctor command to verify Sentry is connected:</p>
+<pre><code class="language-bash">❯ /doctor
+</code></pre>
+</div>
+</div>
+<script src="../js/main.js"></script>
+</body>
+</html>