@luzhuohuan-bd/openclaw-otel-plugin-cli 0.1.0

package/index.js

@@ -0,0 +1,237 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import inquirer from "inquirer";
+import { execSync } from "node:child_process";
+import fs from "node:fs/promises";
+import path from "node:path";
+import os from "node:os";
+
+const PLUGIN_ID = "openclaw-otel-plugin";
+const NPM_PACKAGE = "@luzhuohuan-bd/openclaw-otel-plugin";
+
+// ─── Helpers ──────────────────────────────────────────────
+
+function getConfigPath() {
+  const stateDir = process.env.OPENCLAW_STATE_DIR || path.join(os.homedir(), ".openclaw");
+  return path.join(stateDir, "openclaw.json");
+}
+
+async function readConfig() {
+  try {
+    return JSON.parse(await fs.readFile(getConfigPath(), "utf8"));
+  } catch (e) {
+    if (e.code === "ENOENT") return {};
+    throw e;
+  }
+}
+
+async function writeConfig(config) {
+  const p = getConfigPath();
+  await fs.mkdir(path.dirname(p), { recursive: true });
+  await fs.writeFile(p, JSON.stringify(config, null, 2), "utf8");
+}
+
+function run(cmd) {
+  execSync(cmd, { stdio: "inherit" });
+}
+
+function runQuiet(cmd) {
+  return execSync(cmd, { encoding: "utf8" }).trim();
+}
+
+function platformCmd(cmd) {
+  return process.platform === "win32" ? `${cmd}.cmd` : cmd;
+}
+
+// ─── Collect config ───────────────────────────────────────
+
+async function collectConfig(opts) {
+  const config = await readConfig();
+  const existing = config.plugins?.entries?.[PLUGIN_ID]?.config || {};
+
+  if (opts.nonInteractive) {
+    return {
+      endpoint: opts.endpoint || existing.endpoint || "http://localhost:4318",
+      token: opts.token || "",
+      headers: opts.token
+        ? { Authorization: `Bearer ${opts.token}` }
+        : existing.headers || {},
+      debug: opts.debug ?? existing.debug ?? false,
+      allowDetail: opts.allowDetail ?? existing.allowUserDetailInfoReport ?? false,
+    };
+  }
+
+  const answers = await inquirer.prompt([
+    {
+      name: "endpoint",
+      type: "input",
+      message: "OTLP endpoint URL:",
+      default: opts.endpoint || existing.endpoint || "http://localhost:4318",
+      validate: (v) => (v && v.trim() ? true : "Endpoint cannot be empty"),
+    },
+    {
+      name: "needAuth",
+      type: "confirm",
+      message: "Need Bearer token authentication?",
+      default: !!existing.headers?.Authorization,
+    },
+    {
+      name: "token",
+      type: "input",
+      message: "Bearer token:",
+      when: (a) => a.needAuth,
+      default: opts.token || existing.headers?.Authorization?.replace(/^Bearer\s+/i, "") || "",
+      validate: (v) => (v && v.trim() ? true : "Token cannot be empty"),
+    },
+    {
+      name: "extraHeaders",
+      type: "input",
+      message: "Extra headers (key:value,key:value) or leave empty:",
+      default: "",
+    },
+    {
+      name: "debug",
+      type: "confirm",
+      message: "Enable debug logging?",
+      default: opts.debug ?? existing.debug ?? false,
+    },
+    {
+      name: "allowDetail",
+      type: "confirm",
+      message: "Report message content in spans/logs? (privacy sensitive)",
+      default: opts.allowDetail ?? existing.allowUserDetailInfoReport ?? false,
+    },
+  ]);
+
+  const headers = {};
+  if (answers.needAuth && answers.token) {
+    headers.Authorization = `Bearer ${answers.token.trim()}`;
+  }
+  if (answers.extraHeaders) {
+    for (const pair of answers.extraHeaders.split(",")) {
+      const [k, ...v] = pair.split(":");
+      if (k && v.length) headers[k.trim()] = v.join(":").trim();
+    }
+  }
+
+  return {
+    endpoint: answers.endpoint.trim(),
+    headers,
+    debug: answers.debug,
+    allowDetail: answers.allowDetail,
+  };
+}
+
+// ─── Update openclaw.json ─────────────────────────────────
+
+async function updateConfig(pluginConfig) {
+  const config = await readConfig();
+
+  // plugins.allow
+  if (!config.plugins) config.plugins = {};
+  if (!config.plugins.allow) config.plugins.allow = [];
+  if (!config.plugins.allow.includes(PLUGIN_ID)) {
+    config.plugins.allow.push(PLUGIN_ID);
+  }
+
+  // plugins.entries
+  if (!config.plugins.entries) config.plugins.entries = {};
+  const entry = config.plugins.entries[PLUGIN_ID] || {};
+  entry.enabled = true;
+  entry.config = {
+    ...(entry.config || {}),
+    endpoint: pluginConfig.endpoint,
+    headers: Object.keys(pluginConfig.headers).length ? pluginConfig.headers : undefined,
+    debug: pluginConfig.debug,
+    allowUserDetailInfoReport: pluginConfig.allowDetail,
+    traces: true,
+    metrics: true,
+    logs: true,
+  };
+  // Clean undefined
+  Object.keys(entry.config).forEach((k) => entry.config[k] === undefined && delete entry.config[k]);
+  config.plugins.entries[PLUGIN_ID] = entry;
+
+  await writeConfig(config);
+}
+
+// ─── Commands ─────────────────────────────────────────────
+
+async function handleInstall(opts) {
+  // Check openclaw CLI
+  const oc = platformCmd("openclaw");
+  try {
+    runQuiet(`${oc} --version`);
+  } catch {
+    console.error("Error: openclaw CLI not found. Please install openclaw first.");
+    process.exit(1);
+  }
+
+  console.log(`\n  openclaw-otel-plugin installer\n`);
+
+  const pluginConfig = await collectConfig(opts);
+
+  // Install plugin
+  console.log(`\nInstalling ${NPM_PACKAGE}...`);
+  try {
+    run(`${oc} plugins install ${NPM_PACKAGE}`);
+  } catch {
+    console.error(`Failed to install ${NPM_PACKAGE}. Check your network or npm registry.`);
+    process.exit(1);
+  }
+
+  // Write config
+  await updateConfig(pluginConfig);
+  console.log("Configuration saved.");
+
+  // Restart
+  try {
+    console.log("Restarting OpenClaw gateway...");
+    run(`${oc} gateway restart`);
+  } catch {
+    console.log("Gateway restart failed. Run `openclaw gateway restart` manually.");
+  }
+
+  console.log(`\n  Done! Plugin enabled with endpoint: ${pluginConfig.endpoint}\n`);
+}
+
+async function handleConfig(opts) {
+  const pluginConfig = await collectConfig(opts);
+  await updateConfig(pluginConfig);
+  console.log("Configuration updated.");
+
+  try {
+    run(`${platformCmd("openclaw")} gateway restart`);
+    console.log("Gateway restarted.");
+  } catch {
+    console.log("Run `openclaw gateway restart` to apply changes.");
+  }
+}
+
+// ─── CLI ──────────────────────────────────────────────────
+
+const program = new Command();
+program.name("openclaw-otel-plugin-cli").version("1.0.0");
+
+program
+  .command("install", { isDefault: true })
+  .description("Install and configure openclaw-otel-plugin")
+  .option("--endpoint <url>", "OTLP endpoint URL")
+  .option("--token <token>", "Bearer token for authentication")
+  .option("--debug", "Enable debug logging")
+  .option("--allow-detail", "Report message content (privacy sensitive)")
+  .option("--non-interactive", "Run without prompts (requires --endpoint)")
+  .action(handleInstall);
+
+program
+  .command("config")
+  .description("Update plugin configuration (without reinstalling)")
+  .option("--endpoint <url>", "OTLP endpoint URL")
+  .option("--token <token>", "Bearer token")
+  .option("--debug", "Enable debug logging")
+  .option("--allow-detail", "Report message content")
+  .option("--non-interactive", "Run without prompts")
+  .action(handleConfig);
+
+program.parse();

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@luzhuohuan-bd/openclaw-otel-plugin-cli",
+  "version": "0.1.0",
+  "description": "One-click installer for @luzhuohuan-bd/openclaw-otel-plugin",
+  "type": "module",
+  "files": ["index.js"],
+  "bin": {
+    "openclaw-otel-plugin-cli": "./index.js"
+  },
+  "dependencies": {
+    "commander": "^12.0.0",
+    "inquirer": "^9.2.0"
+  }
+}