@karmaniverous/jeeves-meta 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # @karmaniverous/jeeves-meta
 
-Core synthesis engine for the Jeeves platform. Provides schemas, filesystem discovery, weighted staleness scheduling, and the three-step orchestrator (architect → builder → critic).
+Core synthesis engine for the Jeeves platform. Provides schemas, filesystem discovery, weighted staleness scheduling, three-step orchestration, and a full CLI.
 
 ## Features
 
@@ -10,14 +10,12 @@ Core synthesis engine for the Jeeves platform. Provides schemas, filesystem disc
 - **Three-step orchestration** — architect, builder, critic with conditional re-architecture
 - **Archive management** — timestamped snapshots with configurable pruning
 - **Structure hashing** — detect scope changes (file additions/removals)
-- **Lock management** — filesystem locks with stale timeout
+- **Lock management** — filesystem locks with 30-minute stale timeout
 - **Pluggable executor** — `SynthExecutor` interface for runtime-agnostic subprocess spawning
-- **Pluggable watcher client** — `WatcherClient` interface with HTTP implementation included
+- **Pluggable watcher client** — `WatcherClient` interface with HTTP implementation (3-retry exponential backoff)
 - **Token tracking** — per-step token counts with exponential moving averages
-
-## Architecture
-
-![System Architecture](assets/system-architecture.png)
+- **CLI** — 10 commands for status, listing, synthesis, debugging, and maintenance
+- **Config loader** — `loadSynthConfig()` with `@file:` reference resolution
 
 ## Install
 
@@ -27,30 +25,37 @@ npm install @karmaniverous/jeeves-meta
 
 ## Quick Start
 
+### Library usage
+
 ```typescript
-import { createSynthEngine, HttpWatcherClient } from '@karmaniverous/jeeves-meta';
-
-const watcher = new HttpWatcherClient('http://localhost:1936');
-
-const engine = createSynthEngine({
-  config: {
-    watchPaths: ['j:/domains'],
-    watcherUrl: 'http://localhost:1936',
-    defaultArchitect: '...',
-    defaultCritic: '...',
-  },
-  executor: myExecutor,
-  watcher,
-});
-
-const results = await engine.orchestrate();
+import {
+  createSynthEngine,
+  HttpWatcherClient,
+  loadSynthConfig,
+} from '@karmaniverous/jeeves-meta';
+
+const config = loadSynthConfig('/path/to/jeeves-meta.config.json');
+const watcher = new HttpWatcherClient({ baseUrl: config.watcherUrl });
+
+const engine = createSynthEngine(config, myExecutor, watcher);
+const results = await engine.synthesize();
 ```
 
-## Documentation
+### CLI usage
 
-Full docs, guides, and API reference:
+```bash
+export JEEVES_META_CONFIG=/path/to/jeeves-meta.config.json
+
+npx @karmaniverous/jeeves-meta status       # summary stats
+npx @karmaniverous/jeeves-meta list         # list all metas
+npx @karmaniverous/jeeves-meta synthesize   # run synthesis cycle
+npx @karmaniverous/jeeves-meta help         # all commands
+```
+
+## Documentation
 
-**[docs.karmanivero.us/jeeves-meta](https://docs.karmanivero.us/jeeves-meta)**
+- **[Engine Guides](guides/index.md)** — concepts, configuration, orchestration, scheduling, architecture patterns
+- **[CLI Reference](guides/cli.md)** — all 10 commands with examples
 
 ## License