---
read_when:
- Estás agregando un asistente de configuración a un plugin
- Debes entender setup-entry.ts frente a index.ts
- Estás definiendo esquemas de configuración de Plugin o metadatos openclaw de package.json
sidebarTitle: Setup and config
summary: Asistentes de configuración, setup-entry.ts, esquemas de configuración y metadatos de package.json
title: Configuración e instalación de Plugin
x-i18n:
generated_at: "2026-07-04T15:08:19Z"
model: gpt-5.5
postprocess_version: locale-links-v1
provider: openai
source_hash: 0969ab2cc069389b8957b07e76591bc76fea7bee22125587fa067122d11bb024
source_path: plugins/sdk-setup.md
workflow: 16
---
Referencia para el empaquetado de Plugins (metadatos de `package.json`), manifiestos (`openclaw.plugin.json`), entradas de configuración y esquemas de configuración.
**¿Buscas una guía paso a paso?** Las guías prácticas cubren el empaquetado en contexto: [Plugins de canal](/es/plugins/sdk-channel-plugins#step-1-package-and-manifest) y [Plugins de proveedor](/es/plugins/sdk-provider-plugins#step-1-package-and-manifest).
## Metadatos del paquete
Tu `package.json` necesita un campo `openclaw` que indique al sistema de Plugins qué proporciona tu Plugin:
```json
{
"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."
}
}
}
```
```json openclaw-clawhub-package.json
{
"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"
}
}
}
```
Si publicas el Plugin externamente en ClawHub, esos campos `compat` y `build` son obligatorios. Los fragmentos canónicos de publicación están en `docs/snippets/plugin-publish/`.
### Campos de `openclaw`
Archivos de punto de entrada (relativos a la raíz del paquete).
Entrada ligera solo para configuración (opcional).
Metadatos del catálogo de canales para las superficies de configuración, selector, inicio rápido y estado.
Ids de proveedor registrados por este Plugin.
Sugerencias de instalación: `npmSpec`, `localPath`, `defaultChoice`, `minHostVersion`, `expectedIntegrity`, `allowInvalidConfigRecovery`.
Indicadores de comportamiento de inicio.
### `openclaw.channel`
`openclaw.channel` son metadatos de paquete ligeros para el descubrimiento de canales y las superficies de configuración antes de que se cargue el runtime.
| Campo | Tipo | Qué significa |
| -------------------------------------- | ---------- | ----------------------------------------------------------------------------- |
| `id` | `string` | Id canónico del canal. |
| `label` | `string` | Etiqueta principal del canal. |
| `selectionLabel` | `string` | Etiqueta del selector/configuración cuando deba diferir de `label`. |
| `detailLabel` | `string` | Etiqueta secundaria de detalle para catálogos de canales y superficies de estado más completas. |
| `docsPath` | `string` | Ruta de documentación para enlaces de configuración y selección. |
| `docsLabel` | `string` | Etiqueta alternativa usada para enlaces de documentación cuando deba diferir del id del canal. |
| `blurb` | `string` | Descripción breve para incorporación/catálogo. |
| `order` | `number` | Orden de clasificación en catálogos de canales. |
| `aliases` | `string[]` | Alias de búsqueda adicionales para la selección de canales. |
| `preferOver` | `string[]` | Ids de Plugin/canal de menor prioridad que este canal debe superar. |
| `systemImage` | `string` | Nombre opcional de icono/imagen del sistema para catálogos de UI de canal. |
| `selectionDocsPrefix` | `string` | Texto de prefijo antes de los enlaces de documentación en superficies de selección. |
| `selectionDocsOmitLabel` | `boolean` | Muestra la ruta de documentación directamente en vez de un enlace de documentación etiquetado en el texto de selección. |
| `selectionExtras` | `string[]` | Cadenas breves adicionales añadidas al texto de selección. |
| `markdownCapable` | `boolean` | Marca el canal como compatible con markdown para decisiones de formato de salida. |
| `exposure` | `object` | Controles de visibilidad del canal para configuración, listas configuradas y superficies de documentación. |
| `quickstartAllowFrom` | `boolean` | Incluye este canal en el flujo estándar de configuración de inicio rápido `allowFrom`. |
| `forceAccountBinding` | `boolean` | Requiere vinculación explícita de cuenta incluso cuando solo existe una cuenta. |
| `preferSessionLookupForAnnounceTarget` | `boolean` | Prefiere la búsqueda de sesión al resolver destinos de anuncio para este canal. |
Ejemplo:
```json
{
"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` admite:
- `configured`: incluir el canal en superficies de listado configuradas/de tipo estado
- `setup`: incluir el canal en selectores interactivos de configuración
- `docs`: marcar el canal como público en superficies de documentación/navegación
`showConfigured` y `showInSetup` siguen siendo compatibles como alias heredados. Prefiere `exposure`.
### `openclaw.install`
`openclaw.install` son metadatos de paquete, no metadatos de manifiesto.
| Campo | Tipo | Qué significa |
| ---------------------------- | ----------------------------------- | --------------------------------------------------------------------------------- |
| `clawhubSpec` | `string` | Especificación canónica de ClawHub para flujos de instalación/actualización e instalación bajo demanda durante la incorporación. |
| `npmSpec` | `string` | Especificación npm canónica para flujos de reserva de instalación/actualización. |
| `localPath` | `string` | Ruta de desarrollo local o de instalación incluida. |
| `defaultChoice` | `"clawhub"` \| `"npm"` \| `"local"` | Fuente de instalación preferida cuando hay varias fuentes disponibles. |
| `minHostVersion` | `string` | Versión mínima compatible de OpenClaw con la forma `>=x.y.z` o `>=x.y.z-prerelease`. |
| `expectedIntegrity` | `string` | Cadena de integridad esperada de npm dist, normalmente `sha512-...`, para instalaciones fijadas. |
| `allowInvalidConfigRecovery` | `boolean` | Permite que los flujos de reinstalación de Plugins incluidos se recuperen de fallos específicos de configuración obsoleta. |
| `requiredPlatformPackages` | `string[]` | Alias npm específicos de plataforma requeridos y verificados durante la instalación npm. |
La incorporación interactiva también usa `openclaw.install` para superficies de instalación bajo demanda. Si tu Plugin expone opciones de autenticación de proveedor o metadatos de configuración/catálogo de canal antes de que se cargue el runtime, la incorporación puede mostrar esa opción, pedir ClawHub, npm o instalación local, instalar o habilitar el Plugin y luego continuar el flujo seleccionado. Las opciones de incorporación de ClawHub usan `clawhubSpec` y se prefieren cuando están presentes; las opciones npm requieren metadatos de catálogo de confianza con un `npmSpec` de registro; las versiones exactas y `expectedIntegrity` son fijaciones npm opcionales. Si `expectedIntegrity` está presente, los flujos de instalación/actualización lo aplican para npm. Mantén los metadatos de "qué mostrar" en `openclaw.plugin.json` y los metadatos de "cómo instalarlo" en `package.json`.
Si se define `minHostVersion`, tanto la instalación como la carga de registros de manifiestos no incluidos lo aplican. Los hosts antiguos omiten Plugins externos; las cadenas de versión no válidas se rechazan. Se asume que los Plugins de código fuente incluidos comparten versión con el checkout del host.
Para instalaciones npm fijadas, mantén la versión exacta en `npmSpec` y añade la integridad esperada del artefacto:
```json
{
"openclaw": {
"install": {
"npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3",
"expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",
"defaultChoice": "npm"
}
}
}
```
`allowInvalidConfigRecovery` no es una omisión general para configuraciones rotas. Está diseñado solo para recuperación estrecha de Plugins incluidos, de modo que la reinstalación/configuración pueda reparar restos conocidos de actualización, como una ruta de Plugin incluido faltante o una entrada `channels.` obsoleta para ese mismo Plugin. Si la configuración está rota por motivos no relacionados, la instalación aún falla cerrada e indica al operador que ejecute `openclaw doctor --fix`.
### Carga completa diferida
Los Plugins de canal pueden optar por la carga diferida con:
```json
{
"openclaw": {
"extensions": ["./index.ts"],
"setupEntry": "./setup-entry.ts",
"startup": {
"deferConfiguredChannelFullLoadUntilAfterListen": true
}
}
}
```
Cuando está habilitado, OpenClaw carga solo `setupEntry` durante la fase de inicio previa a la escucha, incluso para canales ya configurados. La entrada completa se carga después de que el Gateway empieza a escuchar.
Habilita la carga diferida solo cuando tu `setupEntry` registre todo lo que el Gateway necesita antes de empezar a escuchar (registro del canal, rutas HTTP, métodos del Gateway). Si la entrada completa posee capacidades de inicio requeridas, mantén el comportamiento predeterminado.
Si tu entrada de configuración/completa registra métodos RPC del Gateway, mantenlos con un prefijo específico del Plugin. Los espacios de nombres reservados de administración del núcleo (`config.*`, `exec.approvals.*`, `wizard.*`, `update.*`) siguen siendo propiedad del núcleo y siempre se resuelven como `operator.admin`.
## Manifiesto del Plugin
Todo Plugin nativo debe incluir un `openclaw.plugin.json` en la raíz del paquete. OpenClaw lo usa para validar la configuración sin ejecutar código del Plugin.
```json
{
"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"
}
}
}
}
```
Para Plugins de canal, añade `kind` y `channels`:
```json
{
"id": "my-channel",
"kind": "channel",
"channels": ["my-channel"],
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {}
}
}
```
Incluso los plugins sin configuración deben incluir un esquema. Un esquema vacío es válido:
```json
{
"id": "my-plugin",
"configSchema": {
"type": "object",
"additionalProperties": false
}
}
```
Consulta [manifiesto de Plugin](/es/plugins/manifest) para ver la referencia completa del esquema.
## Publicación en ClawHub
Para paquetes de plugin, usa el comando de ClawHub específico del paquete:
```bash
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
```
El alias de publicación heredado exclusivo para Skills es para Skills. Los paquetes de Plugin siempre deben usar `clawhub package publish`.
## Entrada de configuración
El archivo `setup-entry.ts` es una alternativa ligera a `index.ts` que OpenClaw carga cuando solo necesita superficies de configuración (incorporación, reparación de configuración, inspección de canales deshabilitados).
```typescript
// setup-entry.ts
import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { myChannelPlugin } from "./src/channel.js";
export default defineSetupPluginEntry(myChannelPlugin);
```
Esto evita cargar código de runtime pesado (bibliotecas criptográficas, registros de CLI, servicios en segundo plano) durante los flujos de configuración.
Los canales del workspace incluidos que mantienen exportaciones seguras para la configuración en módulos auxiliares pueden usar `defineBundledChannelSetupEntry(...)` desde `openclaw/plugin-sdk/channel-entry-contract` en lugar de `defineSetupPluginEntry(...)`. Ese contrato incluido también admite una exportación opcional `runtime` para que el cableado de runtime durante la configuración pueda seguir siendo ligero y explícito.
- El canal está deshabilitado pero necesita superficies de configuración/incorporación.
- El canal está habilitado pero no está configurado.
- La carga diferida está habilitada (`deferConfiguredChannelFullLoadUntilAfterListen`).
- El objeto de plugin de canal (mediante `defineSetupPluginEntry`).
- Cualquier ruta HTTP necesaria antes de que el gateway escuche.
- Cualquier método de gateway necesario durante el arranque.
Esos métodos de gateway de arranque aun así deben evitar namespaces de administración centrales reservados como `config.*` o `update.*`.
- Registros de CLI.
- Servicios en segundo plano.
- Importaciones de runtime pesadas (criptografía, SDKs).
- Métodos de Gateway que solo se necesitan después del arranque.
### Importaciones estrechas de helpers de configuración
Para rutas activas solo de configuración, prefiere las interfaces estrechas de helpers de configuración en lugar del paraguas más amplio `plugin-sdk/setup` cuando solo necesites parte de la superficie de configuración:
| Ruta de importación | Para qué se usa | Exportaciones clave |
| ---------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugin-sdk/setup-runtime` | helpers de runtime de configuración disponibles en `setupEntry` / arranque diferido del canal | `createSetupTranslator`, `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` |
| `plugin-sdk/setup-adapter-runtime` | alias de compatibilidad obsoleto; usa `plugin-sdk/setup-runtime` | `createEnvPatchedAccountSetupAdapter` |
| `plugin-sdk/setup-tools` | helpers de CLI/archivo/docs para configuración/instalación | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
Usa la interfaz más amplia `plugin-sdk/setup` cuando quieras la caja de herramientas compartida completa de configuración, incluidos helpers de parches de configuración como `moveSingleAccountChannelSectionToDefaultAccount(...)`.
Usa `createSetupTranslator(...)` para texto fijo del asistente de configuración. Sigue la
configuración regional del asistente de CLI (`OPENCLAW_LOCALE`, luego las variables de configuración regional del sistema) y recurre
al inglés. Mantén el texto de configuración específico del plugin en código propiedad del plugin y usa
claves de catálogo compartidas solo para etiquetas comunes de configuración, texto de estado y texto de configuración de
plugins oficiales incluidos.
Los adaptadores de parches de configuración siguen siendo seguros para rutas activas al importarse. Su búsqueda de superficie de contrato de promoción de cuenta única incluida es perezosa, por lo que importar `plugin-sdk/setup-runtime` no carga de forma anticipada el descubrimiento de superficies de contrato incluidas antes de que el adaptador se use realmente.
### Promoción de cuenta única propiedad del canal
Cuando un canal actualiza una configuración de nivel superior de cuenta única a `channels..accounts.*`, el comportamiento compartido predeterminado es mover los valores promocionados con alcance de cuenta a `accounts.default`.
Los canales incluidos pueden restringir o sobrescribir esa promoción mediante su superficie de contrato de configuración:
- `singleAccountKeysToMove`: claves de nivel superior adicionales que deben moverse a la cuenta promocionada
- `namedAccountPromotionKeys`: cuando ya existen cuentas con nombre, solo estas claves se mueven a la cuenta promocionada; las claves compartidas de política/entrega permanecen en la raíz del canal
- `resolveSingleAccountPromotionTarget(...)`: elige qué cuenta existente recibe los valores promocionados
Matrix es el ejemplo incluido actual. Si ya existe exactamente una cuenta Matrix con nombre, o si `defaultAccount` apunta a una clave no canónica existente como `Ops`, la promoción conserva esa cuenta en lugar de crear una nueva entrada `accounts.default`.
## Esquema de configuración
La configuración del Plugin se valida contra el esquema JSON de tu manifiesto. Los usuarios configuran plugins mediante:
```json5
{
plugins: {
entries: {
"my-plugin": {
config: {
webhookSecret: "abc123",
},
},
},
},
}
```
Tu plugin recibe esta configuración como `api.pluginConfig` durante el registro.
Para configuración específica de canal, usa en su lugar la sección de configuración del canal:
```json5
{
channels: {
"my-channel": {
token: "bot-token",
allowFrom: ["user1", "user2"],
},
},
}
```
### Crear esquemas de configuración de canal
Usa `buildChannelConfigSchema` para convertir un esquema de Zod en el contenedor `ChannelConfigSchema` usado por artefactos de configuración propiedad del plugin:
```typescript
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);
```
Si ya escribes el contrato como JSON Schema o TypeBox, usa el helper directo para que OpenClaw pueda omitir la conversión de Zod a JSON Schema en rutas de metadatos:
```typescript
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())),
}),
);
```
Para plugins de terceros, el contrato de ruta fría sigue siendo el manifiesto del plugin: refleja el JSON Schema generado en `openclaw.plugin.json#channelConfigs` para que las superficies de esquema de configuración, configuración y UI puedan inspeccionar `channels.` sin cargar código de runtime.
## Asistentes de configuración
Los plugins de canal pueden proporcionar asistentes de configuración interactivos para `openclaw onboard`. El asistente es un objeto `ChannelSetupWizard` en el `ChannelPlugin`:
```typescript
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),
};
},
},
],
};
```
El tipo `ChannelSetupWizard` admite `credentials`, `textInputs`, `dmPolicy`, `allowFrom`, `groupAccess`, `prepare`, `finalize` y más. Consulta los paquetes de plugins incluidos (por ejemplo, el plugin de Discord `src/channel.setup.ts`) para ver ejemplos completos.
Para prompts de listas de permitidos de DM que solo necesitan el flujo estándar `note -> prompt -> parse -> merge -> patch`, prefiere los helpers de configuración compartidos de `openclaw/plugin-sdk/setup`: `createPromptParsedAllowFromForAccount(...)`, `createTopLevelChannelParsedAllowFromPrompt(...)` y `createNestedChannelParsedAllowFromPrompt(...)`.
Para bloques de estado de configuración de canal que solo varían por etiquetas, puntuaciones y líneas adicionales opcionales, prefiere `createStandardChannelSetupStatus(...)` desde `openclaw/plugin-sdk/setup` en lugar de crear manualmente el mismo objeto `status` en cada plugin.
Para superficies de configuración opcionales que solo deben aparecer en ciertos contextos, usa `createOptionalChannelSetupSurface` desde `openclaw/plugin-sdk/channel-setup`:
```typescript
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` también expone los constructores de nivel inferior `createOptionalChannelSetupAdapter(...)` y `createOptionalChannelSetupWizard(...)` cuando solo necesitas una mitad de esa superficie de instalación opcional.
El adaptador/asistente opcional generado falla cerrado en escrituras de configuración reales. Reutiliza un mensaje de instalación requerida entre `validateInput`, `applyAccountConfig` y `finalize`, y agrega un enlace a docs cuando `docsPath` está definido.
Para UI de configuración respaldadas por binario, prefiere los helpers delegados compartidos en lugar de copiar el mismo pegamento de binario/estado en cada canal:
- `createDetectedBinaryStatus(...)` para bloques de estado que varían solo por etiquetas, sugerencias, puntuaciones y detección binaria
- `createCliPathTextInput(...)` para entradas de texto respaldadas por rutas
- `createDelegatedSetupWizardStatusResolvers(...)`, `createDelegatedPrepare(...)`, `createDelegatedFinalize(...)` y `createDelegatedResolveConfigured(...)` cuando `setupEntry` necesita reenviar de forma diferida a un asistente completo más pesado
- `createDelegatedTextInputShouldPrompt(...)` cuando `setupEntry` solo necesita delegar una decisión de `textInputs[*].shouldPrompt`
## Publicación e instalación
**Plugins externos:** publica en [ClawHub](/clawhub) y luego instala:
```bash
openclaw plugins install @myorg/openclaw-my-plugin
```
Las especificaciones de paquetes sin prefijo se instalan desde npm durante la transición de lanzamiento.
```bash
openclaw plugins install clawhub:@myorg/openclaw-my-plugin
```
Usa npm cuando un paquete aún no se haya movido a ClawHub, o cuando necesites una
ruta directa de instalación de npm durante la migración:
```bash
openclaw plugins install npm:@myorg/openclaw-my-plugin
```
**Plugins dentro del repositorio:** colócalos bajo el árbol de espacio de trabajo de plugins incluidos y se detectarán automáticamente durante la compilación.
**Los usuarios pueden instalar:**
```bash
openclaw plugins install
```
Para instalaciones procedentes de npm, `openclaw plugins install` instala el paquete en un proyecto por plugin bajo `~/.openclaw/npm/projects` con los scripts de ciclo de vida deshabilitados. Mantén los árboles de dependencias del plugin en JS/TS puro y evita paquetes que requieran compilaciones de `postinstall`.
El inicio de Gateway no instala dependencias de plugins. Los flujos de instalación npm/git/ClawHub son responsables de la convergencia de dependencias; los plugins locales ya deben tener sus dependencias instaladas.
Los metadatos de paquetes incluidos son explícitos, no se infieren del JavaScript compilado al iniciar Gateway. Las dependencias en tiempo de ejecución pertenecen al paquete de plugin que las posee; el inicio de OpenClaw empaquetado nunca repara ni replica dependencias de plugins.
## Relacionado
- [Creación de plugins](/es/plugins/building-plugins) — guía de introducción paso a paso
- [Manifiesto de Plugin](/es/plugins/manifest) — referencia completa del esquema del manifiesto
- [Puntos de entrada del SDK](/es/plugins/sdk-entrypoints) — `definePluginEntry` y `defineChannelPluginEntry`