@karmaniverous/jeeves-server-openclaw 0.3.0 → 0.3.1

package/README.md

@@ -1,6 +1,8 @@
 # @karmaniverous/jeeves-server-openclaw
 
-OpenClaw plugin for Jeeves Server. Provides agents with tools for:
+OpenClaw plugin for Jeeves Server. Integrates with `@karmaniverous/jeeves` core for managed TOOLS.md writing, service lifecycle commands, and platform content maintenance.
+
+Provides agents with tools for:
 
 - Server status and capabilities
 - File/directory metadata browsing
@@ -35,7 +37,8 @@ Add an unscoped `_plugin` key to your Jeeves Server config:
         "enabled": true,
         "config": {
           "apiUrl": "http://127.0.0.1:1934",
-          "pluginKey": "<same-seed-as-server-_plugin>"
+          "pluginKey": "<same-seed-as-server-_plugin>",
+          "configRoot": "j:/config"
         }
       }
     }
@@ -43,7 +46,13 @@ Add an unscoped `_plugin` key to your Jeeves Server config:
 }
 ```
 
+| Config | Default | Description |
+|--------|---------|-------------|
+| `apiUrl` | `http://127.0.0.1:1934` | Server API base URL |
+| `pluginKey` | — | Server `_plugin` key seed |
+| `configRoot` | `j:/config` | Platform config root (core derives component config dirs) |
+
 ## Docs
 
-- OpenClaw Integration: ./guides/openclaw-integration.md
+- [OpenClaw Integration](./guides/openclaw-integration.md) — Full configuration, tool reference, architecture
 

package/dist/cli.js

@@ -1,43 +1,25 @@
 #!/usr/bin/env node
-import { existsSync, rmSync, mkdirSync, cpSync, readFileSync, writeFileSync } from 'fs';
-import { homedir } from 'os';
-import { join, dirname, resolve } from 'path';
+import { existsSync as existsSync$1, rmSync as rmSync$1, mkdirSync, cpSync, readFileSync as readFileSync$1, writeFileSync as writeFileSync$1 } from 'fs';
+import { homedir as homedir$1 } from 'os';
+import { join as join$1, resolve as resolve$1, dirname as dirname$1 } from 'path';
 import { fileURLToPath } from 'url';
+import { homedir } from 'node:os';
+import { dirname, resolve, join } from 'node:path';
+import { existsSync, rmSync, readFileSync, writeFileSync } from 'node:fs';
 
 /**
- * CLI for installing/uninstalling the jeeves-server OpenClaw plugin.
- *
- * Usage:
- *   npx \@karmaniverous/jeeves-server-openclaw install
- *   npx \@karmaniverous/jeeves-server-openclaw uninstall
+ * Shared constants for the jeeves-server OpenClaw plugin.
  */
+/** Plugin identifier used in OpenClaw config and extension paths. */
 const PLUGIN_ID = 'jeeves-server-openclaw';
