Saltar al contenido principal
Los Hooks de Cascade te permiten ejecutar comandos de shell personalizados en puntos clave del flujo de trabajo de Cascade. Esta potente función de extensibilidad te permite registrar operaciones, aplicar controles, ejecutar comprobaciones de validación o integrarte con sistemas externos.
Los hooks están diseñados para usuarios avanzados y equipos empresariales que necesitan un control preciso sobre el comportamiento de Cascade. Requieren conocimientos básicos de scripting de shell.

Qué puedes crear

Hooks habilitan una amplia gama de capacidades de automatización y gobernanza:
  • Registro y analítica: Supervisa cada archivo leído, cambio de código, comando ejecutado, prompt de usuario o respuesta de Cascade para el cumplimiento normativo y el análisis de uso
  • Controles de seguridad: Impide que Cascade acceda a archivos sensibles, ejecute comandos peligrosos o procese prompts que infrinjan las políticas
  • Garantía de calidad: Ejecuta linters, formateadores o pruebas automáticamente tras modificar el código
  • Flujos de trabajo personalizados: Integra sistemas de seguimiento de incidencias, sistemas de notificaciones o pipelines de despliegue
  • Estandarización del equipo: Aplica estándares de codificación y prácticas recomendadas en toda tu organización

Cómo funcionan los Hooks

Los Hooks son comandos de shell que se ejecutan automáticamente cuando se producen acciones específicas de Cascade. Cada hook:
  1. Recibe contexto (detalles sobre la acción que se está realizando) en formato JSON a través de la entrada estándar
  2. Ejecuta tu script: Python, Bash, Node.js o cualquier ejecutable
  3. Devuelve un resultado mediante el código de salida y los flujos de salida
En el caso de los pre-hooks (ejecutados antes de una acción), tu script puede bloquear la acción si finaliza con el código de salida 2. Esto hace que los pre-hooks sean ideales para implementar políticas de seguridad o validaciones.

Configuración

Los Hooks se configuran en archivos JSON que pueden colocarse en tres niveles diferentes. Cascade carga y fusiona los hooks de todas las ubicaciones, lo que da a los equipos flexibilidad para distribuir y gestionar las configuraciones de hooks.

A nivel del sistema

Los hooks a nivel del sistema son ideales para aplicar políticas de toda la organización en máquinas de desarrollo compartidas. Por ejemplo, puedes usarlos para aplicar políticas de seguridad, requisitos de cumplimiento o flujos de trabajo obligatorios de revisión de código. Los equipos Enterprise también pueden configurar hooks desde el panel de control en la nube sin tener que gestionar archivos locales.
  • macOS: /Library/Application Support/Windsurf/hooks.json
  • Linux/WSL: /etc/windsurf/hooks.json
  • Windows: C:\ProgramData\Windsurf\hooks.json

Nivel de usuario

Los hooks a nivel de usuario son ideales para preferencias personales y flujos de trabajo opcionales.
  • Devin Desktop IDE: ~/.codeium/windsurf/hooks.json
  • Plugin de JetBrains: ~/.codeium/hooks.json

A nivel del espacio de trabajo

Los hooks a nivel del espacio de trabajo permiten a los equipos gestionar las versiones de las políticas específicas del proyecto junto con su código. Pueden incluir reglas de validación personalizadas, integraciones específicas del proyecto o flujos de trabajo específicos del equipo.
  • Ubicación: .windsurf/hooks.json en la raíz de tu espacio de trabajo
Los hooks de las tres ubicaciones se combinan. Si el mismo evento de hook está configurado en múltiples ubicaciones, todos los hooks se ejecutarán en este orden: sistema → usuario → espacio de trabajo.

Estructura básica

A continuación se muestra un ejemplo de la estructura básica de la configuración de hooks:
En este ejemplo, pre_read_code especifica tanto un comando para macOS/Linux como un comando de PowerShell para Windows. El hook post_write_code solo especifica command, por lo que se ejecutará en macOS/Linux y, en Windows, usará PowerShell como alternativa.

Opciones de configuración

