Skip to main content
Cascade Hooks vă permit să executați comenzi shell personalizate în momente cheie din fluxul de lucru al Cascade. Această capabilitate puternică de extensibilitate vă permite să înregistrați operațiuni, să impuneți garde-fou, să rulați verificări de validare sau să vă integrați cu sisteme externe.
Hooks sunt concepute pentru utilizatori avansați și echipe Enterprise care au nevoie de control granular asupra comportamentului Cascade. Acestea necesită cunoștințe de bază de scripting în shell.

Ce puteți construi

Hook-urile deblochează o gamă largă de capabilități pentru automatizare și guvernanță:
  • Jurnalizare & Analytics: Monitorizați fiecare fișier citit, modificare de cod, comandă executată, prompt de utilizator sau răspuns Cascade, pentru conformitate și analiză a utilizării
  • Controale de securitate: Împiedicați Cascade să acceseze fișiere sensibile, să ruleze comenzi periculoase sau să proceseze prompturi care încalcă politicile
  • Asigurarea calității: Rulați automat linters, formatare sau teste după modificările de cod
  • Fluxuri de lucru personalizate: Integrați cu trackere de issue-uri, sisteme de notificare sau pipeline-uri de deployment
  • Standardizare la nivel de echipă: Aplicați standarde de cod și bune practici în întreaga organizație

Cum funcționează hook-urile

Hook-urile sunt comenzi de shell care rulează automat atunci când au loc acțiuni Cascade specifice. Fiecare hook:
  1. Primește context (detalii despre acțiunea executată) prin JSON ca intrare standard
  2. Execută scriptul dvs. – Python, Bash, Node.js sau orice executabil
  3. Returnează un rezultat prin codul de ieșire și fluxurile de ieșire
Pentru pre-hook-uri (executate înaintea unei acțiuni), scriptul dvs. poate bloca acțiunea încheindu-se cu codul de ieșire 2. Acest lucru face ca pre-hook-urile să fie ideale pentru implementarea politicilor de securitate sau a verificărilor de validare.

Configurare

Hook‑urile se configurează în fișiere JSON care pot fi plasate la trei niveluri diferite. Cascade încarcă și combină hook‑urile din toate locațiile, oferind echipelor flexibilitate în modul în care distribuie și gestionează configurațiile de hook.

La nivel de sistem

Hook-urile la nivel de sistem sunt ideale pentru politici la nivelul întregii organizații, aplicate pe stații de lucru partajate. De exemplu, le puteți folosi pentru a impune politici de securitate, cerințe de conformitate sau fluxuri de lucru obligatorii pentru code review. Echipele Enterprise pot, de asemenea, să configureze hook-uri prin intermediul dashboard-ului din cloud, fără a fi nevoie să gestioneze fișiere locale.
  • macOS: /Library/Application Support/Windsurf/hooks.json
  • Linux/WSL: /etc/windsurf/hooks.json
  • Windows: C:\ProgramData\Windsurf\hooks.json

La nivel de utilizator

Hookurile la nivel de utilizator sunt ideale pentru preferințe personale și fluxuri de lucru opționale.
  • Windsurf IDE: ~/.codeium/windsurf/hooks.json
  • JetBrains Plugin: ~/.codeium/hooks.json

La nivel de workspace

Hook-urile la nivel de workspace permit echipelor să versiuneze politici specifice proiectului alături de cod. Acestea pot include reguli personalizate de validare, integrări specifice proiectului sau fluxuri de lucru specifice echipei.
  • Locație: .windsurf/hooks.json în rădăcina workspace-ului
Hook-urile din toate cele trei locații sunt comasate. Dacă același eveniment de hook este configurat în mai multe locații, toate hook-urile se vor executa în această ordine: sistem → utilizator → workspace.

Structură de bază

Iată un exemplu al structurii de bază a configurației pentru hooks:

Opțiuni de configurare

Fiecare hook acceptă următorii parametri:
Despre parametrul working_directory:
  • În workspace‑urile cu mai multe repo‑uri, valoarea implicită este rădăcina repo‑ului la care lucrați în prezent
  • Căile relative sunt rezolvate pornind de la locația implicită (rădăcina workspace‑ului sau a repo‑ului)
  • Căile absolute sunt acceptate
  • Utilizarea lui ~ pentru extinderea la directorul home nu este acceptată

