Referencia CLI

Esta página describe el comportamiento actual del CLI. Si los comandos cambian, actualiza este documento.

Páginas de comandos

Flags globales

  • --dev: aislar estado bajo ~/.openclaw-dev y cambiar puertos por defecto.
  • --profile <name>: aislar estado bajo ~/.openclaw-<name>.
  • --no-color: deshabilitar colores ANSI.
  • --update: atajo para openclaw update (solo instalaciones desde fuente).
  • -V, --version, -v: imprimir versión y salir.

Estilo de salida

  • Los colores ANSI e indicadores de progreso solo se renderizan en sesiones TTY.
  • Los hipervínculos OSC-8 se renderizan como enlaces clicables en terminales compatibles; de lo contrario se recurre a URLs planas.
  • --json (y --plain donde esté soportado) deshabilita el estilo para una salida limpia.
  • --no-color deshabilita el estilo ANSI; NO_COLOR=1 también se respeta.
  • Los comandos de larga duración muestran un indicador de progreso (OSC 9;4 cuando está soportado).

Paleta de colores

OpenClaw usa una paleta langosta para la salida del CLI.

  • accent (#FF5A2D): encabezados, etiquetas, resaltados principales.
  • accentBright (#FF7A3D): nombres de comandos, énfasis.
  • accentDim (#D14A22): texto de resaltado secundario.
  • info (#FF8A5B): valores informativos.
  • success (#2FBF71): estados de éxito.
  • warn (#FFB020): advertencias, fallbacks, atención.
  • error (#E23D2D): errores, fallos.
  • muted (#8B7F77): texto de baja prioridad, metadatos.

Fuente de verdad de la paleta: src/terminal/palette.ts (alias “lobster seam”).

Árbol de comandos

openclaw [--dev] [--profile <name>] <command>
  setup
  onboard
  configure
  config
    get
    set
    unset
  completion
  doctor
  dashboard
  backup
    create
    verify
  security
    audit
  secrets
    reload
    migrate
  reset
  uninstall
  update
  channels
    list
    status
    logs
    add
    remove
    login
    logout
  directory
  skills
    list
    info
    check
  plugins
    list
    info
    install
    enable
    disable
    doctor
  memory
    status
    index
    search
  message
  agent
  agents
    list
    add
    delete
  acp
  status
  health
  sessions
  gateway
    call
    health
    status
    probe
    discover
    install
    uninstall
    start
    stop
    restart
    run
  daemon
    status
    install
    uninstall
    start
    stop
    restart
  logs
  system
    event
    heartbeat last|enable|disable
    presence
  models
    list
    status
    set
    set-image
    aliases list|add|remove
    fallbacks list|add|remove|clear
    image-fallbacks list|add|remove|clear
    scan
    auth add|setup-token|paste-token
    auth order get|set|clear
  sandbox
    list
    recreate
    explain
  cron
    status
    list
    add
    edit
    rm
    enable
    disable
    runs
    run
  nodes
  devices
  node
    run
    status
    install
    uninstall
    start
    stop
    restart
  approvals
    get
    set
    allowlist add|remove
  browser
    status
    start
    stop
    reset-profile
    tabs
    open
    focus
    close
    profiles
    create-profile
    delete-profile
    screenshot
    snapshot
    navigate
    resize
    click
    type
    press
    hover
    drag
    select
    upload
    fill
    dialog
    wait
    evaluate
    console
    pdf
  hooks
    list
    info
    check
    enable
    disable
    install
    update
  webhooks
    gmail setup|run
  pairing
    list
    approve
  qr
  clawbot
    qr
  docs
  dns
    setup
  tui

Nota: los plugins pueden agregar comandos adicionales de nivel superior (por ejemplo openclaw voicecall).

Seguridad

  • openclaw security audit — audita la configuración + estado local en busca de problemas de seguridad comunes.
  • openclaw security audit --deep — sondeo en vivo del Gateway de mejor esfuerzo.
  • openclaw security audit --fix — ajustar valores por defecto seguros y chmod de estado/configuración.

Secrets

  • openclaw secrets reload — re-resolver refs y hacer swap atómico del snapshot en tiempo de ejecución.
  • openclaw secrets audit — escanear en busca de residuos de texto plano, refs no resueltos y deriva de precedencia.
  • openclaw secrets configure — helper interactivo para configuración de proveedor + mapeo de SecretRef + preflight/apply.
  • openclaw secrets apply --from <plan.json> — aplicar un plan previamente generado (--dry-run soportado).

Plugins

Gestiona extensiones y su configuración:

  • openclaw plugins list — descubrir plugins (usa --json para salida de máquina).
  • openclaw plugins info <id> — mostrar detalles de un plugin.
  • openclaw plugins install <path|.tgz|npm-spec> — instalar un plugin (o agregar una ruta de plugin a plugins.load.paths).
  • openclaw plugins enable <id> / disable <id> — alternar plugins.entries.<id>.enabled.
  • openclaw plugins doctor — reportar errores de carga de plugins.

La mayoría de los cambios de plugins requieren un reinicio del gateway. Ver /plugin.

Memory

Búsqueda vectorial sobre MEMORY.md + memory/*.md:

  • openclaw memory status — mostrar estadísticas del índice.
  • openclaw memory index — reindexar archivos de memoria.
  • openclaw memory search "<query>" (o --query "<query>") — búsqueda semántica sobre la memoria.

Comandos slash del chat

Los mensajes de chat soportan comandos /... (texto y nativos). Ver /tools/slash-commands.

Destacados:

  • /status para diagnósticos rápidos.
  • /config para cambios de configuración persistidos.
  • /debug para sobrescrituras de configuración solo en tiempo de ejecución (memoria, no disco; requiere commands.debug: true).

Setup + onboarding

setup

Inicializa configuración + workspace.

Opciones:

  • --workspace <dir>: ruta del workspace del agente (por defecto ~/.openclaw/workspace).
  • --wizard: ejecutar el asistente de onboarding.
  • --non-interactive: ejecutar el asistente sin prompts.
  • --mode <local|remote>: modo del asistente.
  • --remote-url <url>: URL del Gateway remoto.
  • --remote-token <token>: token del Gateway remoto.

El asistente se auto-ejecuta cuando hay flags del asistente presentes (--non-interactive, --mode, --remote-url, --remote-token).

onboard

Asistente interactivo para configurar gateway, workspace y skills.

Opciones:

  • --workspace <dir>
  • --reset (restablecer configuración + credenciales + sesiones antes del asistente)
  • --reset-scope <config|config+creds+sessions|full> (por defecto config+creds+sessions; usa full para eliminar también el workspace)
  • --non-interactive
  • --mode <local|remote>
  • --flow <quickstart|advanced|manual> (manual es un alias de advanced)
  • --auth-choice <setup-token|token|chutes|openai-codex|openai-api-key|openrouter-api-key|ollama|ai-gateway-api-key|moonshot-api-key|moonshot-api-key-cn|kimi-code-api-key|synthetic-api-key|venice-api-key|gemini-api-key|zai-api-key|mistral-api-key|apiKey|minimax-api|minimax-api-lightning|opencode-zen|opencode-go|custom-api-key|skip>
  • --token-provider <id> (no interactivo; usado con --auth-choice token)
  • --token <token> (no interactivo; usado con --auth-choice token)
  • --token-profile-id <id> (no interactivo; por defecto: <provider>:manual)
  • --token-expires-in <duration> (no interactivo; ej. 365d, 12h)
  • --secret-input-mode <plaintext|ref> (por defecto plaintext; usa ref para almacenar refs de env por defecto del proveedor en lugar de claves en texto plano)
  • --anthropic-api-key <key>
  • --openai-api-key <key>
  • --mistral-api-key <key>
  • --openrouter-api-key <key>
  • --ai-gateway-api-key <key>
  • --moonshot-api-key <key>
  • --kimi-code-api-key <key>
  • --gemini-api-key <key>
  • --zai-api-key <key>
  • --minimax-api-key <key>
  • --opencode-zen-api-key <key>
  • --opencode-go-api-key <key>
  • --custom-base-url <url> (no interactivo; usado con --auth-choice custom-api-key o --auth-choice ollama)
  • --custom-model-id <id> (no interactivo; usado con --auth-choice custom-api-key o --auth-choice ollama)
  • --custom-api-key <key> (no interactivo; opcional; usado con --auth-choice custom-api-key; recurre a CUSTOM_API_KEY cuando se omite)
  • --custom-provider-id <id> (no interactivo; id de proveedor personalizado opcional)
  • --custom-compatibility <openai|anthropic> (no interactivo; opcional; por defecto openai)
  • --gateway-port <port>
  • --gateway-bind <loopback|lan|tailnet|auto|custom>
  • --gateway-auth <token|password>
  • --gateway-token <token>
  • --gateway-token-ref-env <name> (no interactivo; almacena gateway.auth.token como un SecretRef de env; requiere que la variable de entorno esté establecida; no se puede combinar con --gateway-token)
  • --gateway-password <password>
  • --remote-url <url>
  • --remote-token <token>
  • --tailscale <off|serve|funnel>
  • --tailscale-reset-on-exit
  • --install-daemon
  • --no-install-daemon (alias: --skip-daemon)
  • --daemon-runtime <node|bun>
  • --skip-channels
  • --skip-skills
  • --skip-health
  • --skip-ui
  • --node-manager <npm|pnpm|bun> (pnpm recomendado; bun no recomendado para runtime del Gateway)
  • --json

configure

Asistente de configuración interactivo (modelos, canales, skills, gateway).

config

Helpers de configuración no interactivos (get/set/unset/file/validate). Ejecutar openclaw config sin subcomando lanza el asistente.

Subcomandos:

  • config get <path>: imprimir un valor de configuración (ruta con punto/corchetes).
  • config set <path> <value>: establecer un valor (JSON5 o cadena sin procesar).
  • config unset <path>: eliminar un valor.
  • config file: imprimir la ruta del archivo de configuración activo.
  • config validate: validar la configuración actual contra el esquema sin iniciar el gateway.
  • config validate --json: emitir salida JSON legible por máquinas.

doctor

Verificaciones de salud + correcciones rápidas (configuración + gateway + servicios heredados).

Opciones:

  • --no-workspace-suggestions: deshabilitar sugerencias de memoria del workspace.
  • --yes: aceptar valores por defecto sin preguntar (headless).
  • --non-interactive: omitir prompts; aplicar solo migraciones seguras.
  • --deep: escanear servicios del sistema en busca de instalaciones extra del gateway.

Helpers de canales

channels

Gestiona cuentas de canales de chat (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/MS Teams).

Subcomandos:

  • channels list: mostrar canales configurados y perfiles de autenticación.
  • channels status: verificar la accesibilidad del gateway y salud del canal (--probe ejecuta verificaciones adicionales; usa openclaw health o openclaw status --deep para sondeos de salud del gateway).
  • Consejo: channels status imprime advertencias con correcciones sugeridas cuando puede detectar errores de configuración comunes (luego te dirige a openclaw doctor).
  • channels logs: mostrar logs recientes del canal desde el archivo de log del gateway.
  • channels add: configuración tipo asistente cuando no se pasan flags; los flags cambian al modo no interactivo.
    • Cuando agregas una cuenta no predeterminada a un canal que todavía usa configuración de nivel superior de cuenta única, OpenClaw mueve los valores con alcance de cuenta a channels.<channel>.accounts.default antes de escribir la nueva cuenta.
    • channels add no interactivo no auto-crea/actualiza bindings; los bindings solo por canal siguen coincidiendo con la cuenta por defecto.
  • channels remove: deshabilitar por defecto; pasa --delete para eliminar entradas de configuración sin prompts.
  • channels login: login interactivo del canal (solo WhatsApp Web).
  • channels logout: cerrar sesión de un canal (si está soportado).

Opciones comunes:

  • --channel <name>: whatsapp|telegram|discord|googlechat|slack|mattermost|signal|imessage|msteams
  • --account <id>: id de cuenta del canal (por defecto default)
  • --name <label>: nombre de visualización para la cuenta

Opciones de channels login:

  • --channel <channel> (por defecto whatsapp; soporta whatsapp/web)
  • --account <id>
  • --verbose

Opciones de channels logout:

  • --channel <channel> (por defecto whatsapp)
  • --account <id>

Opciones de channels list:

  • --no-usage: omitir snapshots de uso/cuota del proveedor de modelos (solo respaldado por OAuth/API).
  • --json: salida JSON (incluye uso a menos que se establezca --no-usage).

Opciones de channels logs:

  • --channel <name|all> (por defecto all)
  • --lines <n> (por defecto 200)
  • --json

Más detalle: /concepts/oauth

Ejemplos:

openclaw channels add --channel telegram --account alerts --name "Alerts Bot" --token $TELEGRAM_BOT_TOKEN
openclaw channels add --channel discord --account work --name "Work Bot" --token $DISCORD_BOT_TOKEN
openclaw channels remove --channel discord --account work --delete
openclaw channels status --probe
openclaw status --deep

skills

Lista e inspecciona skills disponibles más información de preparación.

Subcomandos:

  • skills list: listar skills (por defecto cuando no hay subcomando).
  • skills info <name>: mostrar detalles de un skill.
  • skills check: resumen de listos vs requisitos faltantes.

Opciones:

  • --eligible: mostrar solo skills listos.
  • --json: salida JSON (sin estilo).
  • -v, --verbose: incluir detalle de requisitos faltantes.

Consejo: usa npx clawhub para buscar, instalar y sincronizar skills.

pairing

Aprueba solicitudes de emparejamiento DM entre canales.

Subcomandos:

  • pairing list [channel] [--channel <channel>] [--account <id>] [--json]
  • pairing approve <channel> <code> [--account <id>] [--notify]
  • pairing approve --channel <channel> [--account <id>] <code> [--notify]

devices

Gestiona entradas de emparejamiento de dispositivos del gateway y tokens de dispositivo por rol.

Subcomandos:

  • devices list [--json]
  • devices approve [requestId] [--latest]
  • devices reject <requestId>
  • devices remove <deviceId>
  • devices clear --yes [--pending]
  • devices rotate --device <id> --role <role> [--scope <scope...>]
  • devices revoke --device <id> --role <role>

webhooks gmail

Configuración + ejecutor del hook Pub/Sub de Gmail. Ver /automation/gmail-pubsub.

Subcomandos:

  • webhooks gmail setup (requiere --account <email>; soporta --project, --topic, --subscription, --label, --hook-url, --hook-token, --push-token, --bind, --port, --path, --include-body, --max-bytes, --renew-minutes, --tailscale, --tailscale-path, --tailscale-target, --push-endpoint, --json)
  • webhooks gmail run (sobrescrituras en tiempo de ejecución para los mismos flags)

dns setup

Helper DNS de descubrimiento de área amplia (CoreDNS + Tailscale). Ver /gateway/discovery.

Opciones:

  • --apply: instalar/actualizar configuración de CoreDNS (requiere sudo; solo macOS).

Mensajería + agente

message

Mensajería saliente unificada + acciones de canal.

Ver: /cli/message

Subcomandos:

  • message send|poll|react|reactions|read|edit|delete|pin|unpin|pins|permissions|search|timeout|kick|ban
  • message thread <create|list|reply>
  • message emoji <list|upload>
  • message sticker <send|upload>
  • message role <info|add|remove>
  • message channel <info|list>
  • message member info
  • message voice status
  • message event <list|create>

Ejemplos:

  • openclaw message send --target +15555550123 --message "Hi"
  • openclaw message poll --channel discord --target channel:123 --poll-question "Snack?" --poll-option Pizza --poll-option Sushi

agent

Ejecuta un turno de agente a través del Gateway (o --local embebido).

Requerido:

  • --message <text>

Opciones:

  • --to <dest> (para clave de sesión y entrega opcional)
  • --session-id <id>
  • --thinking <off|minimal|low|medium|high|xhigh> (solo modelos GPT-5.2 + Codex)
  • --verbose <on|full|off>
  • --channel <whatsapp|telegram|discord|slack|mattermost|signal|imessage|msteams>
  • --local
  • --deliver
  • --json
  • --timeout <seconds>

agents

Gestiona agentes aislados (workspaces + autenticación + enrutamiento).

agents list

Lista agentes configurados.

Opciones:

  • --json
  • --bindings

agents add [name]

Agrega un nuevo agente aislado. Ejecuta el asistente guiado a menos que se pasen flags (o --non-interactive); --workspace es requerido en modo no interactivo.

Opciones:

  • --workspace <dir>
  • --model <id>
  • --agent-dir <dir>
  • --bind <channel[:accountId]> (repetible)
  • --non-interactive
  • --json

Las especificaciones de binding usan channel[:accountId]. Cuando se omite accountId, OpenClaw puede resolver el alcance de cuenta vía valores por defecto del canal/hooks de plugin; de lo contrario es un binding de canal sin alcance de cuenta explícito.

agents bindings

Lista bindings de enrutamiento.

Opciones:

  • --agent <id>
  • --json

agents bind

Agrega bindings de enrutamiento para un agente.

Opciones:

  • --agent <id>
  • --bind <channel[:accountId]> (repetible)
  • --json

agents unbind

Elimina bindings de enrutamiento para un agente.

Opciones:

  • --agent <id>
  • --bind <channel[:accountId]> (repetible)
  • --all
  • --json

agents delete <id>

Elimina un agente y poda su workspace + estado.

Opciones:

  • --force
  • --json

acp

Ejecuta el puente ACP que conecta IDEs al Gateway.

Ver acp para opciones completas y ejemplos.

status

Muestra la salud de la sesión vinculada y destinatarios recientes.

Opciones:

  • --json
  • --all (diagnóstico completo; solo lectura, se puede pegar)
  • --deep (sondear canales)
  • --usage (mostrar uso/cuota del proveedor de modelos)
  • --timeout <ms>
  • --verbose
  • --debug (alias de --verbose)

Notas:

  • La vista general incluye el estado del servicio del Gateway + host de nodo cuando está disponible.

Seguimiento de uso

OpenClaw puede mostrar uso/cuota del proveedor cuando hay credenciales OAuth/API disponibles.

Superficies:

  • /status (agrega una línea corta de uso del proveedor cuando está disponible)
  • openclaw status --usage (imprime desglose completo del proveedor)
  • Barra de menú macOS (sección de Uso bajo Contexto)

Notas:

  • Los datos vienen directamente de los endpoints de uso del proveedor (sin estimaciones).
  • Proveedores: Anthropic, GitHub Copilot, OpenAI Codex OAuth, más Gemini CLI/Antigravity cuando esos plugins de proveedor están habilitados.
  • Si no existen credenciales coincidentes, el uso se oculta.
  • Detalles: ver Usage tracking.

health

Obtiene el estado de salud del Gateway en ejecución.

Opciones:

  • --json
  • --timeout <ms>
  • --verbose

sessions

Lista sesiones de conversación almacenadas.

Opciones:

  • --json
  • --verbose
  • --store <path>
  • --active <minutes>

Restablecer / Desinstalar

reset

Restablece configuración/estado local (mantiene el CLI instalado).

Opciones:

  • --scope <config|config+creds+sessions|full>
  • --yes
  • --non-interactive
  • --dry-run

Notas:

  • --non-interactive requiere --scope y --yes.

uninstall

Desinstala el servicio del gateway + datos locales (el CLI permanece).

Opciones:

  • --service
  • --state
  • --workspace
  • --app
  • --all
  • --yes
  • --non-interactive
  • --dry-run

Notas:

  • --non-interactive requiere --yes y scopes explícitos (o --all).

Gateway

gateway

Ejecuta el Gateway WebSocket.

Opciones:

  • --port <port>
  • --bind <loopback|tailnet|lan|auto|custom>
  • --token <token>
  • --auth <token|password>
  • --password <password>
  • --password-file <path>
  • --tailscale <off|serve|funnel>
  • --tailscale-reset-on-exit
  • --allow-unconfigured
  • --dev
  • --reset (restablecer configuración + credenciales + sesiones + workspace de dev)
  • --force (matar listener existente en el puerto)
  • --verbose
  • --claude-cli-logs
  • --ws-log <auto|full|compact>
  • --compact (alias de --ws-log compact)
  • --raw-stream
  • --raw-stream-path <path>

gateway service

Gestiona el servicio del Gateway (launchd/systemd/schtasks).

Subcomandos:

  • gateway status (sondea el RPC del Gateway por defecto)
  • gateway install (instalación del servicio)
  • gateway uninstall
  • gateway start
  • gateway stop
  • gateway restart

Notas:

  • gateway status sondea el RPC del Gateway por defecto usando el puerto/configuración resueltos del servicio (sobrescribir con --url/--token/--password).
  • gateway status soporta --no-probe, --deep y --json para scripting.
  • gateway status también muestra servicios de gateway heredados o extra cuando puede detectarlos (--deep agrega escaneos a nivel del sistema). Los servicios de OpenClaw con nombre de perfil se tratan como de primera clase y no se marcan como “extra”.
  • gateway status imprime qué ruta de configuración usa el CLI vs cuál configuración probablemente usa el servicio (env del servicio), más la URL destino del sondeo resuelto.
  • En instalaciones Linux con systemd, las verificaciones de deriva de token de status leen tanto valores Environment= como EnvironmentFile= de la unidad (incluyendo %h, rutas entre comillas, múltiples archivos y archivos opcionales con -).
  • gateway install|uninstall|start|stop|restart soportan --json para scripting (la salida por defecto se mantiene amigable para humanos).
  • gateway install usa runtime Node por defecto; bun no se recomienda (bugs de WhatsApp/Telegram).
  • Opciones de gateway install: --port, --runtime, --token, --force, --json.

logs

Muestra logs del Gateway en tiempo real vía RPC.

Notas:

  • Las sesiones TTY renderizan una vista coloreada y estructurada; las no-TTY recurren a texto plano.
  • --json emite JSON delimitado por líneas (un evento de log por línea).

Ejemplos:

openclaw logs --follow
openclaw logs --limit 200
openclaw logs --plain
openclaw logs --json
openclaw logs --no-color

gateway <subcommand>

Helpers del CLI del Gateway (usa --url, --token, --password, --timeout, --expect-final para subcomandos RPC). Cuando pasas --url, el CLI no auto-aplica credenciales de configuración o entorno. Incluye --token o --password explícitamente. La falta de credenciales explícitas es un error.

Subcomandos:

  • gateway call <method> [--params <json>]
  • gateway health
  • gateway status
  • gateway probe
  • gateway discover
  • gateway install|uninstall|start|stop|restart
  • gateway run

RPCs comunes:

  • config.apply (validar + escribir configuración + reiniciar + despertar)
  • config.patch (fusionar una actualización parcial + reiniciar + despertar)
  • update.run (ejecutar actualización + reiniciar + despertar)

Consejo: cuando llames config.set/config.apply/config.patch directamente, pasa baseHash de config.get si ya existe una configuración.

Modelos

Ver /concepts/models para el comportamiento de fallback y la estrategia de escaneo.

Setup-token de Anthropic (soportado):

claude setup-token
openclaw models auth setup-token --provider anthropic
openclaw models status

Nota de política: esto es compatibilidad técnica. Anthropic ha bloqueado algunos usos de suscripción fuera de Claude Code en el pasado; verifica los términos actuales de Anthropic antes de depender de setup-token en producción.

models (raíz)

openclaw models es un alias de models status.

Opciones raíz:

  • --status-json (alias de models status --json)
  • --status-plain (alias de models status --plain)

models list

Opciones:

  • --all
  • --local
  • --provider <name>
  • --json
  • --plain

models status

Opciones:

  • --json
  • --plain
  • --check (exit 1=expirado/faltante, 2=por expirar)
  • --probe (sondeo en vivo de perfiles de autenticación configurados)
  • --probe-provider <name>
  • --probe-profile <id> (repetir o separado por comas)
  • --probe-timeout <ms>
  • --probe-concurrency <n>
  • --probe-max-tokens <n>

Siempre incluye la vista general de autenticación y estado de expiración OAuth para perfiles en el almacén de autenticación. --probe ejecuta solicitudes en vivo (puede consumir tokens y activar límites de tasa).

models set <model>

Establece agents.defaults.model.primary.

models set-image <model>

Establece agents.defaults.imageModel.primary.

models aliases list|add|remove

Opciones:

  • list: --json, --plain
  • add <alias> <model>
  • remove <alias>

models fallbacks list|add|remove|clear

Opciones:

  • list: --json, --plain
  • add <model>
  • remove <model>
  • clear

models image-fallbacks list|add|remove|clear

Opciones:

  • list: --json, --plain
  • add <model>
  • remove <model>
  • clear

models scan

Opciones:

  • --min-params <b>
  • --max-age-days <days>
  • --provider <name>
  • --max-candidates <n>
  • --timeout <ms>
  • --concurrency <n>
  • --no-probe
  • --yes
  • --no-input
  • --set-default
  • --set-image
  • --json

models auth add|setup-token|paste-token

Opciones:

  • add: helper de autenticación interactivo
  • setup-token: --provider <name> (por defecto anthropic), --yes
  • paste-token: --provider <name>, --profile-id <id>, --expires-in <duration>

models auth order get|set|clear

Opciones:

  • get: --provider <name>, --agent <id>, --json
  • set: --provider <name>, --agent <id>, <profileIds...>
  • clear: --provider <name>, --agent <id>

System

system event

Encola un evento del sistema y opcionalmente activa un heartbeat (RPC del Gateway).

Requerido:

  • --text <text>

Opciones:

  • --mode <now|next-heartbeat>
  • --json
  • --url, --token, --timeout, --expect-final

system heartbeat last|enable|disable

Controles de heartbeat (RPC del Gateway).

Opciones:

  • --json
  • --url, --token, --timeout, --expect-final

system presence

Lista entradas de presencia del sistema (RPC del Gateway).

Opciones:

  • --json
  • --url, --token, --timeout, --expect-final

Cron

Gestiona trabajos programados (RPC del Gateway). Ver /automation/cron-jobs.

Subcomandos:

  • cron status [--json]
  • cron list [--all] [--json] (salida en tabla por defecto; usa --json para raw)
  • cron add (alias: create; requiere --name y exactamente uno de --at | --every | --cron, y exactamente un payload de --system-event | --message)
  • cron edit <id> (parchear campos)
  • cron rm <id> (aliases: remove, delete)
  • cron enable <id>
  • cron disable <id>
  • cron runs --id <id> [--limit <n>]
  • cron run <id> [--force]

Todos los comandos cron aceptan --url, --token, --timeout, --expect-final.

Host de nodo

node ejecuta un host de nodo headless o lo gestiona como servicio en segundo plano. Ver openclaw node.

Subcomandos:

  • node run --host <gateway-host> --port 18789
  • node status
  • node install [--host <gateway-host>] [--port <port>] [--tls] [--tls-fingerprint <sha256>] [--node-id <id>] [--display-name <name>] [--runtime <node|bun>] [--force]
  • node uninstall
  • node stop
  • node restart

Notas de autenticación:

  • node resuelve la autenticación del gateway desde env/config (sin flags --token/--password): OPENCLAW_GATEWAY_TOKEN / OPENCLAW_GATEWAY_PASSWORD, luego gateway.auth.*. En modo local, el host de nodo ignora intencionalmente gateway.remote.*; en gateway.mode=remote, gateway.remote.* participa según reglas de precedencia remota.
  • Las variables de entorno heredadas CLAWDBOT_GATEWAY_* se ignoran intencionalmente para la resolución de autenticación del host de nodo.

Nodes

nodes habla con el Gateway y apunta a nodos emparejados. Ver /nodes.

Opciones comunes:

  • --url, --token, --timeout, --json

Subcomandos:

  • nodes status [--connected] [--last-connected <duration>]
  • nodes describe --node <id|name|ip>
  • nodes list [--connected] [--last-connected <duration>]
  • nodes pending
  • nodes approve <requestId>
  • nodes reject <requestId>
  • nodes rename --node <id|name|ip> --name <displayName>
  • nodes invoke --node <id|name|ip> --command <command> [--params <json>] [--invoke-timeout <ms>] [--idempotency-key <key>]
  • nodes run --node <id|name|ip> [--cwd <path>] [--env KEY=VAL] [--command-timeout <ms>] [--needs-screen-recording] [--invoke-timeout <ms>] <command...> (nodo mac o host de nodo headless)
  • nodes notify --node <id|name|ip> [--title <text>] [--body <text>] [--sound <name>] [--priority <passive|active|timeSensitive>] [--delivery <system|overlay|auto>] [--invoke-timeout <ms>] (solo mac)

Cámara:

  • nodes camera list --node <id|name|ip>
  • nodes camera snap --node <id|name|ip> [--facing front|back|both] [--device-id <id>] [--max-width <px>] [--quality <0-1>] [--delay-ms <ms>] [--invoke-timeout <ms>]
  • nodes camera clip --node <id|name|ip> [--facing front|back] [--device-id <id>] [--duration <ms|10s|1m>] [--no-audio] [--invoke-timeout <ms>]

Canvas + pantalla:

  • nodes canvas snapshot --node <id|name|ip> [--format png|jpg|jpeg] [--max-width <px>] [--quality <0-1>] [--invoke-timeout <ms>]
  • nodes canvas present --node <id|name|ip> [--target <urlOrPath>] [--x <px>] [--y <px>] [--width <px>] [--height <px>] [--invoke-timeout <ms>]
  • nodes canvas hide --node <id|name|ip> [--invoke-timeout <ms>]
  • nodes canvas navigate <url> --node <id|name|ip> [--invoke-timeout <ms>]
  • nodes canvas eval [<js>] --node <id|name|ip> [--js <code>] [--invoke-timeout <ms>]
  • nodes canvas a2ui push --node <id|name|ip> (--jsonl <path> | --text <text>) [--invoke-timeout <ms>]
  • nodes canvas a2ui reset --node <id|name|ip> [--invoke-timeout <ms>]
  • nodes screen record --node <id|name|ip> [--screen <index>] [--duration <ms|10s>] [--fps <n>] [--no-audio] [--out <path>] [--invoke-timeout <ms>]

Ubicación:

  • nodes location get --node <id|name|ip> [--max-age <ms>] [--accuracy <coarse|balanced|precise>] [--location-timeout <ms>] [--invoke-timeout <ms>]

CLI de control del navegador (Chrome/Brave/Edge/Chromium dedicado). Ver openclaw browser y la Browser tool.

Opciones comunes:

  • --url, --token, --timeout, --json
  • --browser-profile <name>

Gestionar:

  • browser status
  • browser start
  • browser stop
  • browser reset-profile
  • browser tabs
  • browser open <url>
  • browser focus <targetId>
  • browser close [targetId]
  • browser profiles
  • browser create-profile --name <name> [--color <hex>] [--cdp-url <url>]
  • browser delete-profile --name <name>

Inspeccionar:

  • browser screenshot [targetId] [--full-page] [--ref <ref>] [--element <selector>] [--type png|jpeg]
  • browser snapshot [--format aria|ai] [--target-id <id>] [--limit <n>] [--interactive] [--compact] [--depth <n>] [--selector <sel>] [--out <path>]

Acciones:

  • browser navigate <url> [--target-id <id>]
  • browser resize <width> <height> [--target-id <id>]
  • browser click <ref> [--double] [--button <left|right|middle>] [--modifiers <csv>] [--target-id <id>]
  • browser type <ref> <text> [--submit] [--slowly] [--target-id <id>]
  • browser press <key> [--target-id <id>]
  • browser hover <ref> [--target-id <id>]
  • browser drag <startRef> <endRef> [--target-id <id>]
  • browser select <ref> <values...> [--target-id <id>]
  • browser upload <paths...> [--ref <ref>] [--input-ref <ref>] [--element <selector>] [--target-id <id>] [--timeout-ms <ms>]
  • browser fill [--fields <json>] [--fields-file <path>] [--target-id <id>]
  • browser dialog --accept|--dismiss [--prompt <text>] [--target-id <id>] [--timeout-ms <ms>]
  • browser wait [--time <ms>] [--text <value>] [--text-gone <value>] [--target-id <id>]
  • browser evaluate --fn <code> [--ref <ref>] [--target-id <id>]
  • browser console [--level <error|warn|info>] [--target-id <id>]
  • browser pdf [--target-id <id>]

Búsqueda en docs

docs [query...]

Busca en el índice de documentación en vivo.

TUI

tui

Abre la interfaz de terminal conectada al Gateway.

Opciones:

  • --url <url>
  • --token <token>
  • --password <password>
  • --session <key>
  • --deliver
  • --thinking <level>
  • --message <text>
  • --timeout-ms <ms> (por defecto agents.defaults.timeoutSeconds)
  • --history-limit <n>