Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
openclaw hooks

Gestiona los hooks de agentes (automatizaciones basadas en eventos para comandos como /new, /reset y el inicio del Gateway). Ejecutar openclaw hooks sin subcomando equivale a openclaw hooks list. Relacionado:

​
Listar todos los hooks

openclaw hooks list
Enumera todos los hooks descubiertos desde directorios del espacio de trabajo, administrados, extra y empaquetados. El inicio del Gateway no carga controladores de hooks internos hasta que se configure al menos un hook interno. Opciones:
  • --eligible: Muestra solo hooks elegibles (requisitos cumplidos)
  • --json: Genera la salida como JSON
  • -v, --verbose: Muestra información detallada, incluidos los requisitos faltantes
Salida de ejemplo: 
Hooks (4/4 ready)

Ready:
  🚀 boot-md ✓ - Run BOOT.md on gateway startup
  📎 bootstrap-extra-files ✓ - Inject extra workspace bootstrap files during agent bootstrap
  📝 command-logger ✓ - Log all command events to a centralized audit file
  💾 session-memory ✓ - Save session context to memory when /new or /reset command is issued
Ejemplo (detallado): 
openclaw hooks list --verbose
Muestra los requisitos faltantes para hooks no elegibles. Ejemplo (JSON): 
openclaw hooks list --json
Devuelve JSON estructurado para uso programático.

​
Obtener información de un hook

openclaw hooks info <name>
Muestra información detallada sobre un hook específico. Argumentos:
  • <name>: Nombre del hook o clave del hook (por ejemplo, session-memory)
Opciones:
  • --json: Genera la salida como JSON
Ejemplo: 
openclaw hooks info session-memory
Salida: 
💾 session-memory ✓ Ready

Save session context to memory when /new or /reset command is issued

Details:
  Source: openclaw-bundled
  Path: /path/to/openclaw/hooks/bundled/session-memory/HOOK.md
  Handler: /path/to/openclaw/hooks/bundled/session-memory/handler.ts
  Homepage: https://docs.openclaw.ai/automation/hooks#session-memory
  Events: command:new, command:reset

Requirements:
  Config: ✓ workspace.dir

​
Comprobar la elegibilidad de los hooks

openclaw hooks check
Muestra un resumen del estado de elegibilidad de los hooks (cuántos están listos frente a no listos). Opciones:
  • --json: Genera la salida como JSON
Salida de ejemplo: 
Hooks Status

Total hooks: 4
Ready: 4
Not ready: 0

​
Habilitar un hook

openclaw hooks enable <name>
Habilita un hook específico agregándolo a tu configuración (~/.openclaw/openclaw.json de forma predeterminada). Nota: Los hooks del espacio de trabajo están deshabilitados de forma predeterminada hasta que se habiliten aquí o en la configuración. Los hooks administrados por plugins muestran plugin:<id> en openclaw hooks list y no pueden habilitarse ni deshabilitarse aquí. Habilita o deshabilita el plugin en su lugar. Argumentos:
  • <name>: Nombre del hook (por ejemplo, session-memory)
Ejemplo: 
openclaw hooks enable session-memory
Salida: 
✓ Enabled hook: 💾 session-memory
Qué hace:
  • Comprueba si el hook existe y es elegible
  • Actualiza hooks.internal.entries.<name>.enabled = true en tu configuración
  • Guarda la configuración en el disco
Si el hook proviene de <workspace>/hooks/, este paso de inclusión voluntaria es obligatorio antes de que el Gateway lo cargue. Después de habilitarlo:
  • Reinicia el gateway para que los hooks se recarguen (reinicio de la app de la barra de menús en macOS o reinicia tu proceso de gateway en desarrollo).

​
Deshabilitar un hook

openclaw hooks disable <name>
Deshabilita un hook específico actualizando tu configuración. Argumentos:
  • <name>: Nombre del hook (por ejemplo, command-logger)
Ejemplo: 
openclaw hooks disable command-logger
Salida: 
⏸ Disabled hook: 📝 command-logger
Después de deshabilitarlo:
  • Reinicia el gateway para que los hooks se recarguen

