@karmaniverous/jeeves-meta-openclaw 0.1.0

package/README.md

@@ -0,0 +1,50 @@
+# @karmaniverous/jeeves-meta-openclaw
+
+OpenClaw plugin for [jeeves-meta](../lib/). Registers synthesis tools and virtual inference rules with the OpenClaw gateway.
+
+## Features
+
+- **Four interactive tools** — `synth_list`, `synth_detail`, `synth_trigger`, `synth_preview`
+- **GatewayExecutor** — spawns LLM sessions via the OpenClaw gateway HTTP API (included in core lib)
+- **Virtual inference rules** — registers Qdrant indexing rules for `.meta/meta.json` files, archive snapshots, and config
+- **TOOLS.md injection** — dynamic system prompt with entity stats and tool listing
+- **Consumer skill** — `SKILL.md` for agent integration
+
+## Install
+
+```bash
+npm install @karmaniverous/jeeves-meta-openclaw
+```
+
+Then run the CLI installer to register with the OpenClaw gateway:
+
+```bash
+npx @karmaniverous/jeeves-meta-openclaw install
+```
+
+## Configuration
+
+The plugin reads its config path from the plugin `configPath` setting in `openclaw.json`. The config file itself is a standard `SynthConfig` JSON:
+
+```json
+{
+  "watchPaths": ["j:/domains"],
+  "watcherUrl": "http://localhost:1936",
+  "gatewayUrl": "http://127.0.0.1:3000",
+  "defaultArchitect": "@file:jeeves-meta/prompts/architect.md",
+  "defaultCritic": "@file:jeeves-meta/prompts/critic.md"
+}
+```
+
+See the [Configuration Guide](../lib/guides/configuration.md) for all fields and defaults.
+
+## Documentation
+
+- **[Plugin Setup](guides/plugin-setup.md)** — installation, config, lifecycle
+- **[Tools Reference](guides/tools-reference.md)** — synth_list, synth_detail, synth_trigger, synth_preview
+- **[Virtual Rules](guides/virtual-rules.md)** — Qdrant inference rules
+- **[TOOLS.md Injection](guides/tools-injection.md)** — dynamic prompt generation
+
+## License
+
+BSD-3-Clause

package/dist/cli.js

