install.js 9.9 KB

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