Hooks
Personnalisez et étendez le comportement de Claude Code en enregistrant des commandes shell
Introduction
Les hooks de Claude Code sont des commandes shell définies par l’utilisateur qui s’exécutent à divers moments du cycle de vie de Claude Code. Les hooks fournissent un contrôle déterministe sur le comportement de Claude Code, garantissant que certaines actions se produisent toujours plutôt que de compter sur le LLM pour choisir de les exécuter.
Les cas d’usage d’exemple incluent :
- Notifications : Personnalisez la façon dont vous êtes notifié lorsque Claude Code attend votre saisie ou permission pour exécuter quelque chose.
- Formatage automatique : Exécutez
prettier
sur les fichiers .ts,gofmt
sur les fichiers .go, etc. après chaque modification de fichier. - Journalisation : Suivez et comptez toutes les commandes exécutées pour la conformité ou le débogage.
- Retour d’information : Fournissez un retour automatisé lorsque Claude Code produit du code qui ne suit pas les conventions de votre base de code.
- Permissions personnalisées : Bloquez les modifications aux fichiers de production ou aux répertoires sensibles.
En encodant ces règles comme hooks plutôt que comme instructions d’invite, vous transformez les suggestions en code au niveau de l’application qui s’exécute chaque fois qu’il est censé s’exécuter.
Les hooks exécutent des commandes shell avec vos permissions utilisateur complètes sans confirmation. Vous êtes responsable de vous assurer que vos hooks sont sûrs et sécurisés. Anthropic n’est pas responsable de toute perte de données ou dommage système résultant de l’utilisation des hooks. Consultez Considérations de sécurité.
Démarrage rapide
Dans ce démarrage rapide, vous ajouterez un hook qui journalise les commandes shell que Claude Code exécute.
Prérequis du démarrage rapide : Installez jq
pour le traitement JSON en ligne de commande.
Étape 1 : Ouvrir la configuration des hooks
Exécutez la commande slash /hooks
et sélectionnez l’événement hook PreToolUse
.
Les hooks PreToolUse
s’exécutent avant les appels d’outils et peuvent les bloquer tout en fournissant un retour à Claude sur ce qu’il faut faire différemment.
Étape 2 : Ajouter un matcher
Sélectionnez + Add new matcher…
pour exécuter votre hook uniquement sur les appels d’outils Bash.
Tapez Bash
pour le matcher.
Étape 3 : Ajouter le hook
Sélectionnez + Add new hook…
et entrez cette commande :
Étape 4 : Sauvegarder votre configuration
Pour l’emplacement de stockage, sélectionnez User settings
puisque vous journalisez dans votre répertoire personnel. Ce hook s’appliquera alors à tous les projets, pas seulement à votre projet actuel.
Puis appuyez sur Échap jusqu’à ce que vous retourniez au REPL. Votre hook est maintenant enregistré !
Étape 5 : Vérifier votre hook
Exécutez /hooks
à nouveau ou vérifiez ~/.claude/settings.json
pour voir votre configuration :
Configuration
Les hooks de Claude Code sont configurés dans vos fichiers de paramètres :
~/.claude/settings.json
- Paramètres utilisateur.claude/settings.json
- Paramètres de projet.claude/settings.local.json
- Paramètres de projet locaux (non committé)- Paramètres de politique gérée d’entreprise
Structure
Les hooks sont organisés par matchers, où chaque matcher peut avoir plusieurs hooks :
- matcher : Motif pour faire correspondre les noms d’outils (applicable uniquement pour
PreToolUse
etPostToolUse
)- Les chaînes simples correspondent exactement :
Write
correspond uniquement à l’outil Write - Supporte les regex :
Edit|Write
ouNotebook.*
- Si omis ou chaîne vide, les hooks s’exécutent pour tous les événements correspondants
- Les chaînes simples correspondent exactement :
- hooks : Tableau de commandes à exécuter lorsque le motif correspond
type
: Actuellement seul"command"
est supportécommand
: La commande bash à exécutertimeout
: (Optionnel) Combien de temps une commande doit s’exécuter, en secondes, avant d’annuler tous les hooks en cours.
Événements de hooks
PreToolUse
S’exécute après que Claude crée les paramètres d’outil et avant de traiter l’appel d’outil.
Matchers communs :
Task
- Tâches d’agentBash
- Commandes shellGlob
- Correspondance de motifs de fichiersGrep
- Recherche de contenuRead
- Lecture de fichiersEdit
,MultiEdit
- Édition de fichiersWrite
- Écriture de fichiersWebFetch
,WebSearch
- Opérations web
PostToolUse
S’exécute immédiatement après qu’un outil se termine avec succès.
Reconnaît les mêmes valeurs de matcher que PreToolUse.
Notification
S’exécute lorsque Claude Code envoie des notifications.
Stop
S’exécute lorsque l’agent principal Claude Code a fini de répondre.
SubagentStop
S’exécute lorsqu’un sous-agent Claude Code (appel d’outil Task) a fini de répondre.
Entrée de hook
Les hooks reçoivent des données JSON via stdin contenant des informations de session et des données spécifiques à l’événement :
Entrée PreToolUse
Le schéma exact pour tool_input
dépend de l’outil.
Entrée PostToolUse
Le schéma exact pour tool_input
et tool_response
dépend de l’outil.
Entrée Notification
Entrée Stop et SubagentStop
stop_hook_active
est vrai lorsque Claude Code continue déjà suite à un hook d’arrêt. Vérifiez cette valeur ou traitez le transcript pour empêcher Claude Code de s’exécuter indéfiniment.
Sortie de hook
Il y a deux façons pour les hooks de retourner une sortie vers Claude Code. La sortie communique s’il faut bloquer et tout retour qui devrait être montré à Claude et à l’utilisateur.
Simple : Code de sortie
Les hooks communiquent le statut via les codes de sortie, stdout et stderr :
- Code de sortie 0 : Succès.
stdout
est montré à l’utilisateur en mode transcript (CTRL-R). - Code de sortie 2 : Erreur bloquante.
stderr
est renvoyé à Claude pour traitement automatique. Voir le comportement par événement de hook ci-dessous. - Autres codes de sortie : Erreur non bloquante.
stderr
est montré à l’utilisateur et l’exécution continue.
Rappel : Claude Code ne voit pas stdout si le code de sortie est 0.
Comportement du code de sortie 2
Événement de hook | Comportement |
---|---|
PreToolUse | Bloque l’appel d’outil, montre l’erreur à Claude |
PostToolUse | Montre l’erreur à Claude (l’outil a déjà été exécuté) |
Notification | N/A, montre stderr à l’utilisateur uniquement |
Stop | Bloque l’arrêt, montre l’erreur à Claude |
SubagentStop | Bloque l’arrêt, montre l’erreur au sous-agent Claude |
Avancé : Sortie JSON
Les hooks peuvent retourner du JSON structuré dans stdout
pour un contrôle plus sophistiqué :
Champs JSON communs
Tous les types de hooks peuvent inclure ces champs optionnels :
Si continue
est false, Claude arrête le traitement après l’exécution des hooks.
- Pour
PreToolUse
, c’est différent de"decision": "block"
, qui bloque seulement un appel d’outil spécifique et fournit un retour automatique à Claude. - Pour
PostToolUse
, c’est différent de"decision": "block"
, qui fournit un retour automatisé à Claude. - Pour
Stop
etSubagentStop
, cela prend la priorité sur toute sortie"decision": "block"
. - Dans tous les cas,
"continue" = false
prend la priorité sur toute sortie"decision": "block"
.
stopReason
accompagne continue
avec une raison montrée à l’utilisateur, pas montrée à Claude.
Contrôle de décision PreToolUse
Les hooks PreToolUse
peuvent contrôler si un appel d’outil procède.
- “approve” contourne le système de permissions.
reason
est montré à l’utilisateur mais pas à Claude. - “block” empêche l’appel d’outil de s’exécuter.
reason
est montré à Claude. undefined
mène au flux de permissions existant.reason
est ignoré.
Contrôle de décision PostToolUse
Les hooks PostToolUse
peuvent contrôler si un appel d’outil procède.
- “block” invite automatiquement Claude avec
reason
. undefined
ne fait rien.reason
est ignoré.
Contrôle de décision Stop
/SubagentStop
Les hooks Stop
et SubagentStop
peuvent contrôler si Claude doit continuer.
- “block” empêche Claude de s’arrêter. Vous devez remplir
reason
pour que Claude sache comment procéder. undefined
permet à Claude de s’arrêter.reason
est ignoré.
Exemple de sortie JSON : Édition de commande Bash
Travailler avec les outils MCP
Les hooks de Claude Code fonctionnent parfaitement avec les outils du Protocole de Contexte de Modèle (MCP). Lorsque les serveurs MCP fournissent des outils, ils apparaissent avec un motif de nommage spécial que vous pouvez faire correspondre dans vos hooks.
Nommage des outils MCP
Les outils MCP suivent le motif mcp__<server>__<tool>
, par exemple :
mcp__memory__create_entities
- Outil de création d’entités du serveur Memorymcp__filesystem__read_file
- Outil de lecture de fichier du serveur Filesystemmcp__github__search_repositories
- Outil de recherche du serveur GitHub
Configuration des hooks pour les outils MCP
Vous pouvez cibler des outils MCP spécifiques ou des serveurs MCP entiers :
Exemples
Formatage de code
Formatez automatiquement le code après les modifications de fichiers :
Notification
Personnalisez la notification qui est envoyée lorsque Claude Code demande une permission ou lorsque l’entrée d’invite est devenue inactive.
Considérations de sécurité
Avertissement
UTILISEZ À VOS PROPRES RISQUES : Les hooks de Claude Code exécutent des commandes shell arbitraires sur votre système automatiquement. En utilisant les hooks, vous reconnaissez que :
- Vous êtes seul responsable des commandes que vous configurez
- Les hooks peuvent modifier, supprimer ou accéder à tous les fichiers auxquels votre compte utilisateur peut accéder
- Les hooks malveillants ou mal écrits peuvent causer une perte de données ou des dommages système
- Anthropic ne fournit aucune garantie et n’assume aucune responsabilité pour tous dommages résultant de l’utilisation des hooks
- Vous devriez tester minutieusement les hooks dans un environnement sûr avant l’utilisation en production
Toujours réviser et comprendre toutes les commandes de hook avant de les ajouter à votre configuration.
Meilleures pratiques de sécurité
Voici quelques pratiques clés pour écrire des hooks plus sécurisés :
- Valider et assainir les entrées - Ne jamais faire confiance aveuglément aux données d’entrée
- Toujours citer les variables shell - Utilisez
"$VAR"
pas$VAR
- Bloquer la traversée de chemin - Vérifiez
..
dans les chemins de fichiers - Utilisez des chemins absolus - Spécifiez les chemins complets pour les scripts
- Évitez les fichiers sensibles - Évitez
.env
,.git/
, les clés, etc.
Sécurité de configuration
Les modifications directes aux hooks dans les fichiers de paramètres ne prennent pas effet immédiatement. Claude Code :
- Capture un instantané des hooks au démarrage
- Utilise cet instantané tout au long de la session
- Avertit si les hooks sont modifiés extérieurement
- Nécessite une révision dans le menu
/hooks
pour que les changements s’appliquent
Cela empêche les modifications malveillantes de hooks d’affecter votre session actuelle.
Détails d’exécution des hooks
- Timeout : Limite d’exécution de 60 secondes par défaut, configurable par commande.
- Si une commande individuelle expire, tous les hooks en cours sont annulés.
- Parallélisation : Tous les hooks correspondants s’exécutent en parallèle
- Environnement : S’exécute dans le répertoire courant avec l’environnement de Claude Code
- Entrée : JSON via stdin
- Sortie :
- PreToolUse/PostToolUse/Stop : Progrès montré dans le transcript (Ctrl-R)
- Notification : Journalisé en debug uniquement (
--debug
)
Débogage
Pour dépanner les hooks :
- Vérifiez si le menu
/hooks
affiche votre configuration - Vérifiez que vos fichiers de paramètres sont du JSON valide
- Testez les commandes manuellement
- Vérifiez les codes de sortie
- Révisez les attentes de format stdout et stderr
- Assurez-vous de l’échappement correct des guillemets
- Utilisez
claude --debug
pour déboguer vos hooks. La sortie d’un hook réussi apparaît comme ci-dessous.
Les messages de progrès apparaissent en mode transcript (Ctrl-R) montrant :
- Quel hook s’exécute
- Commande en cours d’exécution
- Statut de succès/échec
- Messages de sortie ou d’erreur