-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');
-}
-function resolveConfigPath(home) {
-    if (process.env.OPENCLAW_CONFIG)
-        return resolve(process.env.OPENCLAW_CONFIG);
-    return join(home, 'openclaw.json');
-}
-function getPackageRoot() {
-    return resolve(dirname(fileURLToPath(import.meta.url)), '..');
-}
-function readJson(p) {
-    try {
-        return JSON.parse(readFileSync(p, 'utf8'));
-    }
-    catch {
-        return null;
-    }
-}
-function writeJson(p, data) {
-    writeFileSync(p, JSON.stringify(data, null, 2) + '\n');
-}
+
+/**
+ * OpenClaw config patching utilities.
+ *
+ * @remarks
+ * Shared by both the `npx ... install|uninstall` CLI and by in-process
+ * plugin commands.
+ */
 function patchAllowList(parent, key, label, mode) {
     if (!Array.isArray(parent[key]) || parent[key].length === 0)
         return undefined;
@@ -86,39 +68,119 @@ function patchConfig(config, mode) {
         messages.push(toolAllow);
     return messages;
 }
+
+/**
+ * OpenClaw home and config path resolution.
+ *
+ * @remarks
+ * Shared by the CLI installer and the in-process plugin commands.
+ */
+/**
+ * Resolve the OpenClaw home directory from environment or default.
+ */
+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 OpenClaw config file path from environment or default.
+ */
+function resolveConfigPath(home) {
+    if (process.env.OPENCLAW_CONFIG)
+        return resolve(process.env.OPENCLAW_CONFIG);
+    return join(home, 'openclaw.json');
+}
+
+/**
+ * Shared plugin removal logic for extension directory and config cleanup.
+ *
+ * @remarks
+ * Used by both the CLI `uninstall` command and the in-process
+ * `PluginCommands.uninstall()` implementation.
+ */
+/**
+ * Remove the plugin extension directory and patch the OpenClaw config.
+ *
+ * @param home - OpenClaw home directory path.
+ * @param configPath - OpenClaw config file path.
+ * @returns Messages describing what was changed.
+ */
+function removePlugin(home, configPath) {
+    const messages = [];
+    const extDir = join(home, 'extensions', PLUGIN_ID);
+    if (existsSync(extDir)) {
+        rmSync(extDir, { recursive: true, force: true });
+        messages.push('Removed ' + extDir);
+    }
+    if (existsSync(configPath)) {
+        const raw = readFileSync(configPath, 'utf8');
+        const config = JSON.parse(raw);
+        const patchMessages = patchConfig(config, 'remove');
+        if (patchMessages.length > 0) {
+            writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n');
+            messages.push(...patchMessages);
+        }
+    }
+    return messages;
+}
+
+/**
+ * CLI for installing/uninstalling the jeeves-server OpenClaw plugin.
+ *
+ * Usage:
+ *   npx \@karmaniverous/jeeves-server-openclaw install
+ *   npx \@karmaniverous/jeeves-server-openclaw uninstall
+ */
+function getPackageRoot() {
+    return resolve$1(dirname$1(fileURLToPath(import.meta.url)), '..');
+}
+function readJson(p) {
+    try {
+        return JSON.parse(readFileSync$1(p, 'utf8'));
+    }
+    catch {
+        return null;
+    }
+}
+function writeJson(p, data) {
+    writeFileSync$1(p, JSON.stringify(data, null, 2) + '\n');
+}
 function install() {
     const home = resolveOpenClawHome();
     const configPath = resolveConfigPath(home);
-    const extDir = join(home, 'extensions', PLUGIN_ID);
+    const extDir = join$1(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)) {
+    if (!existsSync$1(home)) {
         console.error('Error: OpenClaw home not found at ' + home);
         process.exit(1);
     }
-    if (!existsSync(configPath)) {
+    if (!existsSync$1(configPath)) {
         console.error('Error: OpenClaw config not found at ' + configPath);
         process.exit(1);
     }
     console.log('Copying plugin to extensions directory...');
-    if (existsSync(extDir))
-        rmSync(extDir, { recursive: true, force: true });
+    if (existsSync$1(extDir))
+        rmSync$1(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)) {
+        const src = join$1(pkgRoot, file);
+        const dest = join$1(extDir, file);
+        if (existsSync$1(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 });
+    const nodeModulesSrc = join$1(pkgRoot, 'node_modules');
+    if (existsSync$1(nodeModulesSrc)) {
+        cpSync(nodeModulesSrc, join$1(extDir, 'node_modules'), { recursive: true });
         console.log('  \u2713 node_modules');
     }
     console.log();
@@ -138,26 +200,12 @@ function install() {
 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);
-        }
-    }
+    const messages = removePlugin(home, configPath);
+    for (const msg of messages)
+        console.log('  \u2713 ' + msg);
     // Clean up TOOLS.md server section
     cleanupToolsMd(home, configPath);
     console.log();
@@ -172,23 +220,23 @@ function resolveWorkspaceDir(home, configPath) {
     const defaults = agents?.defaults;
     const workspace = defaults?.workspace;
     if (workspace)
-        return resolve(workspace.replace(/^~/, homedir()));
-    return join(home, 'workspace');
+        return resolve$1(workspace.replace(/^~/, homedir$1()));
+    return join$1(home, 'workspace');
 }
 function cleanupToolsMd(home, configPath) {
     const workspaceDir = resolveWorkspaceDir(home, configPath);
     if (!workspaceDir)
         return;
-    const toolsPath = join(workspaceDir, 'TOOLS.md');
-    if (!existsSync(toolsPath))
+    const toolsPath = join$1(workspaceDir, 'TOOLS.md');
+    if (!existsSync$1(toolsPath))
         return;
-    let content = readFileSync(toolsPath, 'utf8');
+    let content = readFileSync$1(toolsPath, 'utf8');
     const serverRe = /^## Server\n[\s\S]*?(?=\n## |\n# |$(?![\s\S]))/m;
     if (!serverRe.test(content))
         return;
     content = content.replace(serverRe, '').replace(/\n{3,}/g, '\n\n');
     content = content.trim() + '\n';
-    writeFileSync(toolsPath, content);
+    writeFileSync$1(toolsPath, content);
     console.log('\u2713 Cleaned up TOOLS.md (removed Server section)');
 }
 const command = process.argv[2];
@@ -218,5 +266,3 @@ switch (command) {
         }
         break;
 }
-
-export { patchConfig };