@karmaniverous/jeeves 0.4.6 → 0.5.0

package/README.md

@@ -169,18 +169,28 @@ See the [Building a Component Plugin](https://docs.karmanivero.us/jeeves/documen
 - **`probeAllServices(consumerName?, timeoutMs?)`** — probes all known services (server, watcher, runner, meta).
 - **`checkRegistryVersion(packageName, cacheDir, ttlSeconds?)`** — checks npm registry for the latest version with local file caching (default 1-hour TTL).
 
+## Prerequisites
+
+- **Node.js >= 22** — the CLI enforces this at startup.
+
 ## CLI
 
 ```bash
-jeeves install     # Seed identity, protocols, platform content; create core config
+jeeves install     # Seed identity, protocols, platform content, skill, core config
 jeeves uninstall   # Remove managed sections, templates, config schema
-jeeves status      # Probe all service ports, report health table
+jeeves status      # Probe all service ports, report health + memory hygiene
+jeeves config      # Print effective config with provenance
+jeeves config '$'  # JSONPath query against effective config
 ```
 
-All three commands accept `--workspace <path>` and `--config-root <path>` options.
+All commands accept `--workspace <path>` and `--config-root <path>` options.
+
+`jeeves status` probes all registered component services, reports a health table, and prints a memory hygiene summary showing MEMORY.md character usage, budget utilization, and any stale sections.
 
 ## Configuration
 
+### Core Config
+
 Core config at `{configRoot}/jeeves-core/config.json`:
 
 ```json
@@ -196,6 +206,49 @@ Core config at `{configRoot}/jeeves-core/config.json`:
 }
 ```
 
+### Workspace Config
+
+Optional `jeeves.config.json` at the workspace root provides shared defaults for all CLI commands:
+
+```json
+{
+  "$schema": "./jeeves.config.schema.json",
+  "core": {
+    "workspace": "/path/to/workspace",
+    "configRoot": "/path/to/config",
+    "gatewayUrl": "http://localhost:3000"
+  },
+  "memory": {
+    "budget": 20000,
+    "warningThreshold": 0.8,
+    "staleDays": 90
+  }
+}
+```
+
+Precedence: **CLI flags → environment variables → `jeeves.config.json` → defaults**. Run `jeeves config` to see the effective resolved values with provenance tracking (which source each value came from).
+
+### Workspace Config API
+
+- **`loadWorkspaceConfig(workspacePath)`** — loads and validates `jeeves.config.json` via Zod. Returns `undefined` (with a console warning) if the file is missing, corrupt, or fails validation.
+- **`resolveConfigValue(options)`** — resolves a single config key through the precedence chain (flag → env → file → default) with provenance tracking.
+- **`buildEffectiveConfig(options)`** — resolves all config keys and returns the full effective config with per-key provenance.
+- **`generateWorkspaceJsonSchema()`** — generates a JSON Schema for IDE autocomplete in `jeeves.config.json`.
+
+## Memory Hygiene
+
+MEMORY.md has a character budget (default: 20,000 characters). The `analyzeMemory()` function tracks:
+
+- **Character count and usage percentage** — warns at 80% of budget (configurable via `warningThreshold`)
+- **Stale section detection** — scans ISO dates (`YYYY-MM-DD`) in H2/H3 headings and bullet items; sections whose most recent date exceeds `staleDays` (default: 90) are flagged as stale candidates
+- **Evergreen sections** — sections without parseable dates are never flagged
+
+Memory hygiene is reporting-only. Core does not auto-delete content; the assistant or human reviews stale candidates and decides what to prune.
+
+## Skill Seeding
+
+`jeeves install` and component plugin installers seed a platform skill at `{workspace}/skills/jeeves/SKILL.md`. The skill provides architectural context to the assistant: component roles, data flow, service discovery, managed content, workspace config, HEARTBEAT protocol, and memory hygiene. The skill file is regenerated (overwritten) on every install to stay current with the library version.
+
 <!-- TYPEDOC_EXCLUDE -->
 
 ## Documentation

package/content/skill.md

@@ -0,0 +1,99 @@
+---
+name: jeeves
+description: Jeeves platform architecture, data flow, component interaction, scripts repo, and coordination knowledge. Use when making architectural decisions, coordinating across components, checking platform health, managing service lifecycle, or working with the scripts repo.
+---
+
+# Jeeves Platform Skill
+
+## Platform Architecture
+
+Jeeves is a four-component platform coordinated by a shared library (`@karmaniverous/jeeves`):
+
+| Component | Role | Port |
+|-----------|------|------|
+| **jeeves-runner** | Execute: scheduled jobs, SQLite state, HTTP API | 1937 |
+| **jeeves-watcher** | Index: file→Qdrant semantic indexing, inference rules | 1936 |
+| **jeeves-server** | Present: web UI, file browser, doc render, export | 1934 |
+| **jeeves-meta** | Distill: LLM synthesis, .meta/ directories, scheduling | 1938 |
+
+Core (`@karmaniverous/jeeves`) is a **library + CLI**, not a service. No port.
+
+## Data Flow
+
+```
+Files → Watcher (index) → Qdrant → Meta (synthesize) → .meta/ → Watcher (re-index)
+                                                                      ↓
+Runner (schedule) → Scripts → Services ← Server (present) ← Browser
+```
+
+## Component Interaction
+
+- **Watcher** indexes files into Qdrant with inference rules and enrichments.
+- **Meta** reads from Qdrant, synthesizes `.meta/` directories, which watcher re-indexes.
+- **Runner** executes scheduled scripts that may call any service's HTTP API.
+- **Server** presents files, renders documents, and provides the event gateway.
+- **Core** provides shared content management (TOOLS.md, SOUL.md, AGENTS.md), service discovery, config resolution, and the component SDK.
+
+## Service Discovery
+
+Services find each other via config resolution:
+1. Component's own config file (`{configRoot}/jeeves-{name}/config.json`)
+2. Core config file (`{configRoot}/jeeves-core/config.json`)
+3. Default port constants
+
+## Scripts Repo
+
+Location: `{configRoot}/jeeves-core/scripts/`
+Template: `@karmaniverous/jeeves-scripts-template`
+
+Scripts use utilities from `@karmaniverous/jeeves` (general) and `@karmaniverous/jeeves-runner` (runner-specific). Any script that could be useful outside runner scheduling belongs in core.
+
+## Managed Content System
+
+Core maintains managed sections in workspace files using comment markers:
+- **TOOLS.md** — Component sections (section mode) + Platform section
+- **SOUL.md** — Professional discipline and behavioral foundations (block mode)
+- **AGENTS.md** — Operational protocols and memory architecture (block mode)
+- **HEARTBEAT.md** — Platform health status (heading-based)
+
+Managed blocks are stationary after initial insertion. Cleanup detection uses Jaccard similarity on 3-word shingles. Cleanup escalation spawns a gateway session when orphaned content is detected.
+
+## Workspace Configuration
+
+`jeeves.config.json` at workspace root provides shared defaults:
+- Precedence: CLI flags → env vars → file → defaults
+- Namespaced: `core.*` (workspace, configRoot, gatewayUrl) and `memory.*` (budget, warningThreshold, staleDays)
+- Inspect with `jeeves config [jsonpath]`
+
+## HEARTBEAT Protocol
+
+The HEARTBEAT system uses a state machine per component:
+`not_installed → deps_missing → config_missing → service_not_installed → service_stopped → healthy`
+
+Dependency-aware: hard deps block alerts, soft deps add informational notes. Declined components are tracked via heading suffix.
+
+## Plugin Lifecycle
+
+```bash
+# Core install (seed workspace content)
+npx @karmaniverous/jeeves install
+
+# Component plugin install
+npx @karmaniverous/jeeves-{component}-openclaw install
+
+# Component plugin uninstall
+npx @karmaniverous/jeeves-{component}-openclaw uninstall
+
+# Core uninstall (remove managed sections)
+npx @karmaniverous/jeeves uninstall
+```
+
+## Memory Hygiene
+
+MEMORY.md has a character budget (default 20,000). Core tracks:
+- Character count and usage percentage
+- Warning at 80% of budget
+- Stale section candidates (H2 sections whose most recent ISO date exceeds the staleness threshold)
+- Evergreen sections (no dates) are never flagged
+
+Review is human/agent-mediated — core does not auto-delete.