메인 콘텐츠로 건너뛰기

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Plugin 패키징(package.json 메타데이터), 매니페스트(openclaw.plugin.json), 설정 항목, 구성 스키마에 대한 참조입니다.
따라하기 가이드를 찾고 있나요? 방법 가이드에서 패키징을 맥락에 맞게 다룹니다: Channel PluginProvider Plugin.

패키지 메타데이터

package.json에는 Plugin 시스템에 Plugin이 무엇을 제공하는지 알려주는 openclaw 필드가 필요합니다.
{
  "name": "@myorg/openclaw-my-channel",
  "version": "1.0.0",
  "type": "module",
  "openclaw": {
    "extensions": ["./index.ts"],
    "setupEntry": "./setup-entry.ts",
    "channel": {
      "id": "my-channel",
      "label": "My Channel",
      "blurb": "Short description of the channel."
    }
  }
}
Plugin을 ClawHub에 외부 공개로 게시하는 경우 해당 compatbuild 필드는 필수입니다. 표준 게시 스니펫은 docs/snippets/plugin-publish/에 있습니다.

openclaw 필드

extensions
string[]
엔트리 포인트 파일입니다(패키지 루트 기준 상대 경로).
setupEntry
string
가벼운 설정 전용 엔트리입니다(선택 사항).
channel
object
설정, 선택기, 빠른 시작, 상태 화면을 위한 채널 카탈로그 메타데이터입니다.
providers
string[]
이 Plugin이 등록하는 제공자 ID입니다.
install
object
설치 힌트: npmSpec, localPath, defaultChoice, minHostVersion, expectedIntegrity, allowInvalidConfigRecovery.
startup
object
시작 동작 플래그입니다.

openclaw.channel

openclaw.channel은 런타임 로드 전에 채널 검색 및 설정 화면에 사용하는 가벼운 패키지 메타데이터입니다.
필드유형의미
idstring표준 채널 ID입니다.
labelstring기본 채널 레이블입니다.
selectionLabelstringlabel과 달라야 할 때 사용하는 선택기/설정 레이블입니다.
detailLabelstring더 풍부한 채널 카탈로그와 상태 화면을 위한 보조 세부 레이블입니다.
docsPathstring설정 및 선택 링크에 사용할 문서 경로입니다.
docsLabelstring문서 링크에 사용하는 레이블이 채널 ID와 달라야 할 때 재정의합니다.
blurbstring짧은 온보딩/카탈로그 설명입니다.
ordernumber채널 카탈로그의 정렬 순서입니다.
aliasesstring[]채널 선택을 위한 추가 조회 별칭입니다.
preferOverstring[]이 채널보다 낮은 우선순위로 밀려야 하는 Plugin/채널 ID입니다.
systemImagestring채널 UI 카탈로그를 위한 선택적 아이콘/시스템 이미지 이름입니다.
selectionDocsPrefixstring선택 화면에서 문서 링크 앞에 표시할 접두사 텍스트입니다.
selectionDocsOmitLabelboolean선택 문구에서 레이블이 있는 문서 링크 대신 문서 경로를 직접 표시합니다.
selectionExtrasstring[]선택 문구에 덧붙일 추가 짧은 문자열입니다.
markdownCapableboolean발신 형식 결정에서 채널을 Markdown 지원 채널로 표시합니다.
exposureobject설정, 구성된 목록, 문서 화면에서의 채널 표시 여부 제어입니다.
quickstartAllowFromboolean이 채널을 표준 빠른 시작 allowFrom 설정 흐름에 포함합니다.
forceAccountBindingboolean계정이 하나만 있어도 명시적인 계정 바인딩을 요구합니다.
preferSessionLookupForAnnounceTargetboolean이 채널의 공지 대상 확인 시 세션 조회를 우선합니다.
예:
{
  "openclaw": {
    "channel": {
      "id": "my-channel",
      "label": "My Channel",
      "selectionLabel": "My Channel (self-hosted)",
      "detailLabel": "My Channel Bot",
      "docsPath": "/channels/my-channel",
      "docsLabel": "my-channel",
      "blurb": "Webhook-based self-hosted chat integration.",
      "order": 80,
      "aliases": ["mc"],
      "preferOver": ["my-channel-legacy"],
      "selectionDocsPrefix": "Guide:",
      "selectionExtras": ["Markdown"],
      "markdownCapable": true,
      "exposure": {
        "configured": true,
        "setup": true,
        "docs": true
      },
      "quickstartAllowFrom": true
    }
  }
}
exposure는 다음을 지원합니다.
  • configured: 구성된/상태 스타일 목록 화면에 채널을 포함합니다
  • setup: 대화형 설정/구성 선택기에 채널을 포함합니다
  • docs: 문서/내비게이션 화면에서 채널을 공개 대상으로 표시합니다
