install.js 13 KB

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