@karmaniverous/jeeves-watcher-openclaw 0.15.5 → 0.16.0-0

package/README.md

@@ -8,43 +8,37 @@ A running [jeeves-watcher](https://www.npmjs.com/package/@karmaniverous/jeeves-w
 
 ## Installation
 
-### Standard (OpenClaw CLI)
+The plugin is a standard OpenClaw plugin with no installer of its own. On a Jeeves box, `jeeves install` (from [`@karmaniverous/jeeves`](https://www.npmjs.com/package/@karmaniverous/jeeves) 0.6+) installs it and writes its config:
 
 ```bash
-openclaw plugins install @karmaniverous/jeeves-watcher-openclaw
+jeeves install watcher --config-root /srv/jeeves/config
 ```
 
-### Self-Installer (Windows workaround)
-
-OpenClaw's `plugins install` command has a known [`spawn EINVAL`](https://github.com/openclaw/openclaw/issues/9224) bug on Windows. This package includes a self-installer that bypasses the issue:
-
-```bash
-npx @karmaniverous/jeeves-watcher-openclaw install
-```
-
-This copies the plugin into OpenClaw's extensions directory and patches the config. To remove:
+Or install it directly with the OpenClaw CLI and set the config yourself:
 
 ```bash
-npx @karmaniverous/jeeves-watcher-openclaw uninstall
+openclaw plugins install npm:@karmaniverous/jeeves-watcher-openclaw@<version> --pin --accept-capabilities
 ```
 
-**Non-default installations:** Set `OPENCLAW_CONFIG` (path to `openclaw.json`) or `OPENCLAW_HOME` (path to `.openclaw` directory) if OpenClaw is not installed at the default location.
+The plugin registers an always-in-context rule set through OpenClaw's `before_prompt_build` hook, so it needs `plugins.entries.jeeves-watcher-openclaw.hooks.allowConversationAccess: true`. `jeeves install` / `jeeves update` grant this automatically (the hook is declared in `package.json` under `jeeves.conversationHooks`).
 
-After install or uninstall, restart the OpenClaw gateway to apply changes.
+Restart the OpenClaw gateway to apply changes.
 
 ## Configuration
 
-Set the plugin config in `openclaw.json` under `plugins.entries.jeeves-watcher-openclaw.config`:
+Plugin config lives in `openclaw.json` under `plugins.entries.jeeves-watcher-openclaw.config`:
 
 ```json
 {
   "apiUrl": "http://127.0.0.1:1936",
-  "configRoot": "j:/config"
+  "configRoot": "/srv/jeeves/config"
 }
 ```
 
-- **`apiUrl`** — jeeves-watcher API base URL (default: `http://127.0.0.1:1936`)
-- **`configRoot`** — platform config root path, used by `@karmaniverous/jeeves` core to derive `{configRoot}/jeeves-watcher/` for component config (default: `j:/config`)
+- **`apiUrl`**: jeeves-watcher API base URL (default: `http://127.0.0.1:1936`; env fallback `JEEVES_WATCHER_URL`).
+- **`configRoot`**: platform config root path, used by `@karmaniverous/jeeves` core to derive `{configRoot}/jeeves-watcher/`. **No default.** Set it in plugin config or via the `JEEVES_CONFIG_ROOT` env var.
+
+`configRoot` is resolved lazily. The plugin always registers, even before its config is written (`openclaw plugins install` activates a plugin before `jeeves install` writes `plugins.entries.<id>.config`). While `configRoot` is unset the plugin logs one warning at registration. Gating is per call: only invocations that actually read `configRoot` are gated. Today that is exactly `watcher_service` with `action: "install"` (it derives the service config path from `configRoot`); it returns an error naming both ways to set it. Other `watcher_service` actions (`uninstall`, `start`, `stop`, `restart`, `status`) address the OS service by name, and every other tool only calls the watcher HTTP API, so they keep working without `configRoot`. Core is initialized on the first gated call after it resolves.
 
 ## Architecture
 
@@ -52,17 +46,17 @@ Set the plugin config in `openclaw.json` under `plugins.entries.jeeves-watcher-o
 
 ## Jeeves Platform Integration
 
-This plugin integrates with [`@karmaniverous/jeeves`](https://www.npmjs.com/package/@karmaniverous/jeeves) to manage workspace content:
+The plugin builds on [`@karmaniverous/jeeves`](https://www.npmjs.com/package/@karmaniverous/jeeves) 0.6 (the static-content core). It writes **no** workspace files and starts no timers:
 
-- **TOOLS.md** — writes a `## Watcher` section with a live menu of indexed content, score thresholds, and escalation rules (refreshes every 71 seconds)
-- **SOUL.md / AGENTS.md** — maintains shared platform content via managed sections
-- **Service commands** — exposes `stop`, `uninstall`, and `status` for the watcher service
-- **Plugin commands** — exposes `uninstall` for the plugin itself
+- **Always-in-context rules**: the watcher escalation, scan-first and search-first rules and score guidance are injected on every turn via `before_prompt_build` (`registerPromptContext`). They replace the v0.x TOOLS.md `## Watcher` section.
+- **Live state**: served by tools (`watcher_status`, `watcher_config`) rather than a refreshed file.
+- **Skill**: `jeeves-watcher` ships in the package and is declared in `openclaw.plugin.json` (`skills`).
+- **Static platform content** (SOUL.md / AGENTS.md blocks) is rendered only by `jeeves install`.
 
 ## Tools
 
 | Tool | Description |
-|------|-------------|
+| --- | --- |
 | `watcher_status` | Service health, uptime, and collection stats |
 | `watcher_search` | Semantic search across indexed documents |
 | `watcher_enrich` | Set or update document metadata by file path |