Points d’accroche

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.

• Points d’accroche internes (cette page) : s’exécutent dans le Gateway lorsque des événements d’agent se produisent, comme /new, /reset, /stop ou des événements de cycle de vie.
• Webhooks : points de terminaison HTTP externes qui permettent à d’autres systèmes de déclencher du travail dans OpenClaw. Consultez Webhooks.

​

Démarrage rapide

# List available hooks
openclaw hooks list

# Enable a hook
openclaw hooks enable session-memory

# Check hook status
openclaw hooks check

# Get detailed information
openclaw hooks info session-memory

​

Types d’événements

​

Écriture de points d’accroche

​

Structure d’un point d’accroche

my-hook/
├── HOOK.md          # Metadata + documentation
└── handler.ts       # Handler implementation

​

Format de HOOK.md

---
name: my-hook
description: "Short description of what this hook does"
metadata:
  { "openclaw": { "emoji": "🔗", "events": ["command:new"], "requires": { "bins": ["node"] } } }
---

# My Hook

Detailed documentation goes here.

​

Implémentation du gestionnaire

const handler = async (event) => {
  if (event.type !== "command" || event.action !== "new") {
    return;
  }

  console.log(`[my-hook] New command triggered`);
  // Your logic here

  // Optionally send message to user
  event.messages.push("Hook executed!");
};

export default handler;

​

Points clés du contexte d’événement

​

Découverte des points d’accroche

1. Points d’accroche groupés : livrés avec OpenClaw
2. Points d’accroche de Plugin : points d’accroche groupés dans les plugins installés
3. Points d’accroche gérés : ~/.openclaw/hooks/ (installés par l’utilisateur, partagés entre espaces de travail). Les répertoires supplémentaires de hooks.internal.load.extraDirs partagent cette priorité.
4. Points d’accroche d’espace de travail : <workspace>/hooks/ (propres à l’agent, désactivés par défaut jusqu’à activation explicite)

​

Packs de points d’accroche

openclaw plugins install <path-or-spec>

​

Points d’accroche groupés

openclaw hooks enable <hook-name>

​

Détails de session-memory

​

Configuration de bootstrap-extra-files

{
  "hooks": {
    "internal": {
      "entries": {
        "bootstrap-extra-files": {
          "enabled": true,
          "paths": ["packages/*/AGENTS.md", "packages/*/TOOLS.md"]
        }
      }
    }
  }
}

​

Détails de command-logger

​

Détails de compaction-notifier

​

Détails de boot-md

​

Points d’accroche de Plugin

​

Configuration

{
  "hooks": {
    "internal": {
      "enabled": true,
      "entries": {
        "session-memory": { "enabled": true },
        "command-logger": { "enabled": false }
      }
    }
  }
}

{
  "hooks": {
    "internal": {
      "entries": {
        "my-hook": {
          "enabled": true,
          "env": { "MY_CUSTOM_VAR": "value" }
        }
      }
    }
  }
}

{
  "hooks": {
    "internal": {
      "load": {
        "extraDirs": ["/path/to/more/hooks"]
      }
    }
  }
}

​

Référence CLI

# List all hooks (add --eligible, --verbose, or --json)
openclaw hooks list

# Show detailed info about a hook
openclaw hooks info <hook-name>

# Show eligibility summary
openclaw hooks check

# Enable/disable
openclaw hooks enable <hook-name>
openclaw hooks disable <hook-name>

​

Bonnes pratiques

• Gardez les gestionnaires rapides. Les points d’accroche s’exécutent pendant le traitement des commandes. Lancez les tâches lourdes sans attente avec void processInBackground(event).
• Gérez les erreurs avec élégance. Encapsulez les opérations risquées dans try/catch ; ne levez pas d’exception afin que les autres gestionnaires puissent s’exécuter.
• Filtrez les événements tôt. Retournez immédiatement si le type ou l’action de l’événement n’est pas pertinent.
• Utilisez des clés d’événement spécifiques. Préférez "events": ["command:new"] à "events": ["command"] pour réduire la surcharge.

​

Dépannage

​

Point d’accroche non découvert

# Verify directory structure
ls -la ~/.openclaw/hooks/my-hook/
# Should show: HOOK.md, handler.ts

# List all discovered hooks
openclaw hooks list

​

Point d’accroche non éligible

openclaw hooks info my-hook

​

Point d’accroche non exécuté

1. Vérifiez que le point d’accroche est activé : openclaw hooks list
2. Redémarrez votre processus Gateway afin que les points d’accroche soient rechargés.
3. Consultez les journaux Gateway : ./scripts/clawlog.sh | grep hook

​

Connexe

• Référence CLI : hooks
• Webhooks
• hooks de Plugin — points d’accroche de cycle de vie de Plugin dans le processus
• Configuration