Skip to main content

openclaw hooks

Administre hooks del agente (automatizaciones impulsadas por eventos para comandos como /new, /reset y el inicio del Gateway). Relacionado:

Listar todos los hooks

Enumera todos los hooks descubiertos desde los directorios del espacio de trabajo, gestionados y empaquetados. Opciones:
  • --eligible: Mostrar solo hooks elegibles (requisitos cumplidos)
  • --json: Salida en formato JSON
  • -v, --verbose: Mostrar información detallada, incluidos los requisitos faltantes
Ejemplo de salida:
Ejemplo (detallado):
Muestra los requisitos faltantes para hooks no elegibles. Ejemplo (JSON):
Devuelve JSON estructurado para uso programático.

Obtener información de un hook

Muestra información detallada sobre un hook específico. Argumentos:
  • <name>: Nombre del hook (p. ej., session-memory)
Opciones:
  • --json: Salida en formato JSON
Ejemplo:
Salida:

Comprobar la elegibilidad de los hooks

Muestra un resumen del estado de elegibilidad de los hooks (cuántos están listos frente a los que no). Opciones:
  • --json: Salida en formato JSON
Ejemplo de salida:

Habilitar un hook

Habilita un hook específico agregándolo a su configuración (~/.openclaw/config.json). Nota: Los hooks gestionados por plugins muestran plugin:<id> en openclaw hooks list y no se pueden habilitar/deshabilitar aquí. Habilite o deshabilite el plugin en su lugar. Argumentos:
  • <name>: Nombre del hook (p. ej., session-memory)
Ejemplo:
Salida:
Qué hace:
  • Verifica si el hook existe y es elegible
  • Actualiza hooks.internal.entries.<name>.enabled = true en su configuración
  • Guarda la configuración en el disco
Después de habilitar:
  • Reinicie el Gateway para que los hooks se recarguen (reinicio de la app de la barra de menú en macOS, o reinicie su proceso del Gateway en desarrollo).

Deshabilitar un hook

Deshabilita un hook específico actualizando su configuración. Argumentos:
  • <name>: Nombre del hook (p. ej., command-logger)
Ejemplo:
Salida:
Después de deshabilitar:
  • Reinicie el Gateway para que los hooks se recarguen

Instalar hooks

Instala un paquete de hooks desde una carpeta/archivo local o npm. Las especificaciones de Npm son solo de registro (nombre del paquete + versión/etiqueta opcional). Especificaciones de Git/URL/file no están permitidas. Las instalaciones de dependencias se ejecutan con --ignore-scripts por seguridad. Qué hace:
  • Copia el paquete de hooks en ~/.openclaw/hooks/<id>
  • Habilita los hooks instalados en hooks.internal.entries.*
  • Registra la instalación en hooks.internal.installs
Opciones:
  • -l, --link: Vincular un directorio local en lugar de copiarlo (lo agrega a hooks.internal.load.extraDirs)
Archivos compatibles: .zip, .tgz, .tar.gz, .tar Ejemplos:

Actualizar hooks

Actualiza los paquetes de hooks instalados (solo instalaciones desde npm). Opciones:
  • --all: Actualizar todos los paquetes de hooks rastreados
  • --dry-run: Mostrar qué cambiaría sin escribir cambios

Hooks incluidos

session-memory

Guarda el contexto de la sesión en memoria cuando emite /new. Habilitar:
Salida: ~/.openclaw/workspace/memory/YYYY-MM-DD-slug.md Ver: documentación de session-memory

bootstrap-extra-files

Inyecta archivos adicionales de bootstrap (por ejemplo AGENTS.md / TOOLS.md locales de un monorepo) durante agent:bootstrap. Habilitar:
Ver: SOUL Evil Hook

command-logger

Registra todos los eventos de comandos en un archivo de auditoría centralizado. Habilitar:
Salida: ~/.openclaw/logs/commands.log Ver registros:
Ver: documentación de command-logger

boot-md

Ejecuta BOOT.md cuando el Gateway se inicia (después de que los canales se inician). Eventos: gateway:startup Habilitar:
Ver: documentación de boot-md