showConfiguredshowInSetup은 레거시 별칭으로 계속 지원됩니다. exposure를 선호하세요.

openclaw.install

openclaw.install은 패키지 메타데이터이며, 매니페스트 메타데이터가 아닙니다.
필드유형의미
clawhubSpecstring설치/업데이트 및 온보딩 주문형 설치 흐름을 위한 표준 ClawHub 사양입니다.
npmSpecstring설치/업데이트 대체 흐름을 위한 표준 npm 사양입니다.
localPathstring로컬 개발 또는 번들 설치 경로입니다.
defaultChoice"clawhub" | "npm" | "local"여러 소스를 사용할 수 있을 때 선호하는 설치 소스입니다.
minHostVersionstring>=x.y.z 또는 >=x.y.z-prerelease 형식의 최소 지원 OpenClaw 버전입니다.
expectedIntegritystring고정 설치를 위한 예상 npm 배포 무결성 문자열이며, 보통 sha512-...입니다.
allowInvalidConfigRecoveryboolean번들 Plugin 재설치 흐름이 특정 오래된 구성 실패에서 복구할 수 있게 합니다.
대화형 온보딩도 주문형 설치 화면에 openclaw.install을 사용합니다. Plugin이 런타임 로드 전에 제공자 인증 선택지 또는 채널 설정/카탈로그 메타데이터를 노출하면, 온보딩은 해당 선택지를 표시하고 ClawHub, npm 또는 로컬 설치를 묻고, Plugin을 설치하거나 활성화한 다음 선택한 흐름을 계속 진행할 수 있습니다. ClawHub 온보딩 선택지는 clawhubSpec을 사용하며, 존재하는 경우 우선됩니다. npm 선택지는 레지스트리 npmSpec이 있는 신뢰할 수 있는 카탈로그 메타데이터가 필요합니다. 정확한 버전과 expectedIntegrity는 선택적 npm 고정값입니다. expectedIntegrity가 있으면 설치/업데이트 흐름은 npm에 대해 이를 강제합니다. “무엇을 보여줄지”에 대한 메타데이터는 openclaw.plugin.json에, “어떻게 설치할지”에 대한 메타데이터는 package.json에 두세요.
minHostVersion이 설정되면 설치와 번들되지 않은 매니페스트 레지스트리 로딩 모두에서 이를 적용합니다. 오래된 호스트는 외부 Plugin을 건너뛰며, 잘못된 버전 문자열은 거부됩니다. 번들 소스 Plugin은 호스트 체크아웃과 같은 버전으로 간주됩니다.
고정된 npm 설치의 경우 npmSpec에 정확한 버전을 유지하고 예상 아티팩트 무결성을 추가하세요.
{
  "openclaw": {
    "install": {
      "npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3",
      "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",
      "defaultChoice": "npm"
    }
  }
}
allowInvalidConfigRecovery는 손상된 구성을 위한 일반적인 우회 수단이 아닙니다. 이는 좁은 범위의 번들 Plugin 복구 전용이므로, 재설치/설정이 누락된 번들 Plugin 경로나 동일한 Plugin의 오래된 channels.<id> 항목 같은 알려진 업그레이드 잔여물을 복구할 수 있게 합니다. 관련 없는 이유로 구성이 손상된 경우 설치는 여전히 닫힌 상태로 실패하며 운영자에게 openclaw doctor --fix 실행을 안내합니다.

지연된 전체 로드

Channel Plugin은 다음으로 지연 로딩을 선택할 수 있습니다.
{
  "openclaw": {
    "extensions": ["./index.ts"],
    "setupEntry": "./setup-entry.ts",
    "startup": {
      "deferConfiguredChannelFullLoadUntilAfterListen": true
    }
  }
}
활성화하면 OpenClaw는 이미 구성된 채널의 경우에도 수신 대기 전 시작 단계에서 setupEntry만 로드합니다. 전체 엔트리는 Gateway가 수신 대기를 시작한 뒤 로드됩니다.
Gateway가 수신 대기를 시작하기 전에 필요한 모든 것(채널 등록, HTTP 라우트, Gateway 메서드)을 setupEntry가 등록하는 경우에만 지연 로딩을 활성화하세요. 필수 시작 기능을 전체 엔트리가 소유한다면 기본 동작을 유지하세요.
설정/전체 엔트리가 Gateway RPC 메서드를 등록하는 경우 Plugin별 접두사에 유지하세요. 예약된 코어 관리자 네임스페이스(config.*, exec.approvals.*, wizard.*, update.*)는 코어 소유로 유지되며 항상 operator.admin으로 확인됩니다.

