openclaw onboard

Asistente interactivo de configuración inicial (Gateway local o remoto).

Guías relacionadas

Ejemplos

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

Para conexiones ws:// en texto plano en redes privadas (solo redes de confianza), establece OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 en el entorno del proceso de configuració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 modo no interactivo. Si se omite, la configuració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 por defecto. --custom-model-id es opcional; si se omite, la configuració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 plano:

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

Con --secret-input-mode ref, la configuración escribe referencias respaldadas por variables de entorno en lugar de valores de clave en texto plano. Para proveedores respaldados por perfil de autenticación, esto escribe entradas 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 ref no interactivo:

  • Establece la variable de entorno del proveedor en el entorno del proceso de configuración (por ejemplo OPENAI_API_KEY).
  • No pases flags de clave inline (por ejemplo --openai-api-key) a menos que esa variable de entorno también esté definida.
  • Si se pasa un flag de clave inline sin la variable de entorno requerida, la configuración falla inmediatamente con orientación.

Opciones de token del Gateway en modo no interactivo:

  • --gateway-auth token --gateway-token <token> almacena un token en texto plano.
  • --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 configuración.
  • Con --install-daemon, cuando la autenticación por token requiere un token, los tokens del gateway gestionados por SecretRef se validan pero no se persisten como texto plano resuelto en los metadatos del entorno del servicio supervisor.
  • Con --install-daemon, si el modo token requiere un token y el SecretRef del token configurado no se puede resolver, la configuración falla de forma cerrada con orientación de remediación.
  • Con --install-daemon, si tanto gateway.auth.token como gateway.auth.password están configurados y gateway.auth.mode no está definido, la configuración bloquea la instalación hasta que el modo se establezca 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

Salud del gateway local no interactivo:

  • A menos que pases --skip-health, la configuración espera a que haya un gateway local accesible antes de finalizar correctamente.
  • --install-daemon inicia primero la ruta de instalación gestionada del gateway. Sin esto, ya debes tener un gateway local en ejecución, por ejemplo openclaw gateway run.
  • Si solo necesitas escrituras de configuración/workspace/bootstrap en automatización, usa --skip-health.
  • En Windows nativo, --install-daemon intenta primero Tareas Programadas y recurre a un elemento de inicio de sesión en la carpeta Startup por usuario si la creación de la tarea es denegada.

Comportamiento de la configuración interactiva con modo de referencia:

  • Elige Usar referencia secreta cuando se solicite.
  • Luego elige:
    • Variable de entorno
    • Proveedor de secretos configurado (file o exec)
  • La configuración realiza una validación rápida de preflight antes de guardar la referencia.
    • Si la validación falla, la configuración muestra el error y permite reintentar.

Opciones no interactivas de endpoint Z.AI:

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 quieres específicamente los endpoints del Plan GLM Coding, elige zai-coding-global o zai-coding-cn.

# Selección de endpoint sin prompts
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# Otras opciones de endpoint Z.AI:
# --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 flujos:

  • quickstart: prompts mínimos, genera automáticamente un token de gateway.
  • manual: prompts completos para puerto/bind/autenticación (alias de advanced).
  • Comportamiento del alcance DM en configuración local: CLI Onboarding Reference.
  • Chat más rápido: openclaw dashboard (Control UI, sin configuración de canal).
  • Proveedor personalizado: conecta cualquier endpoint compatible con OpenAI o Anthropic, incluidos proveedores alojados no listados. Usa Unknown para detección automática.

Comandos de seguimiento comunes

openclaw configure
openclaw agents add <name>

Nota: --json no implica modo no interactivo. Usa --non-interactive para scripts.

arrow_back
Anterior
Nodes
Siguiente
Pairing
arrow_forward