English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย

Technical reference

Referencia de incorporación

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

Detalles del flujo (modo local)

  • Detección de configuración existente

    • Si ~/.openclaw/openclaw.json existe, elige Mantener / Modificar / Restablecer.
    • Volver a ejecutar la incorporación no borra nada a menos que elijas explícitamente Restablecer (o pases --reset).
    • CLI --reset usa config+creds+sessions de forma predeterminada; usa --reset-scope full para eliminar también el espacio de trabajo.
    • Si la configuración no es válida o contiene claves heredadas, el asistente se detiene y te pide ejecutar openclaw doctor antes de continuar.
    • El restablecimiento usa trash (nunca rm) y ofrece estos alcances:
      • Solo configuración
      • Configuración + credenciales + sesiones
      • Restablecimiento completo (también elimina el espacio de trabajo)

  • Modelo/Auth

    • Clave de API de Anthropic: usa ANTHROPIC_API_KEY si está presente o solicita una clave, y luego la guarda para uso del daemon.
    • Clave de API de Anthropic: opción preferida de asistente Anthropic en incorporación/configuración.
    • setup-token de Anthropic: sigue disponible en incorporación/configuración, aunque OpenClaw ahora prefiere reutilizar Claude CLI cuando está disponible.
    • Suscripción de OpenAI Code (Codex) (OAuth): flujo en el navegador; pega el code#state.
      • Define agents.defaults.model como openai-codex/gpt-5.5 cuando el modelo no está definido o ya pertenece a la familia OpenAI.
    • Suscripción de OpenAI Code (Codex) (emparejamiento de dispositivo): flujo de emparejamiento en el navegador con un código de dispositivo de corta duración.
      • Define agents.defaults.model como openai-codex/gpt-5.5 cuando el modelo no está definido o ya pertenece a la familia OpenAI.
    • Clave de API de OpenAI: usa OPENAI_API_KEY si está presente o solicita una clave, y luego la almacena en perfiles de Auth.
      • Define agents.defaults.model como openai/gpt-5.5 cuando el modelo no está definido, es openai/* o es openai-codex/*.
    • 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, obtenla en https://opencode.ai/auth) y te permite elegir el catálogo Zen o Go.
    • Ollama: primero ofrece Cloud + Local, Solo Cloud o Solo local. Cloud only solicita OLLAMA_API_KEY y usa https://ollama.com; los modos respaldados por host solicitan la URL base de Ollama, descubren los modelos disponibles y descargan automáticamente el modelo local seleccionado cuando es necesario; Cloud + Local también comprueba si ese host de Ollama tiene sesión iniciada para acceso a la nube.
    • Más detalles: Ollama
    • Clave de API: almacena la clave por ti.
    • 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 Gateway y CLOUDFLARE_AI_GATEWAY_API_KEY.
    • Más detalles: Cloudflare AI Gateway
    • MiniMax: la configuración se escribe automáticamente; el valor predeterminado alojado es MiniMax-M2.7. La configuración con clave de API usa minimax/..., y la configuración OAuth usa minimax-portal/....
    • Más detalles: MiniMax
    • StepFun: la configuración se escribe automáticamente para StepFun estándar o Step Plan en endpoints de China o globales.
    • Actualmente, Estándar incluye step-3.5-flash, y Step Plan también incluye step-3.5-flash-2603.
    • Más detalles: StepFun
    • 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: todavía no se configura Auth.
    • Elige un modelo predeterminado entre las opciones detectadas (o introduce proveedor/modelo manualmente). Para obtener la mejor calidad y reducir el riesgo de inyección de prompts, elige el modelo de última generación más potente disponible en tu pila de proveedores.
    • La incorporación ejecuta una comprobación del modelo y advierte si el modelo configurado es desconocido o no tiene Auth.
    • El modo de almacenamiento de claves de API usa de forma predeterminada valores de perfil de Auth en texto plano. Usa --secret-input-mode ref para almacenar referencias respaldadas por env en su lugar (por ejemplo keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
    • Los perfiles de Auth se encuentran en ~/.openclaw/agents/<agentId>/agent/auth-profiles.json (claves de API + OAuth). ~/.openclaw/credentials/oauth.json es solo una importación heredada.
    • Más detalles: /concepts/oauth

  • Espacio de trabajo

    • Valor predeterminado ~/.openclaw/workspace (configurable).
    • Crea los archivos del espacio de trabajo necesarios para el ritual de arranque del agente.
    • Diseño completo del espacio de trabajo + guía de copias de seguridad: Espacio de trabajo del agente

  • Gateway

    • Puerto, enlace, modo de Auth, exposición de Tailscale.
    • Recomendación de Auth: conserva Token incluso para 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 reutiliza SecretRefs existentes de gateway.auth.token entre proveedores env, file y exec para la sonda de incorporación y el arranque del panel.
      • Si ese SecretRef está configurado pero no puede resolverse, la incorporación falla pronto con un mensaje claro de corrección en lugar de degradar silenciosamente la Auth en tiempo de ejecución.
    • En modo contraseña, la configuración interactiva también admite almacenamiento en texto plano o SecretRef.
    • Ruta SecretRef de token no interactiva: --gateway-token-ref-env &lt;ENV_VAR&gt;.
      • Requiere una variable de entorno no vacía en el entorno del proceso de incorporación.
      • No se puede combinar con --gateway-token.
    • Desactiva Auth solo si confías plenamente en todos los procesos locales.
    • Los enlaces que no son loopback aún requieren Auth.

  • Canales

    • WhatsApp: inicio de sesión QR opcional.
    • Telegram: token de bot.
    • Discord: token de bot.
    • Google Chat: JSON de cuenta de servicio + audiencia de webhook.
    • Mattermost (plugin): token de 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 heredada de CLI imsg + acceso a la BD.
    • Seguridad de DM: el valor predeterminado es el emparejamiento. El primer DM envía un código; apruébalo con openclaw pairing approve <channel> <code> o usa listas de permitidos.

  • Búsqueda web

    • Elige un proveedor compatible como Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG o Tavily (u omite este paso).
    • Los proveedores respaldados por API pueden usar variables de entorno o configuración existente para una configuración rápida; los proveedores sin clave usan en su lugar sus requisitos previos específicos.
    • Omite con --skip-search.
    • Configura más tarde: openclaw configure --section web.

  • Instalación del daemon

    • macOS: LaunchAgent
      • Requiere una sesión de usuario iniciada; para entornos sin interfaz, usa un LaunchDaemon personalizado (no incluido).
    • Linux (y Windows mediante WSL2): unidad de usuario systemd
      • La incorporación intenta habilitar la permanencia con loginctl enable-linger <user> para que el Gateway permanezca activo después de cerrar sesión.
      • Puede solicitar sudo (escribe en /var/lib/systemd/linger); primero lo intenta sin sudo.
    • Selección de runtime: Node (recomendado; requerido para WhatsApp/Telegram). Bun no se recomienda.
    • Si Auth con token requiere un token y gateway.auth.token está gestionado por SecretRef, la instalación del daemon lo valida pero no persiste valores de token en texto plano resueltos en los metadatos del entorno del servicio supervisor.
    • Si Auth con token requiere un token y el SecretRef de token configurado no se resuelve, la instalación del daemon se bloquea con orientación accionable.
    • Si gateway.auth.token y gateway.auth.password están configurados y gateway.auth.mode no está definido, la instalación del daemon se bloquea hasta que el modo se establezca explícitamente.

  • Comprobación de estado

    • Inicia el Gateway (si es necesario) y ejecuta openclaw health.
    • Consejo: openclaw status --deep añade la sonda de estado en vivo del Gateway a la salida de estado, incluidas las sondas de canal cuando son compatibles (requiere un Gateway accesible).

  • Skills (recomendado)

    • Lee las Skills disponibles y comprueba los requisitos.
    • Te permite elegir un gestor de Node: npm / pnpm (bun no recomendado).
    • Instala dependencias opcionales (algunas usan Homebrew en macOS).

  • Finalizar

    • Resumen + próximos pasos, incluidas apps para iOS/Android/macOS para funciones adicionales.

    • Modo no interactivo

    Usa --non-interactive para automatizar o crear scripts de incorporación:

    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ñade --json para obtener un resumen legible por máquina.

    SecretRef de token de Gateway en modo no interactivo:

    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 de proveedor están en Automatización de CLI. Usa esta página de referencia para la semántica de flags y el orden de los pasos.

    Añadir agente (no interactivo)

    openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

    RPC del asistente de Gateway

    El Gateway expone el flujo de incorporación mediante RPC (wizard.start, wizard.next, wizard.cancel, wizard.status). Los clientes (app de macOS, Control UI) pueden renderizar pasos sin volver a implementar la lógica de incorporación.

    Configuración de Signal (signal-cli)

    La incorporación puede instalar signal-cli desde las versiones de GitHub:

    • Descarga el recurso de versión adecuado.
    • Lo almacena en ~/.openclaw/tools/signal-cli/<version>/.
    • Escribe channels.signal.cliPath en tu configuración.

    Notas:

    • Las compilaciones JVM requieren Java 21.
    • Las compilaciones nativas se usan 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

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

    • agents.defaults.workspace
    • agents.defaults.model / models.providers (si se eligió Minimax)
    • tools.profile (la configuración inicial local usa "coding" de forma predeterminada cuando no está definido; los valores explícitos existentes se conservan)
    • gateway.* (modo, enlace, autenticación, tailscale)
    • session.dmScope (detalles de 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 aceptas durante las indicaciones (los nombres se resuelven a IDs cuando es posible).
    • skills.install.nodeManager
      • setup --node-manager acepta npm, pnpm o bun.
      • La configuración manual aún puede usar yarn estableciendo skills.install.nodeManager directamente.
    • wizard.lastRunAt
    • wizard.lastRunVersion
    • wizard.lastRunCommit
    • wizard.lastRunCommand
    • wizard.lastRunMode

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

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

    Algunos canales se entregan como plugins. Cuando eliges uno durante la configuración, la incorporación te pedirá instalarlo (npm o una ruta local) antes de que pueda configurarse.

    Documentos relacionados