Plugin 매니페스트

모든 네이티브 Plugin은 패키지 루트에 openclaw.plugin.json을 포함해야 합니다. OpenClaw는 이를 사용해 Plugin 코드를 실행하지 않고 구성을 검증합니다.
{
  "id": "my-plugin",
  "name": "My Plugin",
  "description": "Adds My Plugin capabilities to OpenClaw",
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "webhookSecret": {
        "type": "string",
        "description": "Webhook verification secret"
      }
    }
  }
}
Channel Plugin의 경우 kindchannels를 추가하세요.
{
  "id": "my-channel",
  "kind": "channel",
  "channels": ["my-channel"],
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  }
}
구성이 없는 Plugin도 스키마를 포함해야 합니다. 빈 스키마도 유효합니다.
{
  "id": "my-plugin",
  "configSchema": {
    "type": "object",
    "additionalProperties": false
  }
}
전체 스키마 참조는 Plugin 매니페스트를 참고하세요.

ClawHub 게시

Plugin 패키지에는 패키지별 ClawHub 명령을 사용하세요:
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
기존 Skills 전용 publish 별칭은 Skills용입니다. Plugin 패키지는 항상 clawhub package publish를 사용해야 합니다.

설정 진입점

setup-entry.ts 파일은 OpenClaw가 설정 표면(온보딩, 구성 복구, 비활성화된 채널 검사)만 필요로 할 때 로드하는 index.ts의 경량 대안입니다.
// setup-entry.ts
import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { myChannelPlugin } from "./src/channel.js";

export default defineSetupPluginEntry(myChannelPlugin);
이렇게 하면 설정 흐름 중 무거운 런타임 코드(암호화 라이브러리, CLI 등록, 백그라운드 서비스)를 로드하지 않습니다. 설정에 안전한 export를 사이드카 모듈에 유지하는 번들 워크스페이스 채널은 defineSetupPluginEntry(...) 대신 openclaw/plugin-sdk/channel-entry-contractdefineBundledChannelSetupEntry(...)를 사용할 수 있습니다. 해당 번들 계약은 선택적 runtime export도 지원하므로 설정 시점 런타임 배선을 가볍고 명시적으로 유지할 수 있습니다.
  • 채널이 비활성화되어 있지만 설정/온보딩 표면이 필요한 경우.
  • 채널이 활성화되어 있지만 구성되지 않은 경우.
  • 지연 로딩이 활성화된 경우(deferConfiguredChannelFullLoadUntilAfterListen).
  • 채널 Plugin 객체(defineSetupPluginEntry를 통해).
  • Gateway listen 이전에 필요한 모든 HTTP 라우트.
  • 시작 중 필요한 모든 Gateway 메서드.
이러한 시작 Gateway 메서드는 여전히 config.* 또는 update.* 같은 예약된 코어 관리자 네임스페이스를 피해야 합니다.
  • CLI 등록.
  • 백그라운드 서비스.
  • 무거운 런타임 import(암호화, SDK).
  • 시작 후에만 필요한 Gateway 메서드.

좁은 설정 헬퍼 import

설정 전용 핫 경로에서는 설정 표면의 일부만 필요할 때 더 넓은 plugin-sdk/setup 엄브렐러보다 좁은 설정 헬퍼 연결부를 선호하세요.
Import 경로사용 대상주요 export
plugin-sdk/setup-runtimesetupEntry / 지연 채널 시작에서 계속 사용할 수 있는 설정 시점 런타임 헬퍼createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy
plugin-sdk/setup-adapter-runtime사용 중단된 호환성 별칭입니다. plugin-sdk/setup-runtime을 사용하세요createEnvPatchedAccountSetupAdapter
plugin-sdk/setup-tools설정/설치 CLI/아카이브/문서 헬퍼formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR
moveSingleAccountChannelSectionToDefaultAccount(...) 같은 구성 패치 헬퍼를 포함해 전체 공유 설정 도구 상자가 필요하면 더 넓은 plugin-sdk/setup 연결부를 사용하세요. 설정 패치 어댑터는 import 시 핫 경로에 안전하게 유지됩니다. 번들 단일 계정 승격 계약 표면 조회는 지연 수행되므로, plugin-sdk/setup-runtime을 import해도 어댑터가 실제로 사용되기 전에는 번들 계약 표면 탐색을 즉시 로드하지 않습니다.