Evenimente hook

Cascade oferă douăsprezece evenimente hook care acoperă cele mai importante acțiuni din fluxul de lucru al agentului.

Structura comună a inputului

Toate hook-urile primesc un obiect JSON cu următoarele câmpuri comune: În exemplele de mai jos, câmpurile comune sunt omise pentru concizie. Există douăsprezece tipuri majore de evenimente de tip hook:

pre_read_code

Declanșat înainte ca Cascade să citească un fișier de cod. Acest lucru poate bloca acțiunea dacă hook-ul se încheie cu codul 2. Cazuri de utilizare: Restricționați accesul la fișiere, înregistrați operațiunile de citire, verificați permisiunile Input JSON:
Acest file_path poate fi o cale de director atunci când Cascade parcurge recursiv un director.

post_read_code

Declanșat după ce Cascade citește cu succes un fișier de cod. Cazuri de utilizare: Înregistrați citirile reușite, urmăriți tiparele de acces la fișiere Input JSON:
Acest file_path poate fi o cale de director atunci când Cascade parcurge recursiv un director.

pre_write_code

Declanșat înainte ca Cascade să scrie sau să modifice un fișier de cod. Poate bloca acțiunea dacă hook-ul se încheie cu codul 2. Cazuri de utilizare: Prevenirea modificărilor în fișiere protejate, realizarea de copii de rezervă înainte de schimbări Input JSON:

post_write_code

Declanșat după ce Cascade scrie sau modifică un fișier de cod. Cazuri de utilizare: Rulați linters, formatare sau teste; înregistrați modificările de cod Input JSON:

pre_run_command

Se declanșează înainte ca Cascade să execute o comandă în terminal. Poate bloca acțiunea dacă hook-ul se încheie cu codul 2. Cazuri de utilizare: Blocați comenzile periculoase, înregistrați toate execuțiile de comenzi, adăugați verificări de siguranță Input JSON:

post_run_command

Se declanșează după ce Cascade execută o comandă în terminal. Cazuri de utilizare: înregistrarea rezultatelor comenzii, declanșarea acțiunilor ulterioare Input JSON:

pre_mcp_tool_use

Declanșat înainte ca Cascade să utilizeze un instrument MCP (Model Context Protocol). Poate bloca acțiunea dacă hook-ul se încheie cu codul 2. Cazuri de utilizare: Înregistrarea utilizării MCP, restricționarea instrumentelor MCP care pot fi folosite Input JSON:

post_mcp_tool_use

Declanșat după ce Cascade a apelat cu succes un instrument MCP. Cazuri de utilizare: Înregistrați operațiunile MCP, urmăriți utilizarea API-ului, vizualizați rezultatele MCP Input JSON:

pre_user_prompt

Declanșat înainte ca Cascade să proceseze textul promptului unui utilizator. Acest hook poate bloca acțiunea dacă se încheie cu codul 2. Cazuri de utilizare: Înregistrarea în log a tuturor prompturilor utilizatorilor pentru auditare, blocarea prompturilor potențial dăunătoare sau care încalcă politicile Input JSON:
Opțiunea de configurare show_output nu se aplică acestui hook.

post_cascade_response

Declanșat asincron după ce Cascade finalizează un răspuns la promptul unui utilizator. Acest hook primește întregul răspuns Cascade de la ultima intrare a utilizatorului. Cazuri de utilizare: Înregistrați toate răspunsurile Cascade pentru audit, analizați tiparele de răspuns, trimiteți răspunsurile către sisteme externe pentru verificarea conformității Input JSON:
Câmpul response conține conținutul în format markdown al răspunsului generat de Cascade de la ultima intrare a utilizatorului. Acesta include răspunsurile planificatorului, acțiunile instrumentelor (citiri de fișiere, scrieri, comenzi) și orice alți pași pe care i-a efectuat Cascade. Include și informații despre regulile care au fost declanșate. Consultați exemplul Tracking Triggered Rules pentru a vedea cum să interpretați utilizarea regulilor. Opțiunea de configurare show_output nu se aplică acestui hook.
Conținutul response este derivat din date privind traiectoria și poate conține informații sensibile din codul sau conversațiile dvs. Tratați aceste date în conformitate cu politicile de securitate și confidențialitate ale organizației dvs.

