بناء Plugins

openclaw plugins install clawhub:<package-name>

​

المتطلبات

• استخدم Node 22.19+، أو Node 23.11+، أو Node 24+ ومدير حزم مثل npm أو pnpm.
• كن ملمًا بوحدات TypeScript ESM.
• للعمل على مكوّن إضافي مضمّن داخل المستودع، انسخ المستودع وشغّل pnpm install. تطوير المكوّنات الإضافية من نسخة المصدر يستخدم pnpm فقط لأن OpenClaw يحمّل المكوّنات الإضافية المضمّنة من حزم مساحة العمل extensions/*.

​

اختر شكل المكوّن الإضافي

​

البدء السريع

{
  "name": "@myorg/openclaw-my-plugin",
  "version": "1.0.0",
  "type": "module",
  "dependencies": {
    "typebox": "1.1.39"
  },
  "peerDependencies": {
    "openclaw": ">=2026.3.24-beta.2"
  },
  "openclaw": {
    "extensions": ["./index.ts"],
    "compat": {
      "pluginApi": ">=2026.3.24-beta.2",
      "minGatewayVersion": "2026.3.24-beta.2"
    },
    "build": {
      "openclawVersion": "2026.3.24-beta.2",
      "pluginSdkVersion": "2026.3.24-beta.2"
    }
  }
}

{
  "id": "my-plugin",
  "name": "My Plugin",
  "description": "Adds a custom tool to OpenClaw",
  "contracts": {
    "tools": ["my_tool"]
  },
  "activation": {
    "onStartup": true
  },
  "configSchema": {
    "type": "object",
    "additionalProperties": false
  }
}

import { Type } from "typebox";
import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";

export default definePluginEntry({
  id: "my-plugin",
  name: "My Plugin",
  description: "Adds a custom tool to OpenClaw",
  register(api) {
    api.registerTool({
      name: "my_tool",
      description: "Echo one input value",
      parameters: Type.Object({ input: Type.String() }),
      async execute(_id, params) {
        return {
          content: [{ type: "text", text: `Got: ${params.input}` }],
        };
      },
    });
  },
});

openclaw plugins inspect my-plugin --runtime --json

pnpm test -- extensions/my-plugin/
pnpm check

npm pack --pack-destination /tmp
openclaw plugins install npm-pack:/tmp/<plugin-package>.tgz --force
openclaw plugins inspect my-plugin --runtime --json

clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin

openclaw plugins install clawhub:your-org/your-plugin

​

تسجيل الأدوات

register(api) {
  api.registerTool(
    {
      name: "workflow_tool",
      description: "Run a workflow",
      parameters: Type.Object({ pipeline: Type.String() }),
      async execute(_id, params) {
        return { content: [{ type: "text", text: params.pipeline }] };
      },
    },
    { optional: true },
  );
}

{
  "contracts": {
    "tools": ["workflow_tool"]
  },
  "toolMetadata": {
    "workflow_tool": {
      "optional": true
    }
  }
}

{
  tools: { allow: ["workflow_tool"] }, // or ["my-plugin"] for all tools from one plugin
}

​

اصطلاحات الاستيراد

import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
import { createPluginRuntimeStore } from "openclaw/plugin-sdk/runtime-store";

import { definePluginEntry } from "openclaw/plugin-sdk";

​

قائمة التحقق قبل الإرسال

​

الاختبار مقابل إصدارات بيتا

1. راقب وسوم إصدارات GitHub على openclaw/openclaw واشترك عبر Watch > Releases. تبدو وسوم بيتا مثل v2026.3.N-beta.1. يمكنك أيضًا تفعيل الإشعارات لحساب OpenClaw الرسمي على X @openclaw لإعلانات الإصدارات.
2. اختبر Plugin الخاص بك مقابل وسم بيتا بمجرد ظهوره. عادةً ما تكون النافذة قبل الإصدار المستقر بضع ساعات فقط.
3. انشر في سلسلة Plugin الخاصة بك في قناة Discord المسماة plugin-forum بعد الاختبار، إما بـ all good أو بما تعطل. إذا لم تكن لديك سلسلة بعد، فأنشئ واحدة.
4. إذا تعطل شيء ما، فافتح مشكلة أو حدّث مشكلة بعنوان Beta blocker: <plugin-name> - <summary> وطبّق تسمية beta-blocker. ضع رابط المشكلة في سلسلتك.
5. افتح PR إلى main بعنوان fix(<plugin-id>): beta blocker - <summary> واربط المشكلة في كل من PR وسلسلة Discord الخاصة بك. لا يستطيع المساهمون تسمية PRs، لذلك يكون العنوان هو إشارة جهة PR للمشرفين والأتمتة. تُدمج العوائق التي لديها PR؛ أما العوائق التي لا تملك واحدًا فقد تُشحن رغم ذلك. يراقب المشرفون هذه السلاسل أثناء اختبار بيتا.
6. الصمت يعني أن كل شيء سليم. إذا فاتتك النافذة، فمن المرجح أن يصل إصلاحك في الدورة التالية.

​

الخطوات التالية

​

ذات صلة

• خطافات Plugin
• بنية Plugin