integración

`openclaw onboard`

Incorporación interactiva para la configuración de Gateway local o remota.

Guías relacionadas

Centro de incorporación de la CLI: Incorporación (CLI)
Descripción general de la incorporación: Descripción general de la incorporación
Referencia de incorporación de la CLI: Referencia de configuración de la CLI
Automatización de la CLI: Automatización de la CLI
Incorporación en macOS: Incorporación (Aplicación macOS)

Ejemplos

openclaw onboard
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

Para destinos ws:// de red privada en texto sin formato (solo redes de confianza), establezca OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 en el entorno del proceso de integración.

Proveedor personalizado no interactivo:

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-api-key es opcional en el modo no interactivo. Si se omite, la integración comprueba CUSTOM_API_KEY.

Ollama no interactivo:

openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk

--custom-base-url es http://127.0.0.1:11434 de forma predeterminada. --custom-model-id es opcional; si se omite, la integración usa los valores predeterminados sugeridos por Ollama. Los IDs de modelos en la nube, como kimi-k2.5:cloud, también funcionan aquí.

Almacenar claves de proveedor como referencias en lugar de texto sin formato:

openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk

Con --secret-input-mode ref, la integración escribe referencias respaldadas por variables de entorno en lugar de valores de clave en texto sin formato. Para proveedores respaldados por perfiles de autenticación, esto escribe entradas de keyRef; para proveedores personalizados, esto escribe models.providers.<id>.apiKey como una referencia de entorno (por ejemplo, { source: "env", provider: "default", id: "CUSTOM_API_KEY" }).

Contrato del modo no interactivo ref:

Establezca la variable de entorno del proveedor en el entorno del proceso de integración (por ejemplo, OPENAI_API_KEY).
No pase flags de clave en línea (por ejemplo, --openai-api-key) a menos que esa variable de entorno también esté establecida.
Si se pasa un flag de clave en línea sin la variable de entorno requerida, la integración falla rápidamente con una guía.

Opciones de token de Gateway en modo no interactivo:

--gateway-auth token --gateway-token <token> almacena un token en texto sin formato.
--gateway-auth token --gateway-token-ref-env <name> almacena gateway.auth.token como un SecretRef de entorno.
--gateway-token y --gateway-token-ref-env son mutuamente excluyentes.
--gateway-token-ref-env requiere una variable de entorno no vacía en el entorno del proceso de integración.
Con --install-daemon, cuando la autenticación por token requiere un token, los tokens de puerta de enlace administrados por SecretRef se validan pero no se persisten como texto sin resolver en los metadatos del entorno del servicio supervisor.
Con --install-daemon, si el modo de token requiere un token y el SecretRef del token configurado no está resuelto, la integración falla de forma cerrada con orientación para la corrección.
Con --install-daemon, si tanto gateway.auth.token como gateway.auth.password están configurados y gateway.auth.mode no está definido, la integración bloquea la instalación hasta que el modo se establece explícitamente.

Ejemplo:

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 \
  --accept-risk

Estado de salud de la puerta de enlace local no interactiva:

A menos que pases --skip-health, la integración espera a que haya una puerta de enlace local accesible antes de salir correctamente.
--install-daemon inicia primero la ruta de instalación de la puerta de enlace administrada. Sin ello, ya debes tener una puerta de enlace local en ejecución, por ejemplo openclaw gateway run.
Si solo quieres escrituras de configuración/espacio de trabajo/bootstrap en automatización, usa --skip-health.
En Windows nativo, --install-daemon intenta primero las Tareas Programadas y recurre a un elemento de inicio de sesión en la carpeta de Inicio por usuario si se deniega la creación de la tarea.

Comportamiento de la integración interactiva con el modo de referencia:

Elige Usar referencia secreta cuando se te solicite.
A continuación, elige una de las siguientes opciones:
- Variable de entorno
- Proveedor de secretos configurado (file o exec)
La integración realiza una validación previa rápida antes de guardar la referencia.
- Si la validación falla, la integración muestra el error y te permite reintentarlo.

Opciones de endpoint de Z.AI no interactivas:

Nota: --auth-choice zai-api-key ahora detecta automáticamente el mejor endpoint de Z.AI para tu clave (prefiere la API general con zai/glm-5). Si específicamente quieres los endpoints del Plan de Codificación GLM, elige zai-coding-global o zai-coding-cn.

# Promptless endpoint selection
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# Other Z.AI endpoint choices:
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn

Ejemplo no interactivo de Mistral:

openclaw onboard --non-interactive \
  --auth-choice mistral-api-key \
  --mistral-api-key "$MISTRAL_API_KEY"

Notas sobre el flujo:

quickstart: indicaciones mínimas, genera automáticamente un token de puerta de enlace.
manual: indicaciones completas para puerto/vínculo/autenticación (alias de advanced).
En el paso de búsqueda web, elegir Grok puede activar un mensaje de seguimiento separado para habilitar x_search con el mismo XAI_API_KEY y, opcionalmente, elegir un modelo x_search. Otros proveedores de búsqueda web no muestran ese mensaje.
Comportamiento del alcance de DM en la incorporación local: Referencia de configuración de la CLI.
Primera conversación más rápida: openclaw dashboard (Interfaz de usuario de control, sin configuración de canal).
Proveedor personalizado: conecte cualquier punto final compatible con OpenAI o Anthropic, incluidos los proveedores alojados que no figuran en la lista. Use Desconocido para detectar automáticamente.

Comandos de seguimiento comunes

openclaw configure
openclaw agents add <name>