suzumearch 0.2.12 → 0.2.14

package/README.md

@@ -1,90 +1,151 @@
 # SuzumeArch
 
-SuzumeArch is an independent CLI mod of the Claude Code Leak by Nefertary I.
-Forster. It is not affiliated with, endorsed by, sponsored by, or presented as
-Anthropic software.
+SuzumeArch is an independent terminal AI coding CLI. It is not affiliated with,
+endorsed by, sponsored by, or presented as Anthropic software.
 
-It provides a terminal-first AI coding CLI with a React/Ink UI, MCP support,
-external model provider support, and optional local web search through SearXNG.
+## Requirements
 
-## Quick Start
+- Windows, macOS, Linux, or WSL
+- Git
+- Node.js 22 or newer
+- Bun 1.1 or newer
+- At least one model-provider API key, such as `ANTHROPIC_API_KEY`,
+  `OPENAI_API_KEY`, or `OPENROUTER_API_KEY`
+
+## Install From Source
 
 ```bash
+git clone https://github.com/forsterdev/suzume-arch.git
+cd suzume-arch
 bun install
+```
+
+PowerShell uses the same commands:
+
+```powershell
+git clone https://github.com/forsterdev/suzume-arch.git
+cd suzume-arch
+bun install
+```
+
+Set the provider key for your shell:
+
+```bash
+export ANTHROPIC_API_KEY="sk-..."
+```
+
+```powershell
+$env:ANTHROPIC_API_KEY="sk-..."
+```
+
+Run the CLI from the repository:
+
+```bash
 bun run suzume
 ```
 
-Useful local checks:
+## Build The CLI
 
 ```bash
-bun run lint
-bun run typecheck
 bun run build:prod
+node dist/cli.mjs --version
+bun dist/cli.mjs --version
+```
+
+The npm package name is `suzumearch`, with command entry points `suzume` and
+`szm`. The manifest is currently marked `private`; remove that flag before
+publishing to npm. After publishing, install it with:
+
+```bash
+npm install -g suzumearch
+suzume
+```
+
+For local package testing:
+
+```bash
+npm link
+suzume --version
 ```
 
-After a production build, confirm `dist/cli.mjs` exists and can run:
+## Common Checks
+
+Recommended full verification:
 
 ```bash
+bun install
+bun run typecheck
+bun run lint
+bun run build:prod
 node dist/cli.mjs --version
 bun dist/cli.mjs --version
 ```
 
-## Web Search
+Fast local checks while developing:
+
+```bash
+bun run lint
+bun run typecheck
+```
 
-SuzumeArch can use a self-hosted SearXNG instance for external models.
+## Scheduling And Recaps
+
+- Ask naturally, for example `remind me at 3pm to push the release branch`.
+  SuzumeArch should use `CronCreate` for one-shot reminders.
+- Use `/schedule` to create, list, update, or run local scheduled routines.
+- Use `/tasks` to inspect running background shell or agent work.
+- Use `/recap` for an on-demand one-line session recap. Automatic recaps can be
+  toggled in `/config`.
+
+Session-only scheduled tasks stop when SuzumeArch exits. Durable tasks are stored
+in `.suzume/scheduled_tasks.json` when the model explicitly creates them that
+way.
+
+## Discord Bot Bridge
+
+Configure the bot:
 
 ```bash
-export SEARXNG_BASE_URL="http://localhost:8888"
+export DISCORD_BOT_TOKEN="..."
+export DISCORD_CHANNEL_ID="..."
 ```
 
-You can also configure it inside settings:
-
-```json
-{
-  "plugins": {
-    "entries": {
-      "searxng": {
-        "config": {
-          "webSearch": {
-            "baseUrl": "http://localhost:8888",
-            "categories": "general,news",
-            "language": "en"
-          }
-        }
-      }
-    }
-  }
-}
+```powershell
+$env:DISCORD_BOT_TOKEN="..."
+$env:DISCORD_CHANNEL_ID="..."
 ```
 
-Use `/web-search` in the CLI to install, start, stop, or configure a managed
-SearXNG instance. The managed install enables `format=json` in SearXNG settings.
+Then run `/discord on` inside SuzumeArch. `/discord` opens the configuration
+menu; `/discord status` prints the active settings.
 
-## MCP Server
+Warning: Discord mode automatically switches the session to
+`bypassPermissions` by default. Anyone who can post in the configured Discord
+channel can trigger tools and shell commands without per-action prompts. Use a
+private channel and a dedicated bot token.
 
-The MCP helper lives in `mcp-server/`.
+## Web Search
+
+SuzumeArch can use a self-hosted SearXNG instance for external models:
 
 ```bash
-cd mcp-server
-npm install
-npm run build
-npm start
+export SEARXNG_BASE_URL="http://localhost:8888"
 ```
 
-Use `npm run start:http` for HTTP/SSE mode. Set `MCP_API_KEY` to require bearer
-auth for HTTP.
+Use `/web-search` in the CLI to install, start, stop, or configure a managed
+SearXNG instance.
 
 ## Web Terminal
 
-The Docker web terminal runs `bun /app/src/server/web/pty-server.ts`.
-Required runtime settings:
+The browser-facing PTY server lives at `src/server/web/pty-server.ts`:
 
-- `ANTHROPIC_API_KEY` when using the compatible Anthropic API path.
-- `PORT`, default `3000`.
-- `AUTH_TOKEN`, `MAX_SESSIONS`, and `ALLOWED_ORIGINS` as deployment controls.
+```bash
+bun src/server/web/pty-server.ts
+```
 
-## Repository Hygiene
+Runtime settings:
 
-Keep generated outputs and local dependency folders out of source review. The
-root `.gitignore` excludes `node_modules/`, build output, temporary folders, and
-logs.
+- `PORT`, default `3000`
+- `AUTH_TOKEN`
+- `MAX_SESSIONS`
+- `ALLOWED_ORIGINS`
+- The required model-provider API key

package/{suzume.cjs → bin/suzume.cjs}

@@ -16,7 +16,8 @@ var pathToFileURL = require("url").pathToFileURL;
 // (ERR_UNSUPPORTED_ESM_URL_SCHEME — the drive letter "c:" is parsed as
 // a URL scheme). Convert to a file:// URL so the ESM loader accepts it
 // on every platform.
-var entry = pathToFileURL(path.join(__dirname, "cli.mjs")).href;
+// Preflight lives in bin/, cli.mjs sits one level up at the package root.
+var entry = pathToFileURL(path.join(__dirname, "..", "cli.mjs")).href;
 import(entry).catch(function (err) {
   process.stderr.write(String(err && err.stack || err) + "\n");
   process.exit(1);