@@ -0,0 +1,239 @@
+#!/usr/bin/env node
+import { existsSync, rmSync, mkdirSync, cpSync, readFileSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { join, dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+/**
+ * CLI for installing/uninstalling the jeeves-meta OpenClaw plugin.
+ *
+ * Usage:
+ *   npx \@karmaniverous/jeeves-meta-openclaw install
+ *   npx \@karmaniverous/jeeves-meta-openclaw uninstall
+ *
+ * Bypasses OpenClaw's `plugins install` command, which has a known
+ * spawn EINVAL bug on Windows (https://github.com/openclaw/openclaw/issues/9224).
+ *
+ * Supports non-default installations via:
+ *   - OPENCLAW_CONFIG env var (path to openclaw.json)
+ *   - OPENCLAW_HOME env var (path to .openclaw directory)
+ *   - Default: ~/.openclaw/openclaw.json
+ *
+ * @module cli
+ */
+const PLUGIN_ID = 'jeeves-meta-openclaw';
+/** Resolve the OpenClaw home directory. */
+function resolveOpenClawHome() {
+    if (process.env.OPENCLAW_CONFIG) {
+        return dirname(resolve(process.env.OPENCLAW_CONFIG));
+    }
+    if (process.env.OPENCLAW_HOME) {
+        return resolve(process.env.OPENCLAW_HOME);
+    }
+    return join(homedir(), '.openclaw');
+}
+/** Resolve the config file path. */
+function resolveConfigPath(home) {
+    if (process.env.OPENCLAW_CONFIG) {
+        return resolve(process.env.OPENCLAW_CONFIG);
+    }
+    return join(home, 'openclaw.json');
+}
+/** Get the package root (where this CLI lives). */
+function getPackageRoot() {
+    const thisFile = fileURLToPath(import.meta.url);
+    return resolve(dirname(thisFile), '..');
+}
+/** Read and parse JSON, returning null on failure. */
+function readJson(path) {
+    try {
+        return JSON.parse(readFileSync(path, 'utf8'));
+    }
+    catch {
+        return null;
+    }
+}
+/** Write JSON with 2-space indent + trailing newline. */
+function writeJson(path, data) {
+    writeFileSync(path, JSON.stringify(data, null, 2) + '\n');
+}
+/**
+ * Patch an allowlist array: add or remove the plugin ID.
+ * Returns a log message if a change was made, or undefined.
+ */
+function patchAllowList(parent, key, label, mode) {
+    if (!Array.isArray(parent[key]) || parent[key].length === 0)
+        return undefined;
+    const list = parent[key];
+    if (mode === 'add') {
+        if (!list.includes(PLUGIN_ID)) {
+            list.push(PLUGIN_ID);
+            return `Added "${PLUGIN_ID}" to ${label}`;
+        }
+    }
+    else {
+        const filtered = list.filter((id) => id !== PLUGIN_ID);
+        if (filtered.length !== list.length) {
+            parent[key] = filtered;
+            return `Removed "${PLUGIN_ID}" from ${label}`;
+        }
+    }
+    return undefined;
+}
+/** Patch OpenClaw config for install or uninstall. Returns log messages. */
+function patchConfig(config, mode) {
+    const messages = [];
+    // Ensure plugins section
+    if (!config.plugins || typeof config.plugins !== 'object') {
+        config.plugins = {};
+    }
+    const plugins = config.plugins;
+    // plugins.allow
+    const pluginAllow = patchAllowList(plugins, 'allow', 'plugins.allow', mode);
+    if (pluginAllow)
+        messages.push(pluginAllow);
+    // plugins.entries
+    if (!plugins.entries || typeof plugins.entries !== 'object') {
+        plugins.entries = {};
+    }
+    const entries = plugins.entries;
+    if (mode === 'add') {
+        if (!entries[PLUGIN_ID]) {
+            entries[PLUGIN_ID] = { enabled: true };
+            messages.push(`Added "${PLUGIN_ID}" to plugins.entries`);
+        }
+    }
+    else if (PLUGIN_ID in entries) {
+        Reflect.deleteProperty(entries, PLUGIN_ID);
+        messages.push(`Removed "${PLUGIN_ID}" from plugins.entries`);
+    }
+    // tools.allow
+    const tools = (config.tools ?? {});
+    const toolAllow = patchAllowList(tools, 'allow', 'tools.allow', mode);
+    if (toolAllow)
+        messages.push(toolAllow);
+    return messages;
+}
+/** Install the plugin into OpenClaw's extensions directory. */
+function install() {
+    const home = resolveOpenClawHome();
+    const configPath = resolveConfigPath(home);
+    const extDir = join(home, 'extensions', PLUGIN_ID);
+    const pkgRoot = getPackageRoot();
+    console.log(`OpenClaw home:  ${home}`);
+    console.log(`Config:         ${configPath}`);
+    console.log(`Extensions dir: ${extDir}`);
+    console.log(`Package root:   ${pkgRoot}`);
+    console.log();
+    if (!existsSync(home)) {
+        console.error(`Error: OpenClaw home directory not found at ${home}`);
+        console.error('Set OPENCLAW_HOME or OPENCLAW_CONFIG if using a non-default installation.');
+        process.exit(1);
+    }
+    if (!existsSync(configPath)) {
+        console.error(`Error: OpenClaw config not found at ${configPath}`);
+        console.error('Set OPENCLAW_CONFIG if using a non-default config location.');
+        process.exit(1);
+    }
+    const pluginManifestPath = join(pkgRoot, 'openclaw.plugin.json');
+    if (!existsSync(pluginManifestPath)) {
+        console.error(`Error: openclaw.plugin.json not found at ${pluginManifestPath}`);
+        process.exit(1);
+    }
+    // Copy package to extensions directory
+    console.log('Copying plugin to extensions directory...');
+    if (existsSync(extDir)) {
+        rmSync(extDir, { recursive: true, force: true });
+    }
+    mkdirSync(extDir, { recursive: true });
+    for (const file of ['dist', 'openclaw.plugin.json', 'package.json']) {
+        const src = join(pkgRoot, file);
+        const dest = join(extDir, file);
+        if (existsSync(src)) {
+            cpSync(src, dest, { recursive: true });
+            console.log(`  \u2713 ${file}`);
+        }
+    }
+    const nodeModulesSrc = join(pkgRoot, 'node_modules');
+    if (existsSync(nodeModulesSrc)) {
+        cpSync(nodeModulesSrc, join(extDir, 'node_modules'), { recursive: true });
+        console.log('  \u2713 node_modules');
+    }
+    // Patch config
+    console.log();
+    console.log('Patching OpenClaw config...');
+    const config = readJson(configPath);
+    if (!config) {
+        console.error(`Error: Could not parse ${configPath}`);
+        process.exit(1);
+    }
+    for (const msg of patchConfig(config, 'add')) {
+        console.log(`  \u2713 ${msg}`);
+    }
+    writeJson(configPath, config);
+    console.log();
+    console.log('\u2705 Plugin installed successfully.');
+    console.log('   Restart the OpenClaw gateway to load the plugin.');
+}
+/** Uninstall the plugin from OpenClaw's extensions directory. */
+function uninstall() {
+    const home = resolveOpenClawHome();
+    const configPath = resolveConfigPath(home);
+    const extDir = join(home, 'extensions', PLUGIN_ID);
+    console.log(`OpenClaw home:  ${home}`);
+    console.log(`Config:         ${configPath}`);
+    console.log(`Extensions dir: ${extDir}`);
+    console.log();
+    if (existsSync(extDir)) {
+        rmSync(extDir, { recursive: true, force: true });
+        console.log(`\u2713 Removed ${extDir}`);
+    }
+    else {
+        console.log('  (extensions directory not found, skipping)');
+    }
+    if (existsSync(configPath)) {
+        console.log('Patching OpenClaw config...');
+        const config = readJson(configPath);
+        if (config) {
+            for (const msg of patchConfig(config, 'remove')) {
+                console.log(`  \u2713 ${msg}`);
+            }
+            writeJson(configPath, config);
+        }
+    }
+    console.log();
+    console.log('\u2705 Plugin uninstalled successfully.');
+    console.log('   Restart the OpenClaw gateway to complete removal.');
+}
+// Main
+const command = process.argv[2];
+switch (command) {
+    case 'install':
+        install();
+        break;
+    case 'uninstall':
+        uninstall();
+        break;
+    default:
+        console.log(`@karmaniverous/jeeves-meta-openclaw \u2014 OpenClaw plugin installer`);
+        console.log();
+        console.log('Usage:');
+        console.log('  npx @karmaniverous/jeeves-meta-openclaw install    Install plugin');
+        console.log('  npx @karmaniverous/jeeves-meta-openclaw uninstall  Remove plugin');
+        console.log();
+        console.log('Environment variables:');
+        console.log('  OPENCLAW_CONFIG  Path to openclaw.json (overrides all)');
+        console.log('  OPENCLAW_HOME    Path to .openclaw directory');
+        console.log();
+        console.log('Default: ~/.openclaw/openclaw.json');
+        if (command &&
+            command !== 'help' &&
+            command !== '--help' &&
+            command !== '-h') {
+            console.error(`\nUnknown command: ${command}`);
+            process.exit(1);
+        }
+        break;
+}
+
+export { patchConfig };