openclaw-agent-dashboard 1.0.4

package/scripts/install-plugin.sh

@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+#
+# OpenClaw Agent Dashboard 插件 - 安装/升级脚本
+# 用法: npm run deploy（推荐）或 ./scripts/install-plugin.sh
+#
+# 选项:
+#   VERBOSE=1   显示详细输出（包括 npm/pip 的错误信息）
+#   DRY_RUN=1   仅预览，不执行实际安装
+#
+# 配置目录与 OpenClaw 一致：OPENCLAW_STATE_DIR > OPENCLAW_HOME > HOME
+#
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+ROOT=$(pwd)
+SCRIPT_DIR="$ROOT/scripts"
+
+# 引入公共库
+source "$SCRIPT_DIR/lib/common.sh"
+
+# 环境变量
+VERBOSE="${VERBOSE:-0}"
+DRY_RUN="${DRY_RUN:-0}"
+
+# ============================================
+# 本脚本特有函数
+# ============================================
+
+# 获取已安装版本
+get_installed_version() {
+  local plugin_path="$1"
+  if [ -f "$plugin_path/openclaw.plugin.json" ]; then
+    parse_json_version "$plugin_path/openclaw.plugin.json"
+  else
+    echo ""
+  fi
+}
+
+# 检查命令是否存在
+check_cmd() {
+  if ! command -v "$1" &>/dev/null; then
+    log_error "未找到 $1，请先安装: $2"
+    exit 1
+  fi
+}
+
+# ============================================
+# 主流程
+# ============================================
+
+OPENCLAW_CONFIG_DIR=$(resolve_openclaw_config_dir)
+PLUGIN_PATH="${OPENCLAW_CONFIG_DIR}/extensions/openclaw-agent-dashboard"
+NEW_VERSION=$(parse_json_version "$ROOT/plugin/openclaw.plugin.json")
+OLD_VERSION=$(get_installed_version "$PLUGIN_PATH")
+
+log_info "[安装] 配置目录: $OPENCLAW_CONFIG_DIR"
+log_info "[安装] 插件路径: $PLUGIN_PATH"
+echo ""
+
+# 显示标题（区分安装/升级）
+if [ -n "$OLD_VERSION" ] && [ -d "$PLUGIN_PATH" ]; then
+  log_info "=== OpenClaw Agent Dashboard 插件升级 ==="
+  echo ""
+  log_info "  $OLD_VERSION → $NEW_VERSION"
+else
+  log_info "=== OpenClaw Agent Dashboard 插件安装 ==="
+  echo ""
+  log_info "  版本: $NEW_VERSION"
+fi
+
+# dry-run 模式：仅预览
+if [ "$DRY_RUN" = "1" ]; then
+  echo ""
+  log_info "[DRY-RUN] 将执行以下操作:"
+  log_info "  - 安装插件到: $PLUGIN_PATH"
+  log_info "  - 安装 Python 依赖到 venv 或 --user"
+  log_ok "预览完成，未执行实际安装"
+  exit 0
+fi
+
+# 1. 检查前置条件
+check_cmd node "https://nodejs.org"
+check_cmd python3 "https://www.python.org"
+check_cmd openclaw "npm install -g openclaw"
+
+echo ""
+log_ok "前置条件检查通过"
+
+# 2. 构建前端（若通过 npm run deploy 调用，pack 已构建，跳过）
+if [ -d "$ROOT/frontend/dist" ] && [ -n "$(ls -A "$ROOT/frontend/dist" 2>/dev/null)" ]; then
+  log_step "1/4 前端已构建，跳过"
+else
+  log_step "1/4 构建前端..."
+  (cd frontend && run_silent npm install && npm run build)
+fi
+
+# 3. 打包插件（若通过 npm run deploy 调用，pack 已完成，跳过）
+if [ -d "$ROOT/plugin/dashboard" ] && [ -f "$ROOT/plugin/dashboard/main.py" ]; then
+  log_step "2/4 插件已打包，跳过"
+else
+  log_step "2/4 打包插件..."
+  node scripts/build-plugin.js
+fi
+
+# 4. 安装插件（升级时用 uninstall 清理配置+目录，避免 plugins.allow 引用已删目录导致校验失败）
+PLUGIN_ID="openclaw-agent-dashboard"
+if [ -d "$PLUGIN_PATH" ]; then
+  log_step "3/4 移除旧版本后安装..."
+  log_info "    执行: openclaw plugins uninstall $PLUGIN_ID"
+  if run_silent openclaw plugins uninstall "$PLUGIN_ID" --force; then
+    log_ok "    已卸载（配置记录）"
+  else
+    log_warn "    uninstall 失败（可能未注册）"
+  fi
+  # uninstall 只删除配置记录，需要手动删除物理目录
+  rm -rf "$PLUGIN_PATH"
+  log_ok "    已删除旧目录"
+else
+  log_step "3/4 安装插件..."
+fi
+log_info "    目标: $PLUGIN_PATH"
+log_info "    执行: openclaw plugins install ./plugin"
+if ! openclaw plugins install ./plugin; then
+  log_error "插件安装失败"
+  exit 1
+fi
+log_ok "    插件已安装"
+
+# 5. 安装 Python 依赖
+# 详见 docs/python-environment-compatibility.md
+if [ -f "$PLUGIN_PATH/dashboard/requirements.txt" ]; then
+  if [ -n "$OLD_VERSION" ]; then
+    log_step "4/4 检查 Python 依赖..."
+  else
+    log_step "4/4 安装 Python 依赖..."
+  fi
+
+  # 调用独立的 Python 依赖安装脚本
+  DEPS_OPTS=""
+  [ "$VERBOSE" = "1" ] && DEPS_OPTS="--verbose"
+
+  if ! bash "$SCRIPT_DIR/install-python-deps.sh" "$PLUGIN_PATH" $DEPS_OPTS; then
+    exit 1
+  fi
+else
+  log_warn "插件未正确安装（缺少 requirements.txt）"
+fi
+
+# 完成
+echo ""
+if [ -n "$OLD_VERSION" ]; then
+  log_ok "=== 升级完成 ($OLD_VERSION → $NEW_VERSION) ==="
+else
+  log_ok "=== 安装完成 (v$NEW_VERSION) ==="
+fi
+echo ""
+log_info "执行任意 openclaw 命令（如 openclaw tui）时，Dashboard 会自动启动。"
+log_info "访问地址: http://localhost:38271"
+echo ""
+log_info "若端口被占用，可创建 ~/.openclaw-agent-dashboard/config.json 设置端口:"
+log_info '  {"port": 38271}'
+echo ""

