Ir al contenido
OpenClaw Docs

Referencia de integración

Referencia de integración

Sección titulada «Referencia de integración»

Esta es la referencia completa de openclaw onboard. Para obtener una descripción general de alto nivel, consulte Onboarding (CLI).

Detalles del flujo (modo local)

Sección titulada «Detalles del flujo (modo local)»

  1. Detección de configuración existente

    • Si ~/.openclaw/openclaw.json existe, elija Conservar / Modificar / Restablecer.
    • Volver a ejecutar la integración no borra nada a menos que elija explícitamente Restablecer (o pase --reset).
    • El indicador --reset de la CLI por defecto es config+creds+sessions; use --reset-scope full para también eliminar el espacio de trabajo.
    • Si la configuración no es válida o contiene claves heredadas, el asistente se detiene y le pide que ejecute openclaw doctor antes de continuar.
    • Restablecer usa trash (nunca rm) y ofrece ámbitos:
      • Solo configuración
      • Configuración + credenciales + sesiones
      • Restablecimiento completo (también elimina el espacio de trabajo)

  2. Model/Auth

    • Clave de API de Anthropic: usa ANTHROPIC_API_KEY si está presente o solicita una clave, luego la guarda para uso del demonio.
    • CLI de Anthropic Claude: en la incorporación de macOS, verifica el elemento del Llavero “Claude Code-credentials” (elija “Permitir siempre” para que los inicios de launchd no se bloqueen); en Linux/Windows reutiliza ~/.claude/.credentials.json si está presente y cambia la selección del modelo a claude-cli/....
    • Token de Anthropic (pegar setup-token): ejecute claude setup-token en cualquier máquina, luego pegue el token (puede nombrarlo; en blanco = predeterminado).
    • Suscripción a OpenAI Code (Codex) (CLI de Codex): si ~/.codex/auth.json existe, la incorporación puede reutilizarla.
    • Suscripción a OpenAI Code (Codex) (OAuth): flujo del navegador; pegue el code#state.
      • Establece agents.defaults.model en openai-codex/gpt-5.2 cuando el modelo no está configurado o openai/*.
    • Clave de API de OpenAI: usa OPENAI_API_KEY si está presente o solicita una clave, luego la almacena en perfiles de autenticación.
    • Clave de API de xAI (Grok): solicita XAI_API_KEY y configura xAI como proveedor de modelos.
    • OpenCode: solicita OPENCODE_API_KEY (o OPENCODE_ZEN_API_KEY, consígalo en https://opencode.ai/auth) y le permite elegir el catálogo Zen o Go.
    • Ollama: solicita la URL base de Ollama, ofrece el modo Nube + Local o Local, descubre los modelos disponibles y descarga automáticamente el modelo local seleccionado cuando sea necesario.
    • Más detalles: Ollama
    • Clave de API: almacena la clave por usted.
    • Vercel AI Gateway (proxy multimodelo): solicita AI_GATEWAY_API_KEY.
    • Más detalles: Vercel AI Gateway
    • Cloudflare AI Gateway: solicita el ID de cuenta, el ID de puerta de enlace y CLOUDFLARE_AI_GATEWAY_API_KEY.
    • Más detalles: Cloudflare AI Gateway
    • MiniMax: la configuración se escribe automáticamente; el alojamiento predeterminado es MiniMax-M2.7.
    • Más detalles: MiniMax
    • Synthetic (compatible con Anthropic): solicita SYNTHETIC_API_KEY.
    • Más detalles: Synthetic
    • Moonshot (Kimi K2): la configuración se escribe automáticamente.
    • Kimi Coding: la configuración se escribe automáticamente.
    • Más detalles: Moonshot AI (Kimi + Kimi Coding)
    • Omitir: aún no se ha configurado la autenticación.
    • Elija un modelo predeterminado de las opciones detectadas (o ingrese el proveedor/modelo manualmente). Para obtener la mejor calidad y un menor riesgo de inyección de indicaciones, elija el modelo de última generación más fuerte disponible en su pila de proveedores.
    • La incorporación ejecuta una verificación del modelo y advierte si el modelo configurado es desconocido o falta la autenticación.
    • El modo de almacenamiento de clave de API predeterminado son valores de perfil de autenticación en texto plano. Use --secret-input-mode ref para almacenar referencias respaldadas por variables de entorno en su lugar (por ejemplo, keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
    • Las credenciales de OAuth residen en ~/.openclaw/credentials/oauth.json; los perfiles de autenticación residen en `~/.openclaw/agents/

    /agent/auth-profiles.json` (claves de API + OAuth). - Más detalles: /concepts/oauth

  3. Workspace

    • Predeterminado ~/.openclaw/workspace (configurable).
    • Inicializa los archivos del espacio de trabajo necesarios para el ritual de arranque del agente.
    • Diseño completo del espacio de trabajo + guía de respaldo: Agente espacio de trabajo

  4. Gateway

    • Puerto, enlace, modo de autenticación, exposición de tailscale.
    • Recomendación de autenticación: mantenga Token incluso para el bucle local (loopback) para que los clientes WS locales deban autenticarse.
    • En modo token, la configuración interactiva ofrece:
      • Generar/almacenar token en texto plano (predeterminado)
      • Usar SecretRef (opcional)
      • El inicio rápido (Quickstart) reutiliza los SecretRefs gateway.auth.token existentes en los proveedores env, file y exec para el arranque del sondeador/panel (probe/dashboard) de incorporación.
      • Si ese SecretRef está configurado pero no se puede resolver, la incorporación falla temprano con un mensaje claro de reparación en lugar de degradar silenciosamente la autenticación en tiempo de ejecución.
    • En modo contraseña, la configuración interactiva también admite almacenamiento en texto plano o SecretRef.
    • Ruta de SecretRef de token no interactivo: `—gateway-token-ref-env

    . - Requiere una variable de entorno no vacía en el entorno del proceso de incorporación. - No se puede combinar con —gateway-token`. - Desactive la autenticación solo si confía completamente en cada proceso local. - Los enlaces que no sean de bucle local (non‑loopback) aún requieren autenticación.

  5. Channels

    • WhatsApp: inicio de sesión QR opcional.
    • Telegram: token del bot.
    • Discord: token del bot.
    • Google Chat: cuenta de servicio JSON + audiencia del webhook.
    • Mattermost (plugin): token del bot + URL base.
    • Signal: instalación opcional de signal-cli + configuración de cuenta.
    • BlueBubbles: recomendado para iMessage; URL del servidor + contraseña + webhook.
    • iMessage: ruta CLI heredada de imsg + acceso a la base de datos.
    • Seguridad de MD: el valor predeterminado es el emparejamiento. El primer DM envía un código; apruébalo a través de `openclaw pairing approve

    ` o usa listas permitidas.

Modo no interactivo

Sección titulada «Modo no interactivo»

Use --non-interactive para automatizar o crear secuencias de comandos del onboarding:

Ventana de terminal
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills

Añada --json para obtener un resumen legible por máquina.

SecretRef del token de Gateway en modo no interactivo:

Ventana de terminal
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN

--gateway-token y --gateway-token-ref-env son mutuamente excluyentes.

Los ejemplos de comandos específicos del proveedor se encuentran en Automatización de CLI. Utilice esta página de referencia para la semántica de las banderas y el orden de los pasos.

Añadir agente (no interactivo)

Sección titulada «Añadir agente (no interactivo)»
Ventana de terminal
openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.2 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

Asistente del Gateway RPC

Sección titulada «Asistente del Gateway RPC»

La Gateway expone el flujo de incorporación a través de RPC (wizard.start, wizard.next, wizard.cancel, wizard.status). Los clientes (aplicación macOS, Interfaz de Control) pueden representar los pasos sin volver a implementar la lógica de incorporación.

Configuración de Signal (signal-cli)

Sección titulada «Configuración de Signal (signal-cli)»

La incorporación puede instalar signal-cli desde los lanzamientos de GitHub:

  • Descarga el activo de lanzamiento adecuado.
  • Lo guarda bajo ~/.openclaw/tools/signal-cli/<version>/.
  • Escribe channels.signal.cliPath en su configuración.

Notas:

  • Las compilaciones de JVM requieren Java 21.
  • Se utilizan compilaciones nativas cuando están disponibles.
  • Windows usa WSL2; la instalación de signal-cli sigue el flujo de Linux dentro de WSL.

Lo que escribe el asistente

Sección titulada «Lo que escribe el asistente»

Campos típicos en ~/.openclaw/openclaw.json:

  • agents.defaults.workspace
  • agents.defaults.model / models.providers (si se elige Minimax)
  • tools.profile (la incorporación local por defecto es "coding" cuando no está establecido; los valores explícitos existentes se conservan)
  • gateway.* (modo, bind, auth, tailscale)
  • session.dmScope (detalles del comportamiento: Referencia de configuración de CLI)
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • Listas de permitidos de canales (Slack/Discord/Matrix/Microsoft Teams) cuando opta por participar durante las indicaciones (los nombres se resuelven en ID cuando es posible).
  • skills.install.nodeManager
  • wizard.lastRunAt
  • wizard.lastRunVersion
  • wizard.lastRunCommit
  • wizard.lastRunCommand
  • wizard.lastRunMode

openclaw agents add escribe agents.list[] y bindings opcional.

Las credenciales de WhatsApp van en ~/.openclaw/credentials/whatsapp/<accountId>/. Las sesiones se almacenan en ~/.openclaw/agents/<agentId>/sessions/.

Algunos canales se entregan como complementos. Cuando seleccionas uno durante la configuración, la incorporación solicitará instalarlo (npm o una ruta local) antes de que pueda ser configurado.

Documentos relacionados

Sección titulada «Documentos relacionados»