create-openclaw-plugin 0.1.0

package/bin/create.js

@@ -0,0 +1,249 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+
+// ---- 颜色 ----
+const green = (s) => `\x1b[32m${s}\x1b[0m`;
+const cyan = (s) => `\x1b[36m${s}\x1b[0m`;
+const yellow = (s) => `\x1b[33m${s}\x1b[0m`;
+const bold = (s) => `\x1b[1m${s}\x1b[0m`;
+
+// ---- 参数解析 ----
+const args = process.argv.slice(2);
+if (args.length === 0 || args[0] === "--help" || args[0] === "-h") {
+  console.log(`
+${bold("create-openclaw-plugin")} — 一键创建 OpenClaw Plugin 项目
+
+${bold("用法：")}
+  npx create-openclaw-plugin ${cyan("<plugin-name>")}
+
+${bold("示例：")}
+  npx create-openclaw-plugin my-weather-plugin
+  npx create-openclaw-plugin openclaw-plugin-translator
+
+${bold("生成结构：")}
+  <plugin-name>/
+  ├── src/index.ts          # 插件源码（含示例 Tool）
+  ├── openclaw.plugin.json  # 插件清单
+  ├── package.json          # npm 包描述
+  ├── tsconfig.json         # TypeScript 配置
+  ├── tsup.config.ts        # 构建配置
+  └── README.md             # 说明文档
+`);
+  process.exit(0);
+}
+
+const projectName = args[0];
+const projectDir = path.resolve(process.cwd(), projectName);
+
+// 插件 ID：如果名字已经带 openclaw-plugin- 前缀就直接用，否则加上
+const pluginId = projectName.startsWith("openclaw-plugin-")
+  ? projectName
+  : `openclaw-plugin-${projectName}`;
+
+// Tool name: 把 - 转 _，去掉 openclaw-plugin- 前缀
+const toolBaseName = pluginId
+  .replace("openclaw-plugin-", "")
+  .replace(/-/g, "_");
+const toolName = `${toolBaseName}_hello`;
+
+// ---- 检查目录 ----
+if (fs.existsSync(projectDir)) {
+  console.error(`\n❌ 目录已存在: ${projectDir}\n`);
+  process.exit(1);
+}
+
+// ---- 模板文件 ----
+const templates = {
+  "package.json": JSON.stringify(
+    {
+      name: pluginId,
+      version: "0.1.0",
+      description: `OpenClaw plugin: ${pluginId}`,
+      type: "commonjs",
+      main: "dist/index.js",
+      types: "dist/index.d.ts",
+      openclaw: {
+        id: pluginId,
+        extensions: ["./dist/index.js"],
+      },
+      scripts: {
+        build: "tsup",
+        dev: "tsup --watch",
+      },
+      peerDependencies: {
+        openclaw: ">=2026.3.22",
+      },
+      devDependencies: {
+        openclaw: "^2026.3.22",
+        tsup: "^8.5.1",
+        typescript: "^5.7.0",
+        "@sinclair/typebox": "^0.34.0",
+      },
+      engines: { node: ">=18.0.0" },
+      files: ["dist", "openclaw.plugin.json", "package.json", "README.md"],
+      license: "MIT",
+    },
+    null,
+    2
+  ),
+
+  "openclaw.plugin.json": JSON.stringify(
+    {
+      id: pluginId,
+      configSchema: {
+        type: "object",
+        additionalProperties: false,
+        properties: {},
+      },
+    },
+    null,
+    2
+  ),
+
+  "tsup.config.ts": `import { defineConfig } from "tsup";
+export default defineConfig({
+  entry: ["src/index.ts"],
+  format: ["cjs"],
+  target: "node18",
+  dts: true,
+  clean: true,
+  external: ["openclaw"],
+  sourcemap: true,
+});
+`,
+
+  "tsconfig.json": JSON.stringify(
+    {
+      compilerOptions: {
+        target: "ES2022",
+        module: "ESNext",
+        moduleResolution: "bundler",
+        esModuleInterop: true,
+        strict: true,
+        outDir: "dist",
+        declaration: true,
+        skipLibCheck: true,
+      },
+      include: ["src"],
+    },
+    null,
+    2
+  ),
+
+  "src/index.ts": `/**
+ * ${pluginId}
+ *
+ * TODO: Replace this demo tool with your own implementation.
+ */
+
+import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
+import type { AnyAgentTool } from "openclaw/plugin-sdk/plugin-entry";
+import type { OpenClawPluginToolContext } from "openclaw/plugin-sdk/core";
+import { Type } from "@sinclair/typebox";
+
+// ---------------------------------------------------------------------------
+// Tool definition
+// ---------------------------------------------------------------------------
+
+function createHelloTool(): AnyAgentTool {
+  return {
+    name: "${toolName}",
+    label: "${toolBaseName} Hello",
+    description:
+      "A demo tool from ${pluginId}. Returns a greeting message. " +
+      "Replace this with your own tool implementation.",
+    parameters: Type.Object({
+      name: Type.Optional(
+        Type.String({ description: "Name to greet. Defaults to 'World'." })
+      ),
+    }),
+    async execute(_toolCallId, params) {
+      const greeting = \`Hello, \${params.name || "World"}! 👋 from ${pluginId}\`;
+      return {
+        content: [{ type: "text", text: greeting }],
+        details: { greeting },
+      };
+    },
+  };
+}
+
+// ---------------------------------------------------------------------------
+// Tool factory
+// ---------------------------------------------------------------------------
+
+function helloToolFactory(_ctx: OpenClawPluginToolContext): AnyAgentTool {
+  // Read config if needed:
+  // const config = _ctx.config?.plugins?.entries?.["${pluginId}"]?.config;
+  return createHelloTool();
+}
+
+// ---------------------------------------------------------------------------
+// Plugin entry
+// ---------------------------------------------------------------------------
+
+export default definePluginEntry({
+  id: "${pluginId}",
+  name: "${pluginId}",
+  description: "TODO: Add your plugin description here.",
+
+  register(api) {
+    api.registerTool(helloToolFactory, {
+      name: "${toolName}",
+    });
+
+    api.logger.info("✅ ${pluginId} loaded");
+  },
+});
+`,
+
+  "README.md": `# ${pluginId}
+
+An OpenClaw plugin.
+
+## Quick Start
+
+\`\`\`bash
+npm install
+npm run build
+openclaw plugins install .
+openclaw gateway restart
+\`\`\`
+
+## Development
+
+\`\`\`bash
+# Edit src/index.ts, then:
+npm run build
+cp -rf dist openclaw.plugin.json package.json ~/.openclaw/extensions/${pluginId}/
+openclaw gateway restart
+\`\`\`
+`,
+};
+
+// ---- 写文件 ----
+console.log(`\n🔌 Creating OpenClaw plugin: ${bold(pluginId)}\n`);
+
+fs.mkdirSync(path.join(projectDir, "src"), { recursive: true });
+
+for (const [filePath, content] of Object.entries(templates)) {
+  const fullPath = path.join(projectDir, filePath);
+  fs.writeFileSync(fullPath, content, "utf-8");
+  console.log(`  ${green("✓")} ${filePath}`);
+}
+
+// ---- 完成提示 ----
+console.log(`
+${green("✅ Done!")} Plugin created at ${cyan(projectDir)}
+
+${bold("Next steps:")}
+
+  cd ${projectName}
+  npm install
+  npm run build
+  openclaw plugins install .
+  openclaw gateway restart
+
+${yellow("📝 记得修改 src/index.ts 中的 demo tool 为你自己的实现！")}
+`);

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "create-openclaw-plugin",
+  "version": "0.1.0",
+  "description": "Scaffold a new OpenClaw plugin in seconds",
+  "bin": {
+    "create-openclaw-plugin": "./bin/create.js"
+  },
+  "files": ["bin", "template"],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}