From b3cfedf31288de0abb88d598272063655b299834 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 15:48:27 +0100 Subject: [PATCH] docs: refresh registration mode mirror refs --- docs/plugins/sdk-overview.md | 28 ++++++++++++++-------------- docs/plugins/sdk-runtime.md | 18 +++++++++--------- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/plugins/sdk-overview.md b/docs/plugins/sdk-overview.md index bff2a9c68ba..f51d2be5b48 100644 --- a/docs/plugins/sdk-overview.md +++ b/docs/plugins/sdk-overview.md @@ -399,20 +399,20 @@ AI CLI backend such as `claude-cli` or `codex-cli`. ### API object fields -| Field | Type | Description | -| ------------------------ | ------------------------- | -------------------------------------------------------------------------- | -| `api.id` | `string` | Plugin id | -| `api.name` | `string` | Display name | -| `api.version` | `string?` | Plugin version (optional) | -| `api.description` | `string?` | Plugin description (optional) | -| `api.source` | `string` | Plugin source path | -| `api.rootDir` | `string?` | Plugin root directory (optional) | -| `api.config` | `OpenClawConfig` | Current config snapshot (active in-memory runtime snapshot when available) | -| `api.pluginConfig` | `Record` | Plugin-specific config from `plugins.entries..config` | -| `api.runtime` | `PluginRuntime` | [Runtime helpers](/plugins/sdk-runtime) | -| `api.logger` | `PluginLogger` | Scoped logger (`debug`, `info`, `warn`, `error`) | -| `api.registrationMode` | `PluginRegistrationMode` | `"full"`, `"setup-only"`, `"setup-runtime"`, or `"cli-metadata"` | -| `api.resolvePath(input)` | `(string) => string` | Resolve path relative to plugin root | +| Field | Type | Description | +| ------------------------ | ------------------------- | ------------------------------------------------------------------------------------------- | +| `api.id` | `string` | Plugin id | +| `api.name` | `string` | Display name | +| `api.version` | `string?` | Plugin version (optional) | +| `api.description` | `string?` | Plugin description (optional) | +| `api.source` | `string` | Plugin source path | +| `api.rootDir` | `string?` | Plugin root directory (optional) | +| `api.config` | `OpenClawConfig` | Current config snapshot (active in-memory runtime snapshot when available) | +| `api.pluginConfig` | `Record` | Plugin-specific config from `plugins.entries..config` | +| `api.runtime` | `PluginRuntime` | [Runtime helpers](/plugins/sdk-runtime) | +| `api.logger` | `PluginLogger` | Scoped logger (`debug`, `info`, `warn`, `error`) | +| `api.registrationMode` | `PluginRegistrationMode` | Current load mode; `"setup-runtime"` is the lightweight pre-full-entry startup/setup window | +| `api.resolvePath(input)` | `(string) => string` | Resolve path relative to plugin root | ## Internal module convention diff --git a/docs/plugins/sdk-runtime.md b/docs/plugins/sdk-runtime.md index bf4dbe6a7e6..17a36cfcb25 100644 --- a/docs/plugins/sdk-runtime.md +++ b/docs/plugins/sdk-runtime.md @@ -364,15 +364,15 @@ export function tryGetRuntime() { Beyond `api.runtime`, the API object also provides: -| Field | Type | Description | -| ------------------------ | ------------------------- | -------------------------------------------------------------------------- | -| `api.id` | `string` | Plugin id | -| `api.name` | `string` | Plugin display name | -| `api.config` | `OpenClawConfig` | Current config snapshot (active in-memory runtime snapshot when available) | -| `api.pluginConfig` | `Record` | Plugin-specific config from `plugins.entries..config` | -| `api.logger` | `PluginLogger` | Scoped logger (`debug`, `info`, `warn`, `error`) | -| `api.registrationMode` | `PluginRegistrationMode` | `"full"`, `"setup-only"`, `"setup-runtime"`, or `"cli-metadata"` | -| `api.resolvePath(input)` | `(string) => string` | Resolve a path relative to the plugin root | +| Field | Type | Description | +| ------------------------ | ------------------------- | ------------------------------------------------------------------------------------------- | +| `api.id` | `string` | Plugin id | +| `api.name` | `string` | Plugin display name | +| `api.config` | `OpenClawConfig` | Current config snapshot (active in-memory runtime snapshot when available) | +| `api.pluginConfig` | `Record` | Plugin-specific config from `plugins.entries..config` | +| `api.logger` | `PluginLogger` | Scoped logger (`debug`, `info`, `warn`, `error`) | +| `api.registrationMode` | `PluginRegistrationMode` | Current load mode; `"setup-runtime"` is the lightweight pre-full-entry startup/setup window | +| `api.resolvePath(input)` | `(string) => string` | Resolve a path relative to the plugin root | ## Related