post_cascade_response_with_transcript

Declanșat asincron după ce Cascade finalizează un răspuns la promptul unui utilizator, similar cu post_cascade_response. În loc să ofere un rezumat markdown direct în conversație, acest hook scrie transcrierea completă a conversației (începând de la debutul conversației) într-un fișier JSONL local și furnizează calea către fișier. Cazuri de utilizare: jurnalizare pentru audit și conformitate la nivel Enterprise, urmărirea contribuțiilor generate de AI, trimiterea transcrierilor către instrumente externe de observabilitate sau Analytics Input JSON:
transcript_path indică către un fișier JSONL la ~/.windsurf/transcripts/{trajectory_id}.jsonl. Fiecare linie este un obiect JSON care reprezintă un singur pas în conversație, cu câmpurile type și status, plus date specifice pasului. De exemplu:
Transcriptul include date detaliate, deținute de client, precum conținutul fișierelor, ieșiri ale comenzilor, argumente ale instrumentelor, rezultate de căutare și reguli care au fost aplicate. Vă rugăm să rețineți că structura exactă a fiecărui pas se poate schimba în versiunile viitoare, așa că este indicat să construiți orice componente care consumă hook-uri astfel încât să fie rezistente la schimbări. Fișierele de transcript sunt scrise cu permisiuni 0600. Windsurf limitează automat directorul de transcripturi la 100 de fișiere, ștergându-le pe cele mai vechi în funcție de timpul ultimei modificări. Opțiunea de configurare show_output nu se aplică acestui hook. Acest tabel arată principalele diferențe dintre hook-urile post_cascade_response și post_cascade_response_with_transcript:
Fișierele de transcript vor conține informații sensibile din codul dumneavoastră, inclusiv conținutul fișierelor, ieșiri de comenzi și istoricul conversațiilor. Gestionați aceste fișiere în conformitate cu politicile de securitate și confidențialitate ale organizației dumneavoastră.

post_setup_worktree

Declanșat după ce un nou git worktree este creat și configurat. Hook-ul este executat în noul director worktree. Cazuri de utilizare: Copiați fișierele .env sau alte fișiere neurmărite în worktree, instalați dependențele, rulați scripturi de configurare Variabile de mediu: JSON de intrare:

Coduri de ieșire

Scripturile hook comunică rezultatele prin coduri de ieșire:
Doar pre-hook-urile (pre_user_prompt, pre_read_code, pre_write_code, pre_run_command, pre_mcp_tool_use) pot bloca acțiunile folosind codul de ieșire 2. Post-hook-urile nu pot bloca, deoarece acțiunea a avut deja loc.
Țineți cont că utilizatorul poate vedea orice ieșire standard și eroare standard generate de hook în interfața Cascade dacă show_output este true.

Exemple de scenarii de utilizare

Înregistrarea tuturor acțiunilor Cascade

Monitorizați fiecare acțiune efectuată de Cascade în scopuri de audit. Config:
Script (log_input.py):
Acest script adaugă fiecare apel al unui hook într-un fișier jurnal, creând un traseu de audit pentru toate acțiunile Cascade. Puteți transforma datele de intrare sau rula logică personalizată, după cum considerați potrivit.

Restricționarea accesului la fișiere

Împiedicați Cascade să citească fișiere din afara unui director specific. Config:
Script (block_read_access.py):
Când Cascade încearcă să citească un fișier din afara directorului permis, acest hook blochează operațiunea și afișează un mesaj de eroare.

Blocarea comenzilor periculoase

Împiedicați Cascade să execute comenzi potențial dăunătoare. Config:
Script (block_dangerous_commands.py):
Acest hook scanează comenzile pentru tipare periculoase și le blochează înainte de execuție.

Blocarea prompturilor care încalcă politicile

Împiedicați utilizatorii să trimită prompturi care încalcă politicile organizației. Config:
Scriptul (block_bad_prompts.py):
Acest hook examinează prompturile utilizatorului înainte ca acestea să fie procesate și blochează orice prompt care conține tipare interzise. Atunci când un prompt este blocat, utilizatorul vede un mesaj de eroare în interfața Cascade.

