Saltar al contenido principal

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.

Esta es la referencia completa para openclaw onboard. Para una vista general de alto nivel, consulta Onboarding (CLI).

​
Detalles del flujo (modo local)

1

Detección de configuración existente

  • Si ~/.openclaw/openclaw.json existe, elige Mantener valores actuales, Revisar y actualizar o Restablecer antes de configurar.
  • Volver a ejecutar el onboarding 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 que ejecutes openclaw doctor antes de continuar.
  • El restablecimiento usa trash (nunca rm) y ofrece alcances:
    • Solo configuración
    • Configuración + credenciales + sesiones
    • Restablecimiento completo (también elimina el espacio de trabajo)
2

Modelo/Auth

  • Clave de API de Anthropic: usa ANTHROPIC_API_KEY si está presente o solicita una clave, y luego la guarda para el uso del daemon.
  • Clave de API de Anthropic: opción de asistente Anthropic preferida en onboarding/configure.
  • setup-token de Anthropic: sigue disponible en onboarding/configure, aunque OpenClaw ahora prefiere reutilizar Claude CLI cuando esté disponible.
  • Suscripción a OpenAI Code (Codex) (OAuth): flujo de navegador; pega el code#state.
    • Establece agents.defaults.model en openai/gpt-5.5 mediante el runtime de Codex cuando el modelo no está definido o ya pertenece a la familia OpenAI.
  • Suscripción a OpenAI Code (Codex) (emparejamiento de dispositivo): flujo de emparejamiento en navegador con un código de dispositivo de corta duración.
    • Establece agents.defaults.model en openai/gpt-5.5 mediante el runtime de Codex 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.
    • Establece agents.defaults.model en openai/gpt-5.5 cuando el modelo no está definido, es openai/* u 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, consíguela en https://opencode.ai/auth) y te permite elegir el catálogo Zen o Go.
  • Ollama: ofrece primero Nube + Local, Solo nube 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, detectan los modelos disponibles y descargan automáticamente el modelo local seleccionado cuando hace falta; Cloud + Local también comprueba si ese host de Ollama ha iniciado sesión para el acceso en 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 con 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, Standard 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: aún no se ha configurado auth.
  • Elige un modelo predeterminado de 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 más potente de última generación disponible en tu pila de proveedores.
  • El onboarding ejecuta una comprobación de modelo y advierte si el modelo configurado es desconocido o no tiene auth.
  • El modo de almacenamiento de claves de API usa valores de perfil de auth en texto sin formato de forma predeterminada. Usa --secret-input-mode ref para almacenar en su lugar referencias respaldadas por env (por ejemplo keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
  • Los perfiles de auth están en ~/.openclaw/agents/<agentId>/agent/auth-profiles.json (claves de API + OAuth). ~/.openclaw/credentials/oauth.json solo es una importación heredada.
  • Más detalles: /concepts/oauth
Consejo para servidores/headless: completa OAuth en una máquina con navegador y luego copia el auth-profiles.json de ese agente (por ejemplo ~/.openclaw/agents/<agentId>/agent/auth-profiles.json, o la ruta coincidente $OPENCLAW_STATE_DIR/...) al host del Gateway. credentials/oauth.json es solo una fuente de importación heredada.
3

Espacio de trabajo

  • Valor 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 copias de seguridad: Espacio de trabajo del agente
4

Gateway

  • Puerto, enlace, modo de auth, exposición de tailscale.
  • Recomendación de auth: mantén Token incluso para loopback, de modo que los clientes WS locales tengan que autenticarse.
  • En modo token, la configuración interactiva ofrece:
    • Generar/almacenar token en texto sin formato (predeterminado)
    • Usar SecretRef (opt-in)
    • Quickstart reutiliza SecretRefs existentes de gateway.auth.token entre proveedores env, file y exec para la prueba de onboarding/arranque del panel.
    • Si ese SecretRef está configurado pero no puede resolverse, el onboarding falla pronto con un mensaje de corrección claro en lugar de degradar silenciosamente la auth en runtime.
  • En modo contraseña, la configuración interactiva también admite almacenamiento en texto sin formato o SecretRef.
  • Ruta SecretRef de token no interactiva: --gateway-token-ref-env <ENV_VAR>.
    • Requiere una variable env no vacía en el entorno del proceso de onboarding.
    • No puede combinarse con --gateway-token.
  • Desactiva auth solo si confías plenamente en todos los procesos locales.
  • Los enlaces que no son loopback siguen requiriendo auth.
5

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.
  • iMessage: ruta de CLI imsg + acceso a la base de datos de Messages; usa un contenedor SSH cuando el Gateway se ejecute fuera de Mac.
  • Seguridad de DM: el valor predeterminado es emparejamiento. El primer DM envía un código; apruébalo mediante openclaw pairing approve <channel> <code> o usa listas de permitidos.
6

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).
  • Los proveedores respaldados por API pueden usar variables env o configuración existente para una configuración rápida; los proveedores sin clave usan en su lugar sus prerrequisitos específicos.
  • Omite con --skip-search.
  • Configura más tarde: openclaw configure --section web.
7

Instalación del daemon

  • macOS: LaunchAgent
    • Requiere una sesión de usuario iniciada; para headless, usa un LaunchDaemon personalizado (no incluido).
  • Linux (y Windows mediante WSL2): unidad de usuario systemd
    • El onboarding intenta habilitar la permanencia mediante loginctl enable-linger <user> para que el Gateway siga 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 la auth por 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 resueltos en texto sin formato en los metadatos del entorno del servicio supervisor.
  • Si la auth por 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 tanto gateway.auth.token como 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 defina explícitamente.
8

Comprobación de estado

  • Inicia el Gateway (si hace falta) y ejecuta openclaw health.
  • Consejo: openclaw status --deep añade la prueba de estado del gateway en vivo a la salida de estado, incluidas las pruebas de canales cuando se admiten (requiere un gateway alcanzable).
9

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).
10

Finalizar

  • Resumen + próximos pasos, incluido el prompt ¿Cómo quieres incubar tu agente? para Terminal, navegador o más tarde.
Si no se detecta GUI, el onboarding imprime instrucciones de reenvío de puerto SSH para la Control UI en lugar de abrir un navegador. Si faltan los recursos de la Control UI, el onboarding intenta compilarlos; la alternativa es pnpm ui:build (instala automáticamente las dependencias de la UI).

​
Modo no interactivo

Usa --non-interactive para automatizar o crear scripts para el onboarding: 
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 del 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.
--json no implica modo no interactivo. Usa --non-interactive (y --workspace) para scripts.
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 onboarding 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 onboarding.

​
Configuración de Signal (signal-cli)

El onboarding puede instalar signal-cli desde las releases de GitHub:
  • Descarga el recurso de release 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.

​
Qué 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 usa "coding" de forma predeterminada cuando no está definido; los valores explícitos existentes se conservan)
  • gateway.* (mode, bind, auth, 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 ID 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