CLI commands
Incorporación
openclaw onboard
Configuración guiada que establece primero la inferencia: detecta el acceso existente a la IA,
requiere una finalización en vivo, conserva solo la ruta que funciona y, a continuación, inicia
OpenClaw para configurar el resto. openclaw setup accede a este flujo en sistemas nuevos
o siempre que haya una opción de incorporación; los sistemas configurados usan
openclaw setup sin argumentos para el chat del agente del sistema. openclaw setup --baseline solo
escribe la configuración y el espacio de trabajo de referencia.
Guía paso a paso del flujo interactivo de la CLI.
Cómo se integran las distintas partes de la incorporación de OpenClaw.
Resultados, funcionamiento interno y comportamiento de cada paso.
Indicadores no interactivos y configuraciones mediante scripts.
Flujo de incorporación de la aplicación de la barra de menús de macOS.
Ejemplos
openclaw onboardopenclaw onboard --tuiopenclaw onboard --classicopenclaw onboard --modernopenclaw onboard --flow quickstartopenclaw onboard --flow manualopenclaw onboard --flow importopenclaw onboard --import-from hermes --import-source ~/.hermesopenclaw onboard --skip-bootstrapopenclaw onboard recommendations --jsonopenclaw onboard recommendations acknowledgeopenclaw onboard recommendations acknowledge --retry "<failed-id>"openclaw onboard recommendations refreshopenclaw onboard --mode remote --remote-url wss://gateway-host:18789openclaw onboard recommendations lee las coincidencias pendientes de recomendaciones de aplicaciones
almacenadas durante la incorporación. Añada --json para obtener la lista legible por máquinas que utiliza
el arranque de la primera ejecución. El comando no vuelve a analizar las aplicaciones instaladas ni llama a un
modelo. Su salida contiene únicamente los ID de instalación validados, el origen y el nivel; omite
intencionadamente el texto no confiable del marketplace, los motivos del modelo y las etiquetas locales de las
aplicaciones. Después de responder a la oferta de recomendaciones, el comando devuelve
una lista vacía y las futuras ejecuciones de incorporación omiten el paso por completo.
openclaw onboard recommendations refresh borra la oferta almacenada para que la siguiente
ejecución de incorporación vuelva a analizar las aplicaciones instaladas y cree una oferta nueva.
Los espacios de trabajo nuevos aplazan la selección de recomendaciones hasta la conversación de arranque.
Después de que esa conversación gestione las elecciones del usuario,
openclaw onboard recommendations acknowledge marca la oferta almacenada como respondida.
La confirmación es idempotente. Si falla una instalación elegida, pase cada
ID opaco fallido mediante --retry <id...>; las coincidencias correctas y rechazadas se consumen,
mientras que las fallidas permanecen pendientes para una ejecución de incorporación posterior. Los ID desconocidos
producen un error sin modificar la oferta almacenada. Después de interrumpirse la instalación de una skill de ClawHub,
un destino existente solo se considera correcto cuando
openclaw skills verify "@owner/slug" se ejecuta correctamente para el mismo
ID de recomendación calificado por el publicador y su salida JSON indica
openclaw.resolution.source: "installed". La verificación del registro por sí sola no
demuestra que exista una instalación local. De lo contrario, mantenga ese ID pendiente mediante --retry y no
sobrescriba la skill existente.
--classic: abre el asistente completo paso a paso. No se puede combinar con--non-interactive; omita--classicpara la configuración automatizada.--flow quickstart: abre el asistente clásico con un número mínimo de solicitudes, usa autenticación mediante token de forma predeterminada y genera un token cuando no se aplica ninguna credencial almacenada o explícita. Los indicadores explícitos del Gateway local, como--gateway-port,--gateway-bind,--gateway-authy--tailscale, sustituyen los valores correspondientes almacenados o predeterminados del inicio rápido; las opciones omitidas conservan sus valores actuales.--flow manual(aliasadvanced): abre el asistente clásico con todas las solicitudes de puerto, enlace y autenticación.--flow import: ejecuta un proveedor de migración detectado (por ejemplo, Hermes mediante--import-from hermes) en una configuración nueva. Tras la confirmación, la incorporación prepara la configuración, las credenciales, los archivos del espacio de trabajo, la memoria y las skills en destinos temporales privados; la inferencia importada debe superar una finalización en vivo antes de promover el espacio de trabajo y el estado del agente y confirmar la configuración. Un fallo o una cancelación antes de la promoción no modifica el destino activo. Los pasos de activación externos que no se pueden revertir, como la instalación del Plugin de Codex, se ejecutan después y se pueden volver a intentar desde el informe de migración. Restablezca primero la configuración, las credenciales, las sesiones y el estado del espacio de trabajo si existe alguno. Useopenclaw migratepara obtener planes de simulación, el modo de sobrescritura, copias de seguridad verificadas, informes y correspondencias exactas.--remote-urly--remote-token: rellenan previamente el paso del Gateway remoto del asistente clásico y sustituyen los valores remotos almacenados para esta ejecución. Cambiar la URL no reutiliza las credenciales almacenadas, a menos que también se proporcione un token. El token permanece oculto en las solicitudes y sigue la elección existente del asistente entre almacenamiento en texto sin formato o SecretRef.--tailscale-reset-on-exity--no-tailscale-reset-on-exit: controlan explícitamente si se restablece la configuración de Serve o Funnel de Tailscale cuando el Gateway se cierra. Omitir ambos conserva el ajuste actual durante las nuevas ejecuciones no interactivas.--modernes un alias de compatibilidad para el asistente conversacional de configuración de OpenClaw. Usa la misma puerta de inferencia en vivo queopenclaw setupy solo acepta--workspace,--accept-risk,--non-interactivey--json. Los demás indicadores de configuración se rechazan en lugar de ignorarse silenciosamente.
Flujo guiado
openclaw onboard sin argumentos inicia el flujo guiado. Muestra el aviso de seguridad
y, a continuación, plantea una pregunta inicial: acceso completo (recomendado: la configuración busca
automáticamente aplicaciones de IA, claves y entornos de ejecución locales) o preguntar primero (la configuración pregunta
una vez antes de buscar o permite configurar manualmente). La
elección se conserva como wizard.accessMode. Si se permite la detección, la incorporación
detecta el acceso a la IA que ya está disponible mediante modelos configurados, variables de entorno
de claves de API y CLI locales compatibles y, a continuación, prueba el
candidato recomendado con una finalización real. Si un candidato falla, la incorporación
prueba discretamente el siguiente candidato utilizable y resume en una
sola línea todo lo que no respondió; se anuncia la ruta que funciona con una opción de una sola tecla para ver
todas las demás alternativas.
Si se agotan las opciones de detección automática, el selector de proveedores muestra primero OpenAI,
Anthropic, xAI (Grok), Google y OpenRouter. Elija Más… para ver todos
los demás proveedores compatibles, agrupados por proveedor; las regiones, los planes y los métodos de autenticación
aparecen después en un segundo menú. El inicio de sesión mediante navegador o dispositivo compatible y los métodos
con clave de API o token ocultos usan la misma ruta de finalización en vivo. OpenClaw conserva
únicamente la ruta del modelo verificada y su credencial después de que la prueba se complete correctamente; un
candidato fallido no sustituye el modelo configurado ni guarda la credencial
que se intentó usar. Elija Omitir por ahora para salir sin iniciar OpenClaw y
vuelva a ejecutar openclaw onboard cuando esté listo. La configuración del espacio de trabajo y del Gateway permanece
sin cambios hasta que se inicia OpenClaw.
En el modo guiado, --workspace <dir> proporciona el espacio de trabajo propuesto por OpenClaw
y el contexto de inferencia aislado. No se conserva hasta que se aprueba la
propuesta de configuración de OpenClaw. La incorporación clásica y no interactiva conserva su
espacio de trabajo mediante su flujo de configuración normal. En una nueva ejecución con una lista de agentes existente,
la incorporación conserva el espacio de trabajo del conjunto configurado: el asistente clásico
muestra ambas rutas y requiere confirmación explícita antes de moverlo,
mientras que la configuración no interactiva muestra una advertencia y conserva el valor actual.
Después de que la inferencia se complete correctamente, la incorporación comprueba si existen memorias de herramientas de IA
locales compatibles: memoria automática de Claude Code, memorias consolidadas de Codex y archivos de memoria
de Hermes. Cuando encuentra alguna, una página ofrece copiarlas en el espacio de trabajo del agente
en memory/imports/ para permitir su recuperación indexada. No se importa nada sin
confirmación, se omiten los archivos importados anteriormente y siempre se pueden importar
más adelante desde la página de importación de memoria de Control UI, que ofrece
el mismo alcance limitado a la memoria. (Una ejecución completa de openclaw migrate tiene
un alcance mayor: también puede importar la configuración, las skills y las credenciales). El asistente clásico
muestra la misma página después de preparar el espacio de trabajo.
Después de que la inferencia se complete correctamente (y de la oferta de importación de memoria), la incorporación guiada
aplica automáticamente la configuración estándar —espacio de trabajo, Gateway y sesiones,
el mismo plan que aplicaría el chat conversacional openclaw setup al responder "sí"—
y, a continuación, ofrece recomendaciones de plugins y skills basadas en las aplicaciones instaladas; los nombres de las aplicaciones
se buscan mediante el modelo configurado y la búsqueda de ClawHub, y el paso se puede
deshabilitar mediante wizard.appRecommendations.
En una sesión de escritorio de macOS, Linux o Windows, abre a continuación el
panel autenticado de Control UI y espera hasta 60 segundos a que el cliente del navegador se
conecte. En Linux sin interfaz gráfica o mediante SSH, muestra una URL del
panel destacada y lista para copiar y pegar, incluido un comando de reenvío de puertos SSH para un Gateway
de bucle local, y espera hasta cinco minutos. Una conexión correcta continúa en el navegador;
un Gateway inaccesible o un tiempo de espera agotado recurre a la misma salida de terminal
que antes. Pase --tui para omitir la transferencia al navegador y forzar esa salida de terminal.
Si la aplicación de la configuración falla, la incorporación recurre al chat conversacional de OpenClaw
para finalizar de forma interactiva. Los canales, los agentes,
los plugins y otras funciones opcionales siguen perteneciendo al chat de OpenClaw: ejecute
openclaw y use open channel wizard for <channel> para delegar la recopilación de
credenciales del canal en un asistente de terminal que oculta los datos. Para cambiar el proveedor
del modelo o su autenticación, salga de OpenClaw y ejecute openclaw onboard;
OpenClaw no abre los flujos guiados ni clásicos de proveedores.
En una instalación configurada, volver a ejecutar openclaw onboard verifica primero el
modelo predeterminado actual, por lo que el mismo flujo sirve como proceso de verificación y reparación:
no vuelve a aplicar la configuración, reinstalar ni reiniciar el servicio del Gateway.
Si esa comprobación falla, el modelo configurado nunca se sustituye automáticamente:
la incorporación se detiene y pregunta cómo continuar. La comprobación se ejecuta fuera del
espacio de trabajo, por lo que un modelo proporcionado por un Plugin del espacio de trabajo puede fallar aquí aunque siga
funcionando en el agente.
Use openclaw onboard --classic para la autenticación específica del proveedor, los canales, las skills,
la configuración remota del Gateway, las importaciones o todos los controles del Gateway. Para la configuración y
reparación conversacional no relacionadas con la inferencia, ejecute openclaw setup; openclaw onboard --modern es un alias de compatibilidad que pasa por la misma puerta de inferencia. El asistente clásico
puede verificar opcionalmente el modelo predeterminado mediante una finalización en vivo, pero
OpenClaw no se iniciará hasta que su propia comprobación de inferencia en vivo se complete correctamente.
En un terminal interactivo, openclaw sin argumentos (sin subcomando) dirige el flujo según el estado
de la configuración:
- Si falta el archivo de configuración activo o no contiene ajustes definidos (está vacío o solo contiene metadatos), se inicia la incorporación guiada.
- Si el archivo de configuración existe, pero no supera la validación, se inicia la ruta de
incorporación clásica con las indicaciones de
openclaw doctor. OpenClaw necesita una inferencia funcional y no se utiliza para reparar este estado previo a la inferencia. - Si el archivo de configuración es válido, se abre la TUI normal del agente. Un
Gateway configurado y accesible con un agente y un modelo abre directamente esa interfaz sin
incorporación ni OpenClaw. En una instalación configurada, acceda a OpenClaw mediante
/openclawdentro de la TUI oopenclaw setup.
Se acepta ws:// en texto sin formato para direcciones de bucle local, literales de IP privadas, .local y URL del Gateway *.ts.net de Tailnet. Para otros nombres de DNS privados confiables, establezca OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 en el entorno del proceso de incorporación.
Restablecimiento
openclaw onboard --resetopenclaw onboard --reset --reset-scope full--reset borra el estado antes de ejecutar la configuración. --reset-scope controla cuánto se borra: config (solo la configuración), config+creds+sessions (valor predeterminado cuando se pasa --reset sin un ámbito) o full (también restablece el espacio de trabajo). El espacio de trabajo solo se restablece con --reset-scope full.
Configuración regional
La incorporación interactiva utiliza la configuración regional del asistente de la CLI para los textos fijos de configuración. Utiliza el primer valor no vacío en este orden:
OPENCLAW_LOCALELC_ALLLC_MESSAGESLANG- Inglés como alternativa
Las configuraciones regionales admitidas por el asistente son en, zh-CN y zh-TW. Los valores de configuración regional pueden utilizar guiones bajos o formas con sufijos POSIX, como zh_CN.UTF-8. Los nombres de productos y comandos, las claves de configuración, las URL, los identificadores de proveedores y modelos, y las etiquetas de plugins y canales permanecen literales.
OPENCLAW_LOCALE=zh-CN openclaw onboardOPENCLAW_LOCALE=en openclaw onboard # Sustitución explícita por inglésConfiguración no interactiva
--non-interactive requiere --accept-risk (reconoce que los agentes son potentes y que el acceso completo al sistema conlleva riesgos). El valor predeterminado de --mode es local.
openclaw onboard --non-interactive \ --auth-choice custom-api-key \ --custom-base-url "https://llm.example.com/v1" \ --custom-model-id "foo-large" \ --custom-api-key "$CUSTOM_API_KEY" \ --secret-input-mode plaintext \ --custom-compatibility openai \ --custom-image-input--custom-api-key es opcional; si se omite, la incorporación comprueba CUSTOM_API_KEY en el entorno. OpenClaw marca automáticamente como compatibles con imágenes los identificadores habituales de modelos de visión (GPT-4o/4.1/5.x, Claude 3/4, Gemini, Qwen-VL, LLaVA, Pixtral y similares). Pase --custom-image-input para identificadores personalizados de visión desconocidos o --custom-text-input para forzar metadatos de solo texto. Utilice --custom-compatibility openai-responses para puntos de conexión compatibles con OpenAI que admitan /v1/responses, pero no /v1/chat/completions; los valores válidos son openai (predeterminado), openai-responses y anthropic.
LM Studio también dispone de una opción de clave específica del proveedor:
openclaw onboard --non-interactive \ --auth-choice lmstudio \ --custom-base-url "http://localhost:1234/v1" \ --custom-model-id "qwen/qwen3.5-9b" \ --lmstudio-api-key "$LM_API_TOKEN" \ --accept-riskOllama no interactivo:
openclaw onboard --non-interactive \ --auth-choice ollama \ --custom-base-url "http://ollama-host:11434" \ --custom-model-id "qwen3.5:27b" \ --accept-riskEl valor predeterminado de --custom-base-url es http://127.0.0.1:11434. --custom-model-id es opcional; si se omite, la incorporación utiliza los valores predeterminados sugeridos por Ollama. Los identificadores de modelos en la nube, como kimi-k2.5:cloud, también funcionan aquí.
Almacene las claves de proveedores como referencias en lugar de texto sin formato:
openclaw onboard --non-interactive \ --auth-choice openai-api-key \ --secret-input-mode ref \ --accept-riskCon --secret-input-mode ref, la incorporación escribe referencias respaldadas por variables de entorno en lugar de valores de clave en texto sin formato: para los proveedores respaldados por perfiles de autenticación, escribe keyRef: { source: "env", provider: "default", id: <envVar> }; para los proveedores personalizados, escribe models.providers.<id>.apiKey del mismo modo (por ejemplo, { source: "env", provider: "default", id: "CUSTOM_API_KEY" }). Contrato: establezca la variable de entorno del proveedor en el entorno del proceso de incorporación (por ejemplo, OPENAI_API_KEY) y no pase también una opción de clave en línea a menos que esa variable de entorno esté establecida; un valor de opción sin la variable de entorno correspondiente genera un error inmediato con indicaciones.
Autenticación del Gateway (no interactiva)
--gateway-auth token --gateway-token <token>almacena un token en texto sin formato.tokenes el modo de autenticación predeterminado.--gateway-auth token --gateway-token-ref-env <name>almacenagateway.auth.tokencomo una SecretRef de entorno. Requiere una variable de entorno no vacía con ese nombre en el entorno del proceso de incorporación.--gateway-tokeny--gateway-token-ref-envson mutuamente excluyentes.- Con
--install-daemon: se valida ungateway.auth.tokengestionado mediante SecretRef, pero no se conserva como texto sin formato resuelto en los metadatos del entorno del servicio supervisor; si la referencia no puede resolverse, la instalación se cierra de forma segura con indicaciones para corregir el problema. Si se configuran tantogateway.auth.tokencomogateway.auth.passwordygateway.auth.modeno está establecido, la instalación se bloquea hasta que se establezca el modo explícitamente. - La incorporación local escribe
gateway.mode="local"en la configuración. Si posteriormente un archivo de configuración no contienegateway.mode, esto indica daños en la configuración o una edición manual incompleta, no un atajo válido para el modo local. - La incorporación local instala los plugins descargables que requiere la ruta de configuración elegida (por ejemplo, un plugin de entorno de ejecución de Codex o Copilot para esas opciones de autenticación). La incorporación remota solo escribe información de conexión para el Gateway remoto; nunca instala paquetes de plugins locales.
--allow-unconfiguredes una vía de escape independiente deopenclaw gateway run; no permite que la incorporación omitagateway.mode.
export OPENAI_API_KEY="your-provider-key"export OPENCLAW_GATEWAY_TOKEN="your-token"openclaw onboard --non-interactive \ --mode local \ --auth-choice openai-api-key \ --secret-input-mode ref \ --gateway-auth token \ --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN \ --accept-riskEstado del Gateway local
- A menos que pase
--skip-health, la incorporación espera a que haya un Gateway local accesible antes de finalizar correctamente. --install-daemoninicia primero la ruta de instalación del Gateway gestionado. Sin esta opción, ya debe haber un Gateway local en ejecución (por ejemplo,openclaw gateway run).--skip-healthomite la espera si solo se desea escribir la configuración, el espacio de trabajo y el arranque inicial mediante automatización.--skip-bootstrapestableceagents.defaults.skipBootstrap: truey omite la creación deAGENTS.md,SOUL.md,TOOLS.md,IDENTITY.md,USER.md,HEARTBEAT.mdyBOOTSTRAP.md.- En Windows nativo,
--install-daemonintenta utilizar primero las tareas programadas y, si se deniega su creación, recurre a un elemento de inicio de sesión por usuario en la carpeta Inicio.
Modo de referencia interactivo
- Elija Usar referencia de secreto cuando se solicite y, a continuación, Variable de entorno o un proveedor de secretos configurado (
fileoexec). - La incorporación ejecuta una validación preliminar rápida antes de guardar la referencia y permite volver a intentarlo si falla.
Opciones de punto de conexión de Z.AI
# Selección del punto de conexión sin solicitudesopenclaw onboard --non-interactive \ --auth-choice zai-coding-global \ --zai-api-key "$ZAI_API_KEY" # Otras opciones de punto de conexión de Z.AI: zai-coding-cn, zai-global, zai-cnMistral:
openclaw onboard --non-interactive \ --auth-choice mistral-api-key \ --mistral-api-key "$MISTRAL_API_KEY"Opciones no interactivas adicionales
Autenticación de modelos basada en tokens (utilizada con --auth-choice token):
| Opción | Descripción |
|---|---|
--token-provider <id> |
Identificador del proveedor de tokens que emite el token |
--token <token> |
Valor del token para la autenticación del modelo |
--token-profile-id <id> |
Identificador del perfil de autenticación (valor predeterminado: <provider>:manual; algunos flujos propiedad del proveedor utilizan su propio valor predeterminado, como anthropic:default) |
--token-expires-in <duration> |
Duración opcional hasta la caducidad del token (p. ej., 365d, 12h) |
Cloudflare AI Gateway: --cloudflare-ai-gateway-account-id <id>, --cloudflare-ai-gateway-gateway-id <id>.
Control de instalación del daemon: --no-install-daemon / --skip-daemon (alias; omiten la instalación del servicio del Gateway), --daemon-runtime <node>.
Skills: --node-manager <npm|pnpm|bun> (valor predeterminado: npm), --skip-skills.
Configuración de la interfaz de usuario y los hooks: --skip-ui (omite las solicitudes de la interfaz de control/TUI), --skip-hooks (omite la configuración de webhooks/hooks), --skip-channels, --skip-search.
Salida: --suppress-gateway-token-output suprime la salida del Gateway o la interfaz de usuario que contiene tokens (indicaciones de tokens, URL de inicio de sesión automático con un token incrustado y apertura automática de la interfaz de control); resulta útil en terminales compartidos y en CI.
Filtrado previo de proveedores
Cuando una opción de autenticación implica un proveedor preferido, la incorporación filtra previamente los selectores del modelo predeterminado y de la lista de permitidos para mostrar los modelos de ese proveedor. El filtro también coincide con otros proveedores que pertenecen al mismo plugin, lo que incluye variantes de planes de programación como volcengine/volcengine-plan y byteplus/byteplus-plan. Si el filtro del proveedor preferido no devuelve ningún modelo cargado, la incorporación recurre al catálogo sin filtrar en lugar de dejar vacío el selector.
Preguntas de seguimiento de búsqueda web
Algunos proveedores de búsqueda web activan preguntas de seguimiento específicas del proveedor durante la incorporación:
- Grok puede ofrecer la configuración opcional de
x_searchcon la misma autenticación de xAI y una selección de modelox_search. - Kimi puede solicitar la región de la API de Moonshot (
api.moonshot.aifrente aapi.moonshot.cn) y el modelo predeterminado de búsqueda web de Kimi.
Otros comportamientos
- Comportamiento del ámbito de mensajes directos en la incorporación local: referencia de configuración de la CLI.
- Primera conversación más rápida:
openclaw dashboard(interfaz de control, sin configuración de canales). - Proveedor personalizado: conecte cualquier punto de conexión compatible con OpenAI o Anthropic, incluidos proveedores alojados que no aparecen en la lista. Utilice la compatibilidad Desconocida para detectarla automáticamente mediante una prueba en vivo.
- Si se detecta el estado de Hermes, la incorporación ofrece un flujo de migración (consulte
--flow importmás arriba).
Comandos habituales de seguimiento
Utilice openclaw configure más adelante para cambios específicos que no sean de inferencia y openclaw channels add para configurar únicamente canales. Para cambiar el proveedor del modelo o la ruta de autenticación,
ejecute openclaw onboard en su lugar.
openclaw channels addopenclaw configureopenclaw agents add <name>