package/scripts/install-python-deps.js

@@ -0,0 +1,346 @@
+#!/usr/bin/env node
+/**
+ * Python 依赖安装脚本（跨平台）
+ * 用法: node scripts/install-python-deps.js <plugin_dir> [--verbose]
+ *
+ * 策略:
+ * 1. venv（推荐，不受 PEP 668 影响）
+ * 2. pip --user（兜底）
+ *
+ * 选项:
+ *   --verbose, -v    显示详细输出
+ *   --venv-only      仅使用 venv，不回退 pip
+ */
+
+const fs = require('fs');
+const path = require('path');
+const {
+  logInfo,
+  logOk,
+  logWarn,
+  logError,
+  detectOS,
+  commandExists,
+  runCommand,
+  rmrf,
+} = require('./lib/common');
+
+// ============================================
+// 参数解析
+// ============================================
+
+/**
+ * 解析命令行参数
+ * @returns {{ pluginDir: string | null, verbose: boolean, venvOnly: boolean }}
+ */
+function parseArgs() {
+  const args = process.argv.slice(2);
+  let pluginDir = null;
+  let verbose = false;
+  let venvOnly = false;
+
+  for (const arg of args) {
+    if (arg === '--verbose' || arg === '-v') {
+      verbose = true;
+    } else if (arg === '--venv-only') {
+      venvOnly = true;
+    } else if (!arg.startsWith('-')) {
+      pluginDir = arg;
+    }
+  }
+
+  return { pluginDir, verbose, venvOnly };
+}
+
+// ============================================
+// Python 环境检测
+// ============================================
+
+/**
+ * 检查 venv 模块是否可用
+ * @returns {boolean}
+ */
+function checkVenvModule() {
+  const result = runCommand('python3', ['-c', 'import venv'], { silent: true });
+  return result.success;
+}
+
+/**
+ * 检查 pip 模块是否可用
+ * @returns {boolean}
+ */
+function checkPipModule() {
+  // 尝试 python3 -m pip
+  let result = runCommand('python3', ['-m', 'pip', '--version'], { silent: true });
+  if (result.success) return true;
+
+  // 尝试 pip3
+  if (commandExists('pip3')) return true;
+
+  // 尝试 pip
+  if (commandExists('pip')) return true;
+
+  return false;
+}
+
+/**
+ * 获取 venv Python 路径
+ * @param {string} venvDir
+ * @returns {string | null}
+ */
+function getVenvPython(venvDir) {
+  // Unix: venv/bin/python
+  const unixPath = path.join(venvDir, 'bin', 'python');
+  if (fs.existsSync(unixPath)) return unixPath;
+
+  // Windows: venv\Scripts\python.exe
+  const winPath = path.join(venvDir, 'Scripts', 'python.exe');
+  if (fs.existsSync(winPath)) return winPath;
+
+  return null;
+}
+
+// ============================================
+// Python 依赖安装
+// ============================================
+
+/**
+ * 使用 venv 安装依赖
+ * @param {string} reqFile
+ * @param {string} venvDir
+ * @param {boolean} silent
+ * @returns {boolean}
+ */
+function installWithVenv(reqFile, venvDir, silent) {
+  logInfo('  尝试: venv（推荐，不受 PEP 668 影响）');
+
+  // 清理旧 venv
+  if (fs.existsSync(venvDir)) {
+    rmrf(venvDir);
+  }
+
+  // 创建 venv
+  logInfo('  创建虚拟环境...');
+  const createResult = runCommand('python3', ['-m', 'venv', venvDir], { silent });
+  if (!createResult.success) {
+    logWarn('  venv 创建失败');
+    if (!silent) {
+      console.log('    错误:', createResult.output);
+    }
+    return false;
+  }
+
+  // 获取 venv Python 路径
+  const venvPython = getVenvPython(venvDir);
+  if (!venvPython) {
+    logWarn('  无法找到 venv Python');
+    return false;
+  }
+
+  // 升级 pip（静默，失败不影响）
+  runCommand(venvPython, ['-m', 'pip', 'install', '--upgrade', 'pip', '-q'], { silent: true });
+
+  // 安装依赖
+  logInfo('  安装依赖...');
+  const installResult = runCommand(
+    venvPython,
+    ['-m', 'pip', 'install', '-r', reqFile, '-q'],
+    { silent, timeout: 180000 }
+  );
+
+  if (!installResult.success) {
+    logWarn('  venv 安装依赖失败');
+    if (!silent) {
+      console.log('    错误:', installResult.output);
+    }
+    return false;
+  }
+
+  return true;
+}
+
+/**
+ * 使用 pip --user 安装依赖
+ * @param {string} reqFile
+ * @param {boolean} silent
+ * @returns {{ success: boolean, method: string | null }}
+ */
+function installWithPipUser(reqFile, silent) {
+  logInfo('  尝试: pip --user（PEP 668 兜底）');
+
+  const pipCommands = [
+    { cmd: 'python3', args: ['-m', 'pip', 'install', '-r', reqFile, '-q', '--user'], name: 'python3 -m pip --user' },
+    { cmd: 'python3', args: ['-m', 'pip', 'install', '-r', reqFile, '-q'], name: 'python3 -m pip' },
+    { cmd: 'pip', args: ['install', '-r', reqFile, '-q', '--user'], name: 'pip --user' },
+    { cmd: 'pip3', args: ['install', '-r', reqFile, '-q', '--user'], name: 'pip3 --user' },
+  ];
+
+  for (const { cmd, args, name } of pipCommands) {
+    if (!commandExists(cmd)) continue;
+
+    const result = runCommand(cmd, args, { silent, timeout: 180000 });
+    if (result.success) {
+      return { success: true, method: name };
+    }
+  }
+
+  return { success: false, method: null };
+}
+
+/**
+ * 安装 Python 依赖
+ * @param {string} pluginDir
+ * @param {object} options
+ * @param {boolean} [options.verbose]
+ * @param {boolean} [options.venvOnly]
+ * @returns {boolean}
+ */
+function installPythonDeps(pluginDir, options = {}) {
+  const { verbose = false, venvOnly = false } = options;
+  const reqFile = path.join(pluginDir, 'dashboard', 'requirements.txt');
+  const venvDir = path.join(pluginDir, 'dashboard', '.venv');
+
+  // 检查 requirements.txt
+  if (!fs.existsSync(reqFile)) {
+    logWarn('未找到 requirements.txt');
+    return false;
+  }
+
+  const silent = !verbose;
+  let success = false;
+  let method = null;
+
+  // 策略 1: venv（推荐）
+  if (checkVenvModule()) {
+    if (installWithVenv(reqFile, venvDir, silent)) {
+      success = true;
+      method = 'venv';
+    }
+  } else {
+    logWarn('  venv 模块不可用');
+  }
+
+  // 策略 2: pip --user 兜底
+  if (!success && !venvOnly) {
+    const result = installWithPipUser(reqFile, silent);
+    if (result.success) {
+      success = true;
+      method = result.method;
+    }
+  }
+
+  // 结果
+  if (success) {
+    logOk(`Python 依赖已就绪 (${method})`);
+    return true;
+  } else {
+    logError('Python 依赖安装失败');
+    printPythonDepsHelp(reqFile);
+    return false;
+  }
+}
+
+// ============================================
+// 帮助信息
+// ============================================
+
+/**
+ * 打印 Python 依赖安装帮助
+ * @param {string} reqFile
+ */
+function printPythonDepsHelp(reqFile) {
+  const os = detectOS();
+
+  console.log('');
+  console.log('========================================');
+  console.log('请检查以下系统依赖是否已安装：');
+  console.log('========================================');
+  console.log('');
+
+  switch (os) {
+    case 'linux':
+      console.log('检测到 Linux 系统');
+      console.log('');
+      console.log('Debian/Ubuntu:');
+      console.log('  sudo apt update && sudo apt install python3 python3-pip python3-venv');
+      console.log('');
+      console.log('Fedora/CentOS/RHEL:');
+      console.log('  sudo dnf install python3 python3-pip');
+      console.log('');
+      break;
+
+    case 'macos':
+      console.log('检测到 macOS 系统');
+      console.log('');
+      console.log('使用 Homebrew:');
+      console.log('  brew install python3');
+      console.log('');
+      break;
+
+    case 'windows':
+      console.log('检测到 Windows 系统');
+      console.log('');
+      console.log('1. 从 https://www.python.org 下载安装 Python 3');
+      console.log('2. 安装时务必勾选 "Add Python to PATH"');
+      console.log('3. 安装完成后重新打开终端');
+      console.log('');
+      break;
+
+    default:
+      console.log('请确保已安装：');
+      console.log('  - Python 3');
+      console.log('  - pip (python3-pip)');
+      console.log('  - venv 模块 (python3-venv，Linux 通常需要单独安装)');
+      console.log('');
+  }
+
+  console.log('========================================');
+  console.log('安装系统依赖后，重新执行：');
+  console.log('========================================');
+  console.log('');
+  console.log('  npm run deploy');
+  console.log('');
+  console.log('或手动安装依赖：');
+  console.log('');
+  console.log(`  python3 -m pip install -r ${reqFile} --user`);
+  console.log('');
+  console.log('========================================');
+  console.log('调试模式：');
+  console.log('========================================');
+  console.log('');
+  console.log('  VERBOSE=1 npm run deploy');
+  console.log('');
+}
+
+// ============================================
+// 主函数
+// ============================================
+
+function main() {
+  const { pluginDir, verbose, venvOnly } = parseArgs();
+
+  // 检查参数
+  if (!pluginDir) {
+    console.log('用法: node scripts/install-python-deps.js <plugin_dir> [options]');
+    console.log('');
+    console.log('参数:');
+    console.log('  plugin_dir    插件安装目录 (必须)');
+    console.log('');
+    console.log('选项:');
+    console.log('  --verbose, -v  显示详细输出');
+    console.log('  --venv-only    仅使用 venv，不回退 pip');
+    process.exit(1);
+  }
+
+  // 检查目录
+  if (!fs.existsSync(pluginDir)) {
+    logError(`插件目录不存在: ${pluginDir}`);
+    process.exit(1);
+  }
+
+  // 执行安装
+  const success = installPythonDeps(pluginDir, { verbose, venvOnly });
+  process.exit(success ? 0 : 1);
+}
+
+main();