Cada hook acepta los siguientes parámetros:

Comportamiento en distintas plataformas

Los campos command y powershell permiten definir comandos adecuados para cada plataforma en una sola configuración. Esto resulta útil para equipos con entornos mixtos de macOS/Linux y Windows.
Acerca del parámetro working_directory:
  • En espacios de trabajo con varios repos, el valor predeterminado es la raíz del repo en el que se está trabajando en ese momento
  • Las rutas relativas se resuelven desde la ubicación predeterminada (espacio de trabajo o raíz del repo)
  • Se admiten rutas absolutas
  • No se admite usar ~ para expandir el directorio de inicio

Eventos de hook

Cascade ofrece doce eventos de hook que cubren las acciones más importantes del flujo de trabajo del agente.

Estructura de entrada común

Todos los hooks reciben un objeto JSON con los siguientes campos comunes: En los siguientes ejemplos, los campos comunes se omiten por brevedad. Hay doce tipos principales de eventos de hook:

pre_read_code

Se activa antes de que Cascade lea un archivo de código. Puede bloquear la acción si el hook finaliza con el código 2. Casos de uso: Restringir el acceso a archivos, registrar operaciones de lectura, comprobar permisos JSON de entrada:
Este file_path puede ser la ruta de un directorio cuando Cascade lee ese directorio de forma recursiva.

post_read_code

Se activa después de que Cascade lea correctamente un archivo de código. Casos de uso: Registrar lecturas exitosas, hacer seguimiento de los patrones de acceso a archivos JSON de entrada:
Este file_path puede ser la ruta de un directorio cuando Cascade lee un directorio de forma recursiva.

pre_write_code

Se activa antes de que Cascade escriba o modifique un archivo de código. Esto puede bloquear la operación si el hook finaliza con el código 2. Casos de uso: Evitar modificaciones en archivos protegidos, crear copias de seguridad antes de los cambios JSON de entrada:

post_write_code

Se activa después de que Cascade escribe o modifica un archivo de código. Casos de uso: Ejecutar linters, formateadores o pruebas; registrar cambios en el código JSON de entrada:

pre_run_command

Se activa antes de que Cascade ejecute un comando en la terminal. Esto puede bloquear la ejecución si el hook finaliza con el código 2. Casos de uso: Bloquear comandos peligrosos, registrar todas las ejecuciones de comandos, agregar comprobaciones de seguridad JSON de entrada:

post_run_command

Se activa después de que Cascade ejecuta un comando en la terminal. Casos de uso: Registrar los resultados del comando, activar acciones posteriores JSON de entrada:

pre_mcp_tool_use

Se activa antes de que Cascade invoque una herramienta MCP (Model Context Protocol). Esto puede bloquear la acción si el hook finaliza con el código 2. Casos de uso: Registrar el uso de herramientas MCP, restringir qué herramientas MCP se pueden usar JSON de entrada:

post_mcp_tool_use

Se activa después de que Cascade invoque correctamente una herramienta MCP. Casos de uso: Registrar operaciones de MCP, supervisar el uso de la API, ver resultados de MCP JSON de entrada:

pre_user_prompt

Se activa antes de que Cascade procese el texto del prompt del usuario. Esto puede bloquear la acción si el hook finaliza con el código 2. Casos de uso: Registrar todos los prompts de los usuarios para fines de auditoría, bloquear prompts potencialmente dañinos o que infrinjan las políticas JSON de entrada:
La opción de configuración show_output no es aplicable a este hook.

post_cascade_response

Se activa de forma asíncrona después de que Cascade complete una respuesta al prompt de un usuario. Este hook recibe la respuesta completa de Cascade desde el último mensaje del usuario. Casos de uso: Registrar todas las respuestas de Cascade para auditoría, analizar patrones de respuesta, enviar respuestas a sistemas externos para revisión de cumplimiento JSON de entrada:
El campo response contiene el contenido en formato Markdown de la respuesta de Cascade desde la última entrada del usuario. Esto incluye respuestas del planner, acciones de las herramientas (lecturas y escrituras de archivos, comandos) y cualquier otro paso que haya realizado Cascade. También incluye información sobre qué Rules se activaron. Consulta el ejemplo Tracking Triggered Rules para ver cómo analizar el uso de Rules. La opción de configuración show_output no se aplica a este hook.
El contenido de response se deriva de los datos de la trayectoria y puede contener información confidencial de tu base de código o de tus conversaciones. Maneja estos datos de acuerdo con las políticas de seguridad y privacidad de tu organización.