채널 소유 단일 계정 승격

채널이 단일 계정 최상위 구성에서 channels.<id>.accounts.*로 업그레이드될 때, 기본 공유 동작은 승격된 계정 범위 값을 accounts.default로 이동하는 것입니다. 번들 채널은 설정 계약 표면을 통해 해당 승격을 좁히거나 재정의할 수 있습니다.
  • singleAccountKeysToMove: 승격된 계정으로 이동해야 하는 추가 최상위 키
  • namedAccountPromotionKeys: 이름 있는 계정이 이미 존재할 때, 승격된 계정으로 이동하는 키는 이것들뿐입니다. 공유 정책/전달 키는 채널 루트에 유지됩니다.
  • resolveSingleAccountPromotionTarget(...): 승격된 값을 받을 기존 계정을 선택합니다.
Matrix는 현재 번들 예시입니다. 이름 있는 Matrix 계정이 정확히 하나 이미 있거나 defaultAccountOps 같은 기존 비정규 키를 가리키는 경우, 승격은 새 accounts.default 항목을 만들지 않고 해당 계정을 보존합니다.

구성 스키마

Plugin 구성은 manifest의 JSON Schema에 대해 검증됩니다. 사용자는 다음과 같이 Plugin을 구성합니다.
{
  plugins: {
    entries: {
      "my-plugin": {
        config: {
          webhookSecret: "abc123",
        },
      },
    },
  },
}
Plugin은 등록 중 이 구성을 api.pluginConfig로 받습니다. 채널별 구성에는 대신 채널 구성 섹션을 사용하세요.
{
  channels: {
    "my-channel": {
      token: "bot-token",
      allowFrom: ["user1", "user2"],
    },
  },
}

채널 구성 스키마 빌드