​
Notas

  • openclaw hooks list --json, info --json y check --json escriben JSON estructurado directamente en stdout.
  • Los hooks administrados por plugins no pueden habilitarse ni deshabilitarse aquí; habilita o deshabilita el plugin propietario en su lugar.

​
Instalar paquetes de hooks

openclaw plugins install <package>        # npm by default
openclaw plugins install npm:<package>    # npm only
openclaw plugins install <package> --pin  # pin version
openclaw plugins install <path>           # local path
Instala paquetes de hooks mediante el instalador unificado de plugins. openclaw hooks install sigue funcionando como alias de compatibilidad, pero imprime una advertencia de obsolescencia y reenvía a openclaw plugins install. Las especificaciones de npm son solo de registro (nombre de paquete + versión exacta opcional o dist-tag). Las especificaciones Git/URL/archivo y los rangos semver se rechazan. Las instalaciones de dependencias se ejecutan localmente al proyecto con --ignore-scripts por seguridad, incluso cuando tu shell tiene configuraciones globales de instalación de npm. Las especificaciones simples y @latest permanecen en la rama estable. Si npm resuelve cualquiera de ellas a una versión preliminar, OpenClaw se detiene y te pide que aceptes explícitamente con una etiqueta de versión preliminar como @beta/@rc o una versión preliminar exacta. 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: Enlaza un directorio local en lugar de copiarlo (lo agrega a hooks.internal.load.extraDirs)
  • --pin: Registra las instalaciones de npm como name@version resuelto exacto en hooks.internal.installs
Archivos compatibles: .zip, .tgz, .tar.gz, .tar Ejemplos: 
# Local directory
openclaw plugins install ./my-hook-pack

# Local archive
openclaw plugins install ./my-hook-pack.zip

# NPM package
openclaw plugins install @openclaw/my-hook-pack

# Link a local directory without copying
openclaw plugins install -l ./my-hook-pack
Los paquetes de hooks enlazados se tratan como hooks administrados desde un directorio configurado por el operador, no como hooks del espacio de trabajo.

​
Actualizar paquetes de hooks

openclaw plugins update <id>
openclaw plugins update --all
Actualiza los paquetes de hooks basados en npm con seguimiento mediante el actualizador unificado de plugins. openclaw hooks update sigue funcionando como alias de compatibilidad, pero imprime una advertencia de obsolescencia y reenvía a openclaw plugins update. Opciones:
  • --all: Actualiza todos los paquetes de hooks con seguimiento
  • --dry-run: Muestra qué cambiaría sin escribir
Cuando existe un hash de integridad almacenado y el hash del artefacto obtenido cambia, OpenClaw imprime una advertencia y solicita confirmación antes de continuar. Usa --yes global para omitir los avisos en CI/ejecuciones no interactivas.

​
Hooks empaquetados

​
session-memory

Guarda el contexto de sesión en memoria cuando emites /new o /reset. Habilitar: 
openclaw hooks enable session-memory
Salida: ~/.openclaw/workspace/memory/YYYY-MM-DD-HHMM.md de forma predeterminada. Define hooks.internal.entries.session-memory.llmSlug: true para slugs de nombres de archivo generados por el modelo. Ver: documentación de session-memory

​
bootstrap-extra-files

Inyecta archivos de arranque adicionales (por ejemplo, AGENTS.md / TOOLS.md locales al monorepo) durante agent:bootstrap. Habilitar: 
openclaw hooks enable bootstrap-extra-files
Ver: documentación de bootstrap-extra-files

​
command-logger

Registra todos los eventos de comandos en un archivo de auditoría centralizado. Habilitar: 
openclaw hooks enable command-logger
Salida: ~/.openclaw/logs/commands.log Ver registros: 
# Recent commands
tail -n 20 ~/.openclaw/logs/commands.log

# Pretty-print
cat ~/.openclaw/logs/commands.log | jq .

# Filter by action
grep '"action":"new"' ~/.openclaw/logs/commands.log | jq .
Ver: documentación de command-logger

​
boot-md

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

​
Relacionado