install.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  1. #!/usr/bin/env node
  2. /**
  3. * OpenClaw VOC Skills 一键部署脚本
  4. *
  5. * 功能:将 skills 文件夹中的所有技能部署到 OpenClaw 的 skills 目录
  6. * 兼容:Windows / macOS / Linux
  7. * 依赖:仅需 Node.js(OpenClaw 已自带)
  8. *
  9. * 使用方法:
  10. * node install.js # 部署所有技能
  11. * node install.js --list # 仅列出技能,不部署
  12. * node install.js --only a,b,c # 仅部署指定技能
  13. * node install.js --skip a,b,c # 跳过指定技能
  14. * node install.js --target /path # 指定目标目录(默认 ~/.openclaw/skills)
  15. * node install.js --clean # 部署前清空目标目录
  16. * node install.js --dry-run # 预览模式,不实际写入
  17. */
  18. const fs = require('fs');
  19. const path = require('path');
  20. const os = require('os');
  21. // ============================================
  22. // 配置
  23. // ============================================
  24. const VERSION = '1.0.0';
  25. const SKILLS_SUBDIR = 'skills'; // zip 包内的技能目录名
  26. const TOOLS_SUBDIR = 'tools';
  27. const WORKSPACE_BUNDLE_DIRS = ['douyin-speaking-daily'];
  28. // ============================================
  29. // 参数解析
  30. // ============================================
  31. function parseArgs() {
  32. const args = process.argv.slice(2);
  33. const opts = {
  34. list: false,
  35. only: [],
  36. skip: [],
  37. target: '',
  38. clean: false,
  39. dryRun: false,
  40. help: false
  41. };
  42. for (let i = 0; i < args.length; i++) {
  43. switch (args[i]) {
  44. case '--list':
  45. case '-l':
  46. opts.list = true;
  47. break;
  48. case '--only':
  49. opts.only = (args[++i] || '').split(',').filter(Boolean);
  50. break;
  51. case '--skip':
  52. opts.skip = (args[++i] || '').split(',').filter(Boolean);
  53. break;
  54. case '--target':
  55. case '-t':
  56. opts.target = args[++i] || '';
  57. break;
  58. case '--clean':
  59. opts.clean = true;
  60. break;
  61. case '--dry-run':
  62. opts.dryRun = true;
  63. break;
  64. case '--help':
  65. case '-h':
  66. opts.help = true;
  67. break;
  68. }
  69. }
  70. return opts;
  71. }
  72. // ============================================
  73. // 工具函数
  74. // ============================================
  75. function getOpenClawDir() {
  76. return path.join(os.homedir(), '.openclaw');
  77. }
  78. function getOpenClawSkillsDir() {
  79. return path.join(getOpenClawDir(), 'skills');
  80. }
  81. function getOpenClawToolsDir() {
  82. return path.join(getOpenClawDir(), 'tools');
  83. }
  84. function getOpenClawWorkspaceToolsDir() {
  85. return path.join(getOpenClawDir(), 'workspace', 'scripts', 'tools');
  86. }
  87. function getOpenClawWorkspaceDir() {
  88. return path.join(getOpenClawDir(), 'workspace');
  89. }
  90. function ensureDir(dir) {
  91. if (!fs.existsSync(dir)) {
  92. fs.mkdirSync(dir, { recursive: true });
  93. }
  94. }
  95. function copyFileSync(src, dest) {
  96. ensureDir(path.dirname(dest));
  97. fs.copyFileSync(src, dest);
  98. }
  99. function removeDir(dir) {
  100. if (fs.existsSync(dir)) {
  101. fs.rmSync(dir, { recursive: true, force: true });
  102. }
  103. }
  104. function getFileSize(filePath) {
  105. try {
  106. return fs.statSync(filePath).size;
  107. } catch {
  108. return 0;
  109. }
  110. }
  111. function formatSize(bytes) {
  112. if (bytes < 1024) return bytes + ' B';
  113. if (bytes < 1024 * 1024) return (bytes / 1024).toFixed(1) + ' KB';
  114. return (bytes / 1024 / 1024).toFixed(1) + ' MB';
  115. }
  116. // ============================================
  117. // 核心逻辑
  118. // ============================================
  119. function discoverSkills(sourceDir) {
  120. if (!fs.existsSync(sourceDir)) {
  121. return [];
  122. }
  123. return fs.readdirSync(sourceDir)
  124. .filter(name => {
  125. const fullPath = path.join(sourceDir, name);
  126. return fs.statSync(fullPath).isDirectory()
  127. && fs.existsSync(path.join(fullPath, 'SKILL.md'));
  128. })
  129. .map(name => {
  130. const skillDir = path.join(sourceDir, name);
  131. const files = [];
  132. let totalSize = 0;
  133. for (const fileName of fs.readdirSync(skillDir)) {
  134. const filePath = path.join(skillDir, fileName);
  135. if (fs.statSync(filePath).isFile()) {
  136. const size = getFileSize(filePath);
  137. files.push({ name: fileName, path: filePath, size });
  138. totalSize += size;
  139. }
  140. }
  141. return { name, dir: skillDir, files, totalSize };
  142. })
  143. .sort((a, b) => a.name.localeCompare(b.name));
  144. }
  145. function filterSkills(skills, opts) {
  146. let filtered = skills;
  147. if (opts.only.length > 0) {
  148. filtered = filtered.filter(s => opts.only.includes(s.name));
  149. }
  150. if (opts.skip.length > 0) {
  151. filtered = filtered.filter(s => !opts.skip.includes(s.name));
  152. }
  153. return filtered;
  154. }
  155. function showHelp() {
  156. console.log(`
  157. OpenClaw VOC Skills Installer v${VERSION}
  158. Usage:
  159. node install.js [options]
  160. Options:
  161. --list, -l List available skills without installing
  162. --only a,b,c Install only specified skills
  163. --skip a,b,c Skip specified skills
  164. --target, -t PATH Custom target directory (default: ~/.openclaw/skills)
  165. --clean Remove existing skills before installing
  166. --dry-run Preview what would be installed
  167. --help, -h Show this help
  168. Tool installation:
  169. tools/* is installed to ~/.openclaw/tools
  170. tools/* is mirrored to ~/.openclaw/workspace/scripts/tools
  171. Examples:
  172. node install.js # Install all skills
  173. node install.js --list # List skills
  174. node install.js --only tiktok-video-search # Install one skill
  175. node install.js --skip test-billing,test-skill # Skip test skills
  176. node install.js --target ./my-skills # Custom directory
  177. `);
  178. }
  179. function listSkills(skills) {
  180. console.log(`\n Found ${skills.length} skills:\n`);
  181. let totalSize = 0;
  182. let totalFiles = 0;
  183. for (const skill of skills) {
  184. const fileNames = skill.files.map(f => f.name).join(', ');
  185. console.log(` ${skill.name.padEnd(35)} ${formatSize(skill.totalSize).padStart(8)} [${fileNames}]`);
  186. totalSize += skill.totalSize;
  187. totalFiles += skill.files.length;
  188. }
  189. console.log(`\n Total: ${skills.length} skills, ${totalFiles} files, ${formatSize(totalSize)}\n`);
  190. }
  191. function discoverFilesRecursive(sourceDir, baseDir = sourceDir) {
  192. if (!fs.existsSync(sourceDir)) return [];
  193. const files = [];
  194. for (const entry of fs.readdirSync(sourceDir, { withFileTypes: true })) {
  195. const fullPath = path.join(sourceDir, entry.name);
  196. if (entry.isDirectory()) {
  197. files.push(...discoverFilesRecursive(fullPath, baseDir));
  198. } else if (entry.isFile()) {
  199. files.push({
  200. name: path.relative(baseDir, fullPath),
  201. path: fullPath,
  202. size: getFileSize(fullPath)
  203. });
  204. }
  205. }
  206. return files.sort((a, b) => a.name.localeCompare(b.name));
  207. }
  208. function listTools(tools) {
  209. if (tools.length === 0) return;
  210. console.log('\n Found ' + tools.length + ' tool files:\n');
  211. let totalSize = 0;
  212. for (const tool of tools) {
  213. console.log(' ' + tool.name.padEnd(55) + ' ' + formatSize(tool.size).padStart(8));
  214. totalSize += tool.size;
  215. }
  216. console.log('\n Total tools: ' + tools.length + ' files, ' + formatSize(totalSize) + '\n');
  217. }
  218. function installTools(tools, opts) {
  219. if (tools.length === 0) return { installed: 0, skipped: 0, errors: 0 };
  220. const toolsTarget = getOpenClawToolsDir();
  221. const workspaceToolsTarget = getOpenClawWorkspaceToolsDir();
  222. const prefix = opts.dryRun ? '[DRY-RUN] ' : '';
  223. console.log('\n' + prefix + 'Installing ' + tools.length + ' tool files to:');
  224. console.log(' ' + toolsTarget);
  225. console.log(' ' + workspaceToolsTarget + '\n');
  226. let installed = 0;
  227. let skipped = 0;
  228. let errors = 0;
  229. for (const tool of tools) {
  230. try {
  231. for (const targetRoot of [toolsTarget, workspaceToolsTarget]) {
  232. const destFile = path.join(targetRoot, tool.name);
  233. if (fs.existsSync(destFile)) {
  234. const existingContent = fs.readFileSync(destFile);
  235. const newContent = fs.readFileSync(tool.path);
  236. if (existingContent.equals(newContent)) {
  237. skipped++;
  238. continue;
  239. }
  240. }
  241. if (!opts.dryRun) {
  242. copyFileSync(tool.path, destFile);
  243. }
  244. installed++;
  245. }
  246. process.stdout.write(' [OK] ' + tool.name + '\n');
  247. } catch (err) {
  248. process.stdout.write(' [ERROR] ' + tool.name + ': ' + err.message + '\n');
  249. errors++;
  250. }
  251. }
  252. console.log('\n' + prefix + 'Tool files done! Installed: ' + installed + ', unchanged: ' + skipped + ', errors: ' + errors + '\n');
  253. return { installed, skipped, errors };
  254. }
  255. function installWorkspaceBundles(scriptDir, opts) {
  256. const workspaceRoot = getOpenClawWorkspaceDir();
  257. const prefix = opts.dryRun ? '[DRY-RUN] ' : '';
  258. let installed = 0;
  259. let skipped = 0;
  260. let errors = 0;
  261. for (const bundleName of WORKSPACE_BUNDLE_DIRS) {
  262. const sourceDir = path.join(scriptDir, bundleName);
  263. if (!fs.existsSync(sourceDir)) continue;
  264. const files = discoverFilesRecursive(sourceDir);
  265. console.log('\n' + prefix + 'Installing workspace bundle: ' + bundleName);
  266. console.log(' ' + path.join(workspaceRoot, bundleName) + '\n');
  267. for (const file of files) {
  268. const destFile = path.join(workspaceRoot, bundleName, file.name);
  269. try {
  270. if (fs.existsSync(destFile)) {
  271. const existingContent = fs.readFileSync(destFile);
  272. const newContent = fs.readFileSync(file.path);
  273. if (existingContent.equals(newContent)) {
  274. skipped++;
  275. continue;
  276. }
  277. }
  278. if (!opts.dryRun) {
  279. copyFileSync(file.path, destFile);
  280. }
  281. installed++;
  282. } catch (err) {
  283. process.stdout.write(' [ERROR] ' + path.join(bundleName, file.name) + ': ' + err.message + '\n');
  284. errors++;
  285. }
  286. }
  287. process.stdout.write(' [OK] ' + bundleName + ' (' + files.length + ' files)\n');
  288. }
  289. if (installed || skipped || errors) {
  290. console.log('\n' + prefix + 'Workspace bundles done! Installed: ' + installed + ', unchanged: ' + skipped + ', errors: ' + errors + '\n');
  291. }
  292. return { installed, skipped, errors };
  293. }
  294. function installSkills(skills, targetDir, opts) {
  295. const prefix = opts.dryRun ? '[DRY-RUN] ' : '';
  296. console.log(`\n${prefix}Installing ${skills.length} skills to:`);
  297. console.log(` ${targetDir}\n`);
  298. if (opts.clean && !opts.dryRun) {
  299. console.log(`${prefix}Cleaning target directory...`);
  300. for (const skill of skills) {
  301. const dest = path.join(targetDir, skill.name);
  302. if (fs.existsSync(dest)) {
  303. removeDir(dest);
  304. }
  305. }
  306. }
  307. let installed = 0;
  308. let skipped = 0;
  309. let errors = 0;
  310. for (const skill of skills) {
  311. const destDir = path.join(targetDir, skill.name);
  312. try {
  313. if (!opts.dryRun) {
  314. ensureDir(destDir);
  315. }
  316. for (const file of skill.files) {
  317. const destFile = path.join(destDir, file.name);
  318. // Check if file already exists and is identical
  319. if (fs.existsSync(destFile)) {
  320. const existingContent = fs.readFileSync(destFile);
  321. const newContent = fs.readFileSync(file.path);
  322. if (existingContent.equals(newContent)) {
  323. skipped++;
  324. continue;
  325. }
  326. }
  327. if (!opts.dryRun) {
  328. copyFileSync(file.path, destFile);
  329. }
  330. installed++;
  331. }
  332. process.stdout.write(` ✅ ${skill.name}\n`);
  333. } catch (err) {
  334. process.stdout.write(` ❌ ${skill.name}: ${err.message}\n`);
  335. errors++;
  336. }
  337. }
  338. console.log(`\n${'─'.repeat(50)}`);
  339. console.log(`${prefix}Done!`);
  340. console.log(` Installed: ${installed} files`);
  341. console.log(` Unchanged: ${skipped} files`);
  342. if (errors > 0) console.log(` Errors: ${errors}`);
  343. console.log(` Target: ${targetDir}`);
  344. console.log('');
  345. if (!opts.dryRun && errors === 0) {
  346. console.log(' Skills are ready. Restart OpenClaw gateway to load them.');
  347. console.log('');
  348. }
  349. }
  350. // ============================================
  351. // 主入口
  352. // ============================================
  353. function main() {
  354. const opts = parseArgs();
  355. if (opts.help) {
  356. showHelp();
  357. return;
  358. }
  359. console.log('');
  360. console.log(' ╔══════════════════════════════════════════════╗');
  361. console.log(` ║ OpenClaw VOC Skills Installer v${VERSION} ║`);
  362. console.log(' ╚══════════════════════════════════════════════╝');
  363. // Determine source directory (skills/ next to this script)
  364. const scriptDir = __dirname;
  365. const sourceDir = path.join(scriptDir, SKILLS_SUBDIR);
  366. const toolsSourceDir = path.join(scriptDir, TOOLS_SUBDIR);
  367. if (!fs.existsSync(sourceDir)) {
  368. console.error(`\n ❌ Skills directory not found: ${sourceDir}`);
  369. console.error(' Make sure the "skills" folder is in the same directory as this script.\n');
  370. process.exit(1);
  371. }
  372. // Discover skills
  373. const allSkills = discoverSkills(sourceDir);
  374. if (allSkills.length === 0) {
  375. console.error(`\n ❌ No skills found in: ${sourceDir}\n`);
  376. process.exit(1);
  377. }
  378. // Filter
  379. const skills = filterSkills(allSkills, opts);
  380. if (opts.list) {
  381. listSkills(skills);
  382. listTools(discoverFilesRecursive(toolsSourceDir));
  383. return;
  384. }
  385. if (skills.length === 0) {
  386. console.log('\n No skills matched the filter.\n');
  387. return;
  388. }
  389. // Target directory
  390. const targetDir = opts.target || getOpenClawSkillsDir();
  391. // Pre-flight check
  392. const openclawDir = getOpenClawDir();
  393. if (!opts.target && !fs.existsSync(openclawDir)) {
  394. console.error(`\n ⚠️ OpenClaw directory not found: ${openclawDir}`);
  395. console.error(' Is OpenClaw installed? You can specify a custom target with --target PATH\n');
  396. process.exit(1);
  397. }
  398. const tools = discoverFilesRecursive(toolsSourceDir);
  399. listSkills(skills);
  400. installSkills(skills, targetDir, opts);
  401. installTools(tools, opts);
  402. installWorkspaceBundles(scriptDir, opts);
  403. }
  404. main();