Înregistrarea răspunsurilor Cascade

Urmăriți toate răspunsurile Cascade pentru audit de conformitate sau analiză. Config:
Script (log_cascade_response.py):
Acest hook înregistrează fiecare răspuns Cascade într-un fișier, creând un istoric de audit al întregului conținut generat de AI. Puteți extinde acest comportament pentru a trimite date către sisteme externe de jurnale, baze de date sau platforme de conformitate.

Urmărirea regulilor declanșate

Urmăriți care reguli au fost aplicate în timpul interacțiunilor cu Cascade, pentru observabilitate și metrici. Configurație:
Script (track_rules.py):
Tipuri de reguli:
  • Always On - Reguli care sunt incluse întotdeauna
  • Model Decision - Reguli ale căror descrieri au fost afișate modelului AI pentru aplicare condiționată
  • Manual - Reguli menționate explicit cu @ în introducerea utilizatorului
  • Global - Reguli globale din global_rules.md
  • Glob - Reguli declanșate de accesarea fișierelor care se potrivesc cu șabloane glob
Aceasta urmărește ce reguli au fost prezentate modelului AI sau declanșate de accesarea fișierelor, dar nu indică dacă modelul AI a respectat efectiv o regulă. Regulile care au fost deja afișate recent în conversație sunt deduplicate și este posibil să nu mai apară din nou decât mai târziu.

Rularea formatarelor de cod după modificări

Formatați automat fișierele de cod după ce Cascade le actualizează. Config:
Script (format_code.sh):
Acest hook rulează automat formatorul adecvat în funcție de tipul fișierului, după fiecare modificare.

Configurarea worktree-urilor

Copiați fișierele de mediu și instalați dependențele la crearea unui nou worktree. Config (în .windsurf/hooks.json):
Script (hooks/setup_worktree.sh):
Acest hook se asigură că fiecare worktree are în mod automat configurată configurația de mediu necesară și dependențele instalate.

Recomandări de bune practici

Securitate

Utilizați Cascade Hooks pe propria răspundere: Hook‑urile execută automat comenzi de shell cu toate permisiunile contului dvs. de utilizator. Sunteți pe deplin responsabil(ă) pentru codul pe care îl configurați. Hook‑urile proiectate defectuos sau malițioase pot modifica fișiere, șterge date, expune credențiale sau compromite sistemul.
  • Validați toate intrările: Nu aveți niciodată încredere în JSON‑ul de intrare fără validare, mai ales în ceea ce privește căile de fișiere și comenzile.
  • Folosiți căi absolute: Utilizați întotdeauna căi absolute în configurațiile hook‑urilor pentru a evita ambiguitățile.
  • Protejați datele sensibile: Evitați înregistrarea (logging) informațiilor sensibile, precum chei API sau credențiale.
  • Revizuiți permisiunile: Asigurați-vă că scripturile hook au permisiuni adecvate în sistemul de fișiere.
  • Auditați înainte de implementare: Examinați fiecare comandă și script de hook înainte de a le adăuga în configurație.
  • Testați în izolare: Rulați hook‑urile într-un mediu de test înainte de a le activa pe stația dvs. principală de dezvoltare.

Considerații privind performanța

  • Păstrați hook-urile rapide: Hook-urile lente vor afecta capacitatea de răspuns a Cascade. Vizați timpi de execuție sub 100 ms.
  • Folosiți operațiuni asincrone: Pentru hook-uri neblocante, luați în considerare logarea într-o coadă sau într-o bază de date, asincron.
  • Filtrați cât mai devreme: Verificați tipul acțiunii la începutul scriptului pentru a evita procesarea inutilă.

Gestionarea erorilor

  • Validați întotdeauna JSON-ul: Folosiți blocuri try-catch pentru a gestiona elegant datele de intrare malformate.
  • Înregistrați corect erorile: Trimiteți erorile la stderr pentru a fi vizibile când show_output este activat.
  • Eșuați în siguranță: Dacă hook-ul dvs. întâmpină o eroare, evaluați dacă ar trebui să blocheze acțiunea sau să permită continuarea acesteia.

Testarea hook-urilor

  1. Începeți cu jurnalizarea: Implementați mai întâi un hook simplu de jurnalizare pentru a înțelege fluxul de date.
  2. Folosiți show_output: true: Activați afișarea rezultatelor în timpul dezvoltării pentru a vedea ce fac hook-urile.
  3. Testați comportamentul de blocare: Verificați că valoarea de ieșire 2 (exit code 2) blochează corect acțiunile în pre-hooks.
  4. Verificați toate ramurile de cod: Testați atât scenariile de reușită, cât și pe cele de eșec în scripturi.

Distribuție Enterprise

Organizațiile Enterprise trebuie să aplice politici de securitate, cerințe de conformitate și standarde de dezvoltare pe care utilizatorii individuali nu le pot evita. Cascade Hooks susține două metode de distribuție Enterprise:
  1. Cloud Dashboard – Configurați hooks în Team Settings din dashboard-ul Windsurf
  2. System-Level Files – Implementați hooks prin MDM sau instrumente de gestionare a configurațiilor
Ambele metode pot fi utilizate împreună — hooks din toate sursele sunt combinate și executate în ordine.

Configurarea dashboard-ului în cloud

Administratorii de echipă pot configura Cascade Hooks direct din dashboard-ul Windsurf. Cerințe:
  • Plan Enterprise
  • Permisiunea TEAM_SETTINGS_UPDATE
Pentru configurare:
  1. Navigați la Team Settings în dashboard-ul Windsurf
  2. Găsiți secțiunea Cascade Hooks
  3. Introduceți configurația pentru hooks, în format JSON
  4. Salvați modificările
Hook-urile configurate din dashboard sunt distribuite automat tuturor membrilor echipei și sunt încărcate la pornirea Windsurf. Hook-urile configurate în cloud sunt încărcate mai întâi, urmate de hook-urile la nivel de sistem, la nivel de utilizator și la nivel de workspace.
Atunci când mai multe configurații de echipă sunt îmbinate, hook-urile sunt combinate pentru fiecare acțiune, în loc să fie suprascrise. Aceasta înseamnă că hook-urile din toate configurațiile de echipă aplicabile vor rula împreună.

Implementare fișiere la nivel de sistem

Pentru organizațiile care preferă configurarea bazată pe fișiere sau care au nevoie ca hook-urile să funcționeze offline, implementați configurația obligatorie hooks.json în aceste locații specifice sistemului de operare: macOS:
Linux/WSL:
Windows:
Plasați scripturile hook într-un director de sistem corespunzător (de ex. „/usr/local/share/windsurf-hooks/” pe sistemele Unix). Hook-urile la nivel de sistem au prioritate față de hook-urile de utilizator și de workspace și nu pot fi dezactivate de utilizatorii finali fără permisiuni de root.

MDM și gestionarea configurațiilor

Echipele IT Enterprise pot implementa hook‑uri la nivel de sistem folosind instrumente standard: Mobile Device Management (MDM)
  • Jamf Pro (macOS) - Implementare prin profiluri de configurare sau scripturi
  • Microsoft Intune (Windows/macOS) - Utilizați scripturi PowerShell sau implementarea prin politici
  • Workspace ONE, Google Endpoint Management și alte soluții MDM
Gestionarea configurațiilor
  • Ansible, Puppet, Chef, SaltStack - Utilizați automatizarea existentă a infrastructurii
  • Scripturi personalizate de implementare - Scripturi shell, PowerShell sau instrumentele preferate

Verificare și auditare

După implementare, verificați că hook-urile sunt instalate corect:
Important: Hook-urile la nivel de sistem sunt administrate în întregime de echipa dvs. IT sau de securitate. Windsurf nu distribuie și nu gestionează fișiere în locații la nivel de sistem. Asigurați-vă că echipele interne se ocupă de distribuire, actualizări și conformitate în acord cu politicile organizației dvs.

Hook-uri de workspace pentru proiecte de echipă

Pentru convenții specifice fiecărui proiect, echipele pot utiliza hook-uri la nivel de workspace în sistemul de control al versiunilor:
Acest lucru permite echipelor să standardizeze practicile de dezvoltare. Păstrați politicile critice pentru securitate la nivel de cloud sau de sistem și evitați să introduceți informații sensibile în sistemul de control al versiunilor.

Resurse suplimentare