buildChannelConfigSchema를 사용하여 Zod 스키마를 Plugin 소유 구성 아티팩트에서 사용하는 ChannelConfigSchema 래퍼로 변환하세요.
import { z } from "zod";
import { buildChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema";

const accountSchema = z.object({
  token: z.string().optional(),
  allowFrom: z.array(z.string()).optional(),
  accounts: z.object({}).catchall(z.any()).optional(),
  defaultAccount: z.string().optional(),
});

const configSchema = buildChannelConfigSchema(accountSchema);
계약을 이미 JSON Schema 또는 TypeBox로 작성하고 있다면, OpenClaw가 메타데이터 경로에서 Zod-JSON-Schema 변환을 건너뛸 수 있도록 직접 헬퍼를 사용하세요.
import { Type } from "typebox";
import { buildJsonChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema";

const configSchema = buildJsonChannelConfigSchema(
  Type.Object({
    token: Type.Optional(Type.String()),
    allowFrom: Type.Optional(Type.Array(Type.String())),
  }),
);
서드 파티 Plugin의 경우 콜드 경로 계약은 여전히 Plugin manifest입니다. 생성된 JSON Schema를 openclaw.plugin.json#channelConfigs로 미러링하여 구성 스키마, 설정, UI 표면이 런타임 코드를 로드하지 않고도 channels.<id>를 검사할 수 있게 하세요.

설정 마법사

채널 Plugin은 openclaw onboard를 위한 대화형 설정 마법사를 제공할 수 있습니다. 마법사는 ChannelPluginChannelSetupWizard 객체입니다.
import type { ChannelSetupWizard } from "openclaw/plugin-sdk/channel-setup";

const setupWizard: ChannelSetupWizard = {
  channel: "my-channel",
  status: {
    configuredLabel: "Connected",
    unconfiguredLabel: "Not configured",
    resolveConfigured: ({ cfg }) => Boolean((cfg.channels as any)?.["my-channel"]?.token),
  },
  credentials: [
    {
      inputKey: "token",
      providerHint: "my-channel",
      credentialLabel: "Bot token",
      preferredEnvVar: "MY_CHANNEL_BOT_TOKEN",
      envPrompt: "Use MY_CHANNEL_BOT_TOKEN from environment?",
      keepPrompt: "Keep current token?",
      inputPrompt: "Enter your bot token:",
      inspect: ({ cfg, accountId }) => {
        const token = (cfg.channels as any)?.["my-channel"]?.token;
        return {
          accountConfigured: Boolean(token),
          hasConfiguredValue: Boolean(token),
        };
      },
    },
  ],
};
ChannelSetupWizard 타입은 credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize 등을 지원합니다. 전체 예시는 번들 Plugin 패키지(예: Discord Plugin src/channel.setup.ts)를 참고하세요.
표준 note -> prompt -> parse -> merge -> patch 흐름만 필요한 DM 허용 목록 프롬프트에는 openclaw/plugin-sdk/setup의 공유 설정 헬퍼인 createPromptParsedAllowFromForAccount(...), createTopLevelChannelParsedAllowFromPrompt(...), createNestedChannelParsedAllowFromPrompt(...)를 선호하세요.
라벨, 점수, 선택적 추가 줄만 달라지는 채널 설정 상태 블록에는 각 Plugin에서 동일한 status 객체를 직접 작성하는 대신 openclaw/plugin-sdk/setupcreateStandardChannelSetupStatus(...)를 선호하세요.
특정 컨텍스트에서만 표시되어야 하는 선택적 설정 표면에는 openclaw/plugin-sdk/channel-setupcreateOptionalChannelSetupSurface를 사용하세요.
import { createOptionalChannelSetupSurface } from "openclaw/plugin-sdk/channel-setup";

const setupSurface = createOptionalChannelSetupSurface({
  channel: "my-channel",
  label: "My Channel",
  npmSpec: "@myorg/openclaw-my-channel",
  docsPath: "/channels/my-channel",
});
// Returns { setupAdapter, setupWizard }
plugin-sdk/channel-setup은 해당 선택적 설치 표면의 절반만 필요할 때 사용할 수 있는 더 낮은 수준의 createOptionalChannelSetupAdapter(...)createOptionalChannelSetupWizard(...) 빌더도 노출합니다.생성된 선택적 어댑터/마법사는 실제 구성 쓰기에서 실패하도록 닫힙니다. 이들은 validateInput, applyAccountConfig, finalize 전반에서 하나의 설치 필요 메시지를 재사용하고, docsPath가 설정되면 문서 링크를 추가합니다.
바이너리 기반 설정 UI에서는 동일한 바이너리/상태 연결 코드를 모든 채널에 복사하는 대신 공유 위임 헬퍼를 선호하세요.
  • createDetectedBinaryStatus(...): 라벨, 힌트, 점수, 바이너리 감지만 달라지는 상태 블록용
  • createCliPathTextInput(...): 경로 기반 텍스트 입력용
  • createDelegatedSetupWizardStatusResolvers(...), createDelegatedPrepare(...), createDelegatedFinalize(...), createDelegatedResolveConfigured(...): setupEntry가 더 무거운 전체 마법사로 지연 전달해야 할 때
  • createDelegatedTextInputShouldPrompt(...): setupEntrytextInputs[*].shouldPrompt 결정을 위임하기만 하면 될 때

게시 및 설치

외부 Plugin: ClawHub에 게시한 다음 설치하세요.
openclaw plugins install @myorg/openclaw-my-plugin
베어 패키지 지정은 출시 전환 기간 동안 npm에서 설치합니다.
리포지터리 내 plugins: 번들된 Plugin 워크스페이스 트리 아래에 배치하면 빌드 중 자동으로 발견됩니다. 사용자는 설치할 수 있습니다:
openclaw plugins install <package-name>
npm에서 가져온 설치의 경우 openclaw plugins install은 라이프사이클 스크립트를 비활성화한 상태로 패키지를 ~/.openclaw/npm 아래에 설치합니다. Plugin 의존성 트리는 순수 JS/TS로 유지하고 postinstall 빌드가 필요한 패키지는 피하세요.
Gateway 시작은 Plugin 의존성을 설치하지 않습니다. npm/git/ClawHub 설치 흐름이 의존성 수렴을 담당하며, 로컬 plugins는 의존성이 이미 설치되어 있어야 합니다.
번들된 패키지 메타데이터는 명시적이며, Gateway 시작 시 빌드된 JavaScript에서 추론되지 않습니다. 런타임 의존성은 이를 소유한 Plugin 패키지에 속합니다. 패키징된 OpenClaw 시작은 Plugin 의존성을 복구하거나 미러링하지 않습니다.

관련 항목