post_cascade_response_with_transcript

Se activa de forma asíncrona después de que Cascade complete una respuesta al prompt de un usuario, de forma similar a post_cascade_response. En lugar de proporcionar un resumen en markdown directamente, este hook escribe la transcripción completa de la conversación (desde su inicio) en un archivo JSONL local y proporciona la ruta del archivo. Casos de uso: registro de auditoría y cumplimiento de Enterprise, seguimiento de contribuciones generadas por IA, envío de transcripciones a herramientas externas de observabilidad o analítica JSON de entrada:
La ruta transcript_path apunta a un archivo JSONL en ~/.windsurf/transcripts/{trajectory_id}.jsonl. Cada línea es un objeto JSON que representa un único paso de la conversación, con los campos type y status, además de datos específicos de ese paso. Por ejemplo:
La transcripción incluye datos detallados del cliente, como contenido de archivos, salidas de comandos, argumentos de herramientas, resultados de búsqueda y Rules aplicadas. Ten en cuenta que la estructura exacta de cada paso puede cambiar en futuras versiones, así que diseña cualquier consumidor de hooks para que sea resistente a cambios. Los archivos de transcripción se escriben con permisos 0600. Devin Desktop limita automáticamente el directorio de transcripciones a 100 archivos y elimina los más antiguos según su fecha de modificación. La opción de configuración show_output no se aplica a este hook. Esta tabla muestra las diferencias clave entre los hooks post_cascade_response y post_cascade_response_with_transcript:
Los archivos de transcripción contendrán información sensible de tu base de código, incluido el contenido de archivos, salidas de comandos y el historial de conversaciones. Maneja estos archivos de acuerdo con las políticas de seguridad y privacidad de tu organización.

post_setup_worktree

Se activa después de crear y configurar un nuevo git worktree. El hook se ejecuta dentro del directorio del nuevo worktree. Casos de uso: Copiar archivos .env u otros archivos sin seguimiento al worktree, instalar dependencias, ejecutar scripts de configuración Variables de entorno: JSON de entrada:

Códigos de salida

Los scripts de tus hooks comunican los resultados mediante códigos de salida:
Solo los pre-hooks (pre_user_prompt, pre_read_code, pre_write_code, pre_run_command, pre_mcp_tool_use) pueden bloquear acciones con el código de salida 2. Los post-hooks no pueden bloquearlas porque la acción ya ocurrió.
Ten en cuenta que el usuario puede ver cualquier salida estándar y error estándar generados por hooks en la interfaz de usuario de Cascade si show_output es true.

Casos de uso de ejemplo

Registro de todas las acciones de Cascade

Registra todas las acciones que realiza Cascade con fines de auditoría. Config:
Script (log_input.py):
Este script añade cada invocación de hook a un archivo de registro, creando un registro de auditoría de todas las acciones de Cascade. Puede transformar los datos de entrada o aplicar lógica personalizada como mejor le parezca.

Restringir el acceso a los archivos

Evita que Cascade lea archivos fuera de un directorio específico. Config:
Script (block_read_access.py):
Cuando Cascade intenta leer un archivo fuera del directorio autorizado, este hook bloquea la operación y muestra un mensaje de error.

Bloqueo de comandos peligrosos

Evita que Cascade ejecute comandos potencialmente peligrosos. Configuración:
Script (block_dangerous_commands.py):
Este hook escanea los comandos en busca de patrones peligrosos y los bloquea antes de ejecutarlos.

Bloqueo de prompts que incumplen las políticas

Evita que los usuarios envíen prompts que incumplan las políticas de la organización. Configuración:
Script (block_bad_prompts.py):
Este hook revisa los prompts del usuario antes de que se procesen y bloquea los que contienen patrones prohibidos. Cuando se bloquea un prompt, el usuario ve un mensaje de error en la UI de Cascade.

Registro de respuestas de Cascade

Registra todas las respuestas de Cascade para auditorías de cumplimiento o análisis. Configuración:
Script (log_cascade_response.py):
Este hook registra cada respuesta de Cascade en un archivo, lo que crea un registro de auditoría de todo el contenido generado por la IA. Puedes ampliarlo para enviar datos a sistemas externos de registro, bases de datos o plataformas de cumplimiento normativo.

Seguimiento de las Rules activadas

Identifica qué Rules se aplicaron durante las interacciones de Cascade para mejorar la observabilidad y las métricas. Configuración:
Script (track_rules.py):
Tipos de Rules:
  • Always On - Rules que siempre se incluyen
  • Model Decision - Rules cuyas descripciones se mostraron al modelo para su aplicación condicional
  • Manual - Rules mencionadas explícitamente con @ en la entrada del usuario
  • Global - Rules globales de global_rules.md
  • Glob - Rules activadas por accesos a archivos que coinciden con patrones glob
Esto indica qué Rules se presentaron al modelo o se activaron por acceso a archivos, pero no si el modelo realmente siguió una Rule. Las Rules que ya se mostraron recientemente en la conversación se deduplican y es posible que no vuelvan a aparecer hasta más adelante.

Ejecutar formateadores de código tras las ediciones

Formatea automáticamente los archivos de código después de que Cascade los modifique. Configuración:
Script (format_code.sh):
Este hook ejecuta automáticamente el formateador adecuado en función del tipo de archivo después de cada edición.

Configuración de worktrees

Copia los archivos de Environment e instala las dependencias cuando se cree un nuevo worktree. Configuración (en .windsurf/hooks.json):
Script (hooks/setup_worktree.sh):
Este hook garantiza que cada worktree tenga la Configuración de Environment necesaria y que las dependencias se instalen automáticamente.

Buenas prácticas

Seguridad

Usa Cascade Hooks por tu cuenta y riesgo: Los hooks ejecutan comandos de shell automáticamente con todos los permisos de tu cuenta de usuario. Eres totalmente responsable del código que configures. Los hooks mal diseñados o maliciosos pueden modificar archivos, eliminar datos, exponer credenciales o comprometer tu sistema.
  • Valida todas las entradas: Nunca confíes en el JSON de entrada sin validarlo, especialmente en rutas de archivos y comandos.
  • Usa rutas absolutas: Usa siempre rutas absolutas en la configuración de tus hooks para evitar ambigüedades.
  • Protege los datos sensibles: Evita registrar información sensible, como claves de API o credenciales.
  • Revisa los permisos: Asegúrate de que los scripts de tus hooks tengan los permisos adecuados en el sistema de archivos.
  • Audita antes del despliegue: Revisa cada comando y script de hook antes de agregarlo a tu configuración.
  • Prueba de forma aislada: Ejecuta los hooks en un entorno de prueba antes de habilitarlos en tu equipo principal de desarrollo.

Consideraciones de rendimiento

  • Mantén los hooks rápidos: Los hooks lentos afectarán la capacidad de respuesta de Cascade. Procura que los tiempos de ejecución sean inferiores a 100 ms.
  • Usa operaciones asíncronas: Para hooks no bloqueantes, considera registrar la información en una cola o base de datos de forma asíncrona.
  • Filtra desde el principio: Comprueba el tipo de acción al inicio de tu script para evitar procesamiento innecesario.

Manejo de errores

  • Valida siempre el JSON: Usa bloques try-catch para gestionar correctamente las entradas malformadas.
  • Registra los errores correctamente: Escribe los errores en stderr para que sean visibles cuando show_output esté habilitado.
  • Falla de forma segura: Si tu hook encuentra un error, considera si debe bloquear la acción o permitir que continúe.

Cómo probar tus Hooks

  1. Empieza con el registro: Comienza implementando un hook de registro simple para comprender el flujo de datos.
  2. Usa show_output: true: Habilita la salida durante el desarrollo para ver qué hacen tus hooks.
  3. Prueba el comportamiento de bloqueo: Verifica que el código de salida 2 bloquee correctamente las acciones en los pre-hooks.
  4. Comprueba todos los caminos de ejecución: Prueba tanto los escenarios de éxito como los de error en tus scripts.

Distribución empresarial

Las organizaciones Enterprise necesitan aplicar políticas de seguridad, requisitos de cumplimiento y estándares de desarrollo que los usuarios individuales no pueden eludir. Cascade Hooks admite dos métodos de distribución empresarial:
  1. Panel en la nube - Configura los hooks desde Team Settings en el panel de Devin Desktop
  2. Archivos del sistema - Implementa hooks mediante MDM o herramientas de gestión de configuración
Ambos métodos pueden usarse juntos: los hooks de todas las fuentes se combinan y se ejecutan en orden.

Configuración del panel en la nube

Los Admin del equipo pueden configurar Cascade Hooks directamente desde el dashboard de Devin Desktop. Requisitos:
  • plan Enterprise
  • permiso TEAM_SETTINGS_UPDATE
Para configurar:
  1. Ve a Team Settings en el dashboard de Devin Desktop
  2. Busca la sección Cascade Hooks
  3. Introduce la configuración de los hooks en formato JSON
  4. Guarda tus cambios
Los hooks configurados a través del dashboard se distribuyen automáticamente a todos los miembros del equipo y se cargan al iniciar Devin Desktop. Los hooks configurados en la nube se cargan primero, seguidos de los hooks de nivel de sistema, de nivel de usuario y de nivel de espacio de trabajo.
Cuando se combinan varias configuraciones de equipo, los hooks se combinan por acción en lugar de sobrescribirse. Esto significa que los hooks de todas las configuraciones de equipo aplicables se ejecutarán en conjunto.

Despliegue de archivos en el sistema

Para las organizaciones que prefieren una configuración basada en archivos o necesitan que los hooks funcionen sin conexión, despliega tu configuración obligatoria de hooks.json en estas ubicaciones específicas del sistema operativo: macOS:
Linux/WSL:
Windows:
Coloca tus scripts de hook en el directorio del sistema correspondiente (p. ej., /usr/local/share/windsurf-hooks/ en sistemas Unix). Los hooks de nivel de sistema tienen prioridad sobre los hooks de usuario y del espacio de trabajo, y los usuarios finales no pueden deshabilitarlos sin permisos de root.

MDM y gestión de la configuración

Los equipos de TI empresariales pueden desplegar hooks a nivel de sistema con herramientas estándar: Gestión de dispositivos móviles (MDM)
  • Jamf Pro (macOS) - Despliegue mediante perfiles de configuración o scripts
  • Microsoft Intune (Windows/macOS) - Usa scripts de PowerShell o implementaciones de políticas
  • Workspace ONE, Google Endpoint Management y otras soluciones de MDM
Gestión de la configuración
  • Ansible, Puppet, Chef, SaltStack - Usa tu automatización de infraestructura existente
  • Scripts de despliegue personalizados - Scripts de shell, PowerShell o las herramientas que prefieras

Verificación y auditoría

Después del despliegue, verifica que los hooks estén instalados correctamente:
Importante: Tu equipo de TI o de seguridad gestiona por completo los hooks a nivel de sistema. Devin Desktop no instala ni gestiona archivos en rutas del sistema. Asegúrate de que tus equipos internos se encarguen del despliegue, las actualizaciones y el cumplimiento de las políticas de tu organización.

Hooks del espacio de trabajo para proyectos de equipo

Para las convenciones específicas del proyecto, los equipos pueden usar hooks de espacio de trabajo en el control de versiones:
Esto permite a los equipos estandarizar las prácticas de desarrollo. Mantenga las políticas de seguridad críticas a nivel de la nube o del sistema, y evite incluir información sensible en el control de versiones.

Recursos adicionales