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.
Heartbeat ou cron ? Consultez Automatisation pour savoir quand utiliser chacun.
Démarrage rapide (débutant)
Choisissez une cadence
Laissez les heartbeats activés (la valeur par défaut est
30m, ou 1h pour l’authentification OAuth/par jeton Anthropic, y compris la réutilisation de Claude CLI) ou définissez votre propre cadence.Ajoutez HEARTBEAT.md (facultatif)
Créez une petite checklist
HEARTBEAT.md ou un bloc tasks: dans l’espace de travail de l’agent.Décidez où les messages Heartbeat doivent aller
target: "none" est la valeur par défaut ; définissez target: "last" pour router vers le dernier contact.Réglages facultatifs
- Activez l’envoi du raisonnement Heartbeat pour plus de transparence.
- Utilisez un contexte d’amorçage léger si les exécutions Heartbeat n’ont besoin que de
HEARTBEAT.md. - Activez les sessions isolées pour éviter d’envoyer tout l’historique de conversation à chaque Heartbeat.
- Limitez les heartbeats aux heures actives (heure locale).
Valeurs par défaut
- Intervalle :
30m(ou1hlorsque l’authentification OAuth/par jeton Anthropic est le mode d’authentification détecté, y compris la réutilisation de Claude CLI). Définissezagents.defaults.heartbeat.everyouagents.list[].heartbeat.everypar agent ; utilisez0mpour désactiver. - Corps de l’invite (configurable via
agents.defaults.heartbeat.prompt) :Read HEARTBEAT.md if it exists (workspace context). Follow it strictly. Do not infer or repeat old tasks from prior chats. If nothing needs attention, reply HEARTBEAT_OK. - L’invite Heartbeat est envoyée verbatim comme message utilisateur. L’invite système inclut une section « Heartbeat » uniquement lorsque les heartbeats sont activés pour l’agent par défaut, et l’exécution est marquée en interne.
- Lorsque les heartbeats sont désactivés avec
0m, les exécutions normales omettent aussiHEARTBEAT.mddu contexte d’amorçage afin que le modèle ne voie pas les instructions propres à Heartbeat. - Les heures actives (
heartbeat.activeHours) sont vérifiées dans le fuseau horaire configuré. En dehors de cette fenêtre, les heartbeats sont ignorés jusqu’au prochain tick dans la fenêtre. - Les heartbeats se reportent automatiquement lorsque du travail Cron est actif ou en file d’attente. Définissez
heartbeat.skipWhenBusy: truepour reporter aussi un agent sur ses propres voies de sous-agent ou de commande imbriquée indexées par clé de session ; les agents voisins ne se mettent plus en pause simplement parce qu’un autre agent a du travail de sous-agent en cours.
À quoi sert l’invite Heartbeat
L’invite par défaut est volontairement large :- Tâches en arrière-plan : « Consider outstanding tasks » encourage l’agent à examiner les suivis (boîte de réception, calendrier, rappels, travail en file d’attente) et à signaler tout élément urgent.
- Prise de nouvelles auprès de l’humain : « Checkup sometimes on your human during day time » encourage un léger message occasionnel du type « besoin de quelque chose ? », tout en évitant le spam nocturne grâce à votre fuseau horaire local configuré (voir Fuseau horaire).
agents.defaults.heartbeat.prompt (ou agents.list[].heartbeat.prompt) avec un corps personnalisé (envoyé verbatim).
Contrat de réponse
- Si rien ne nécessite de l’attention, répondez avec
HEARTBEAT_OK. - Les exécutions Heartbeat capables d’utiliser des outils peuvent à la place appeler
heartbeat_respondavecnotify: falsepour ne produire aucune mise à jour visible, ounotify: trueavecnotificationTextpour une alerte. Lorsqu’elle est présente, la réponse structurée de l’outil prévaut sur le texte de secours. - Pendant les exécutions Heartbeat, OpenClaw traite
HEARTBEAT_OKcomme un accusé de réception lorsqu’il apparaît au début ou à la fin de la réponse. Le jeton est supprimé et la réponse est abandonnée si le contenu restant est ≤ackMaxChars(par défaut : 300). - Si
HEARTBEAT_OKapparaît au milieu d’une réponse, il n’est pas traité spécialement. - Pour les alertes, n’incluez pas
HEARTBEAT_OK; retournez uniquement le texte de l’alerte.
HEARTBEAT_OK isolé au début/à la fin d’un message est supprimé et journalisé ; un message qui est uniquement HEARTBEAT_OK est abandonné.
Configuration
Portée et précédence
agents.defaults.heartbeatdéfinit le comportement Heartbeat global.agents.list[].heartbeatfusionne par-dessus ; si un agent possède un blocheartbeat, seuls ces agents exécutent des Heartbeats.channels.defaults.heartbeatdéfinit les valeurs par défaut de visibilité pour tous les canaux.channels.<channel>.heartbeatremplace les valeurs par défaut du canal.channels.<channel>.accounts.<id>.heartbeat(canaux multi-comptes) remplace les paramètres par canal.
Heartbeats par agent
Si une entréeagents.list[] inclut un bloc heartbeat, seuls ces agents exécutent des Heartbeats. Le bloc par agent fusionne par-dessus agents.defaults.heartbeat (vous pouvez donc définir des valeurs par défaut partagées une seule fois et les remplacer par agent).
Exemple : deux agents, seul le second agent exécute des Heartbeats.
Exemple d’heures actives
Limitez les Heartbeats aux heures ouvrées dans un fuseau horaire spécifique :Configuration 24 h/24, 7 j/7
Si vous voulez que les Heartbeats s’exécutent toute la journée, utilisez l’un de ces modèles :- Omettez entièrement
activeHours(aucune restriction de fenêtre horaire ; c’est le comportement par défaut). - Définissez une fenêtre couvrant toute la journée :
activeHours: { start: "00:00", end: "24:00" }.
Exemple multi-compte
UtilisezaccountId pour cibler un compte spécifique sur les canaux multi-comptes comme Telegram :
Notes sur les champs
Intervalle du Heartbeat (chaîne de durée ; unité par défaut = minutes).
Remplacement facultatif du modèle pour les exécutions de Heartbeat (
provider/model).Lorsque cette option est activée, transmet également le message séparé
Reasoning: lorsqu’il est disponible (même forme que /reasoning on).Lorsque la valeur est true, les exécutions de Heartbeat utilisent un contexte d’amorçage léger et ne conservent que
HEARTBEAT.md parmi les fichiers d’amorçage de l’espace de travail.Lorsque la valeur est true, chaque Heartbeat s’exécute dans une nouvelle session sans historique de conversation antérieur. Utilise le même modèle d’isolation que Cron
sessionTarget: "isolated". Réduit fortement le coût en jetons par Heartbeat. Combinez avec lightContext: true pour des économies maximales. Le routage de la livraison utilise toujours le contexte de la session principale.Lorsque la valeur est true, les exécutions de Heartbeat sont différées sur les voies très occupées supplémentaires de cet agent : son propre sous-agent indexé par clé de session ou le travail de commande imbriqué. Les voies Cron différent toujours les Heartbeats, même sans cet indicateur, afin que les hôtes de modèles locaux n’exécutent pas les invites Cron et Heartbeat en même temps.
Clé de session facultative pour les exécutions de Heartbeat.
main(par défaut) : session principale de l’agent.- Clé de session explicite (copiez-la depuis
openclaw sessions --jsonou la CLI des sessions). - Formats de clé de session : consultez Sessions et Groupes.
last: livrer au dernier canal externe utilisé.- canal explicite : tout canal configuré ou id de plugin, par exemple
discord,matrix,telegramouwhatsapp. none(par défaut) : exécuter le Heartbeat mais ne pas le livrer en externe.
Contrôle le comportement de livraison directe/DM.
allow : autoriser la livraison directe/DM du Heartbeat. block : supprimer la livraison directe/DM (reason=dm-blocked).Remplacement facultatif du destinataire (id propre au canal, par exemple E.164 pour WhatsApp ou un id de discussion Telegram). Pour les sujets/fils Telegram, utilisez
<chatId>:topic:<messageThreadId>.Id de compte facultatif pour les canaux multi-comptes. Lorsque
target: "last", l’id de compte s’applique au dernier canal résolu s’il prend en charge les comptes ; sinon, il est ignoré. Si l’id de compte ne correspond à aucun compte configuré pour le canal résolu, la livraison est ignorée.Remplace le corps de prompt par défaut (non fusionné).
Nombre maximal de caractères autorisés après
HEARTBEAT_OK avant la livraison.Quand cette option vaut true, supprime les charges utiles d’avertissement d’erreur d’outil pendant les exécutions Heartbeat.
Restreint les exécutions Heartbeat à une fenêtre horaire. Objet avec
start (HH:MM, inclusif ; utilisez 00:00 pour le début de journée), end (HH:MM exclusif ; 24:00 autorisé pour la fin de journée), et timezone facultatif.- Omis ou
"user": utilise votreagents.defaults.userTimezonesi défini, sinon revient au fuseau horaire du système hôte. "local": utilise toujours le fuseau horaire du système hôte.- Tout identifiant IANA (par exemple
America/New_York) : utilisé directement ; s’il est invalide, revient au comportement"user"ci-dessus. startetendne doivent pas être égaux pour une fenêtre active ; les valeurs égales sont traitées comme une largeur nulle (toujours hors de la fenêtre).- En dehors de la fenêtre active, les Heartbeats sont ignorés jusqu’au prochain tick dans la fenêtre.
Comportement de livraison
Routage de session et de cible
Routage de session et de cible
- Les Heartbeats s’exécutent par défaut dans la session principale de l’agent (
agent:<id>:<mainKey>), ouglobalquandsession.scope = "global". Définissezsessionpour remplacer par une session de canal précise (Discord/WhatsApp/etc.). sessionaffecte uniquement le contexte d’exécution ; la livraison est contrôlée partargetetto.- Pour livrer à un canal/destinataire précis, définissez
target+to. Avectarget: "last", la livraison utilise le dernier canal externe pour cette session. - Les livraisons Heartbeat autorisent par défaut les cibles directes/DM. Définissez
directPolicy: "block"pour supprimer les envois vers des cibles directes tout en exécutant quand même le tour Heartbeat. - Si la file principale, la voie de session cible, la voie Cron ou une tâche Cron active est occupée, le Heartbeat est ignoré et réessayé plus tard.
- Si
skipWhenBusy: true, le sous-agent indexé par clé de session de cet agent et les voies imbriquées reportent aussi les exécutions Heartbeat. Les voies occupées des autres agents ne reportent pas cet agent. - Si
targetne se résout vers aucune destination externe, l’exécution a quand même lieu, mais aucun message sortant n’est envoyé.
Visibilité et comportement d’ignorance
Visibilité et comportement d’ignorance
- Si
showOk,showAlertsetuseIndicatorsont tous désactivés, l’exécution est ignorée dès le départ avecreason=alerts-disabled. - Si seule la livraison des alertes est désactivée, OpenClaw peut quand même exécuter le Heartbeat, mettre à jour les horodatages des tâches dues, restaurer l’horodatage d’inactivité de la session et supprimer la charge utile d’alerte sortante.
- Si la cible Heartbeat résolue prend en charge la saisie, OpenClaw affiche la saisie pendant que l’exécution Heartbeat est active. Cela utilise la même cible à laquelle le Heartbeat enverrait la sortie de chat, et c’est désactivé par
typingMode: "never".
Cycle de vie de session et audit
Cycle de vie de session et audit
- Les réponses Heartbeat uniquement ne gardent pas la session active. Les métadonnées Heartbeat peuvent mettre à jour la ligne de session, mais l’expiration par inactivité utilise
lastInteractionAtdepuis le dernier vrai message utilisateur/canal, et l’expiration quotidienne utilisesessionStartedAt. - L’interface de contrôle et l’historique WebChat masquent les prompts Heartbeat et les accusés de réception OK uniquement. La transcription de session sous-jacente peut encore contenir ces tours pour l’audit/la relecture.
- Les tâches en arrière-plan détachées peuvent mettre en file un événement système et réveiller Heartbeat lorsque la session principale doit remarquer rapidement quelque chose. Ce réveil ne transforme pas l’exécution Heartbeat en tâche en arrière-plan.
Contrôles de visibilité
Par défaut, les accusés de réceptionHEARTBEAT_OK sont supprimés tandis que le contenu d’alerte est livré. Vous pouvez ajuster cela par canal ou par compte :
Effet de chaque indicateur
showOk: envoie un accusé de réceptionHEARTBEAT_OKlorsque le modèle renvoie une réponse OK uniquement.showAlerts: envoie le contenu d’alerte lorsque le modèle renvoie une réponse non OK.useIndicator: émet des événements d’indicateur pour les surfaces d’état de l’interface.
Exemples par canal ou par compte
Motifs courants
| Objectif | Configuration |
|---|---|
| Comportement par défaut (OK silencieux, alertes activées) | (aucune configuration nécessaire) |
| Totalement silencieux (aucun message, aucun indicateur) | channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: false } |
| Indicateur uniquement (aucun message) | channels.defaults.heartbeat: { showOk: false, showAlerts: false, useIndicator: true } |
| OK dans un seul canal | channels.telegram.heartbeat: { showOk: true } |
HEARTBEAT.md (facultatif)
Si un fichierHEARTBEAT.md existe dans l’espace de travail, le prompt par défaut demande à l’agent de le lire. Considérez-le comme votre « liste de contrôle Heartbeat » : petite, stable et sûre à inclure toutes les 30 minutes.
Lors des exécutions normales, HEARTBEAT.md est injecté uniquement lorsque les instructions Heartbeat sont activées pour l’agent par défaut. Désactiver la cadence Heartbeat avec 0m ou définir includeSystemPromptSection: false l’omet du contexte d’amorçage normal.
Si HEARTBEAT.md existe mais est effectivement vide (seulement des lignes vides et des en-têtes Markdown comme # Heading), OpenClaw ignore l’exécution Heartbeat pour économiser des appels API. Cette ignorance est signalée avec reason=empty-heartbeat-file. Si le fichier est absent, le Heartbeat s’exécute quand même et le modèle décide quoi faire.
Gardez-le minuscule (courte liste de contrôle ou rappels) pour éviter de gonfler le prompt.
Exemple de HEARTBEAT.md :
Blocs tasks:
HEARTBEAT.md prend aussi en charge un petit bloc structuré tasks: pour les vérifications basées sur des intervalles dans Heartbeat lui-même.
Exemple :
Comportement
Comportement
- OpenClaw analyse le bloc
tasks:et vérifie chaque tâche selon son propreinterval. - Seules les tâches dues sont incluses dans le prompt Heartbeat pour ce tick.
- Si aucune tâche n’est due, le Heartbeat est entièrement ignoré (
reason=no-tasks-due) afin d’éviter un appel au modèle inutile. - Le contenu hors tâche dans
HEARTBEAT.mdest préservé et ajouté comme contexte supplémentaire après la liste des tâches dues. - Les horodatages de dernière exécution des tâches sont stockés dans l’état de session (
heartbeatTaskState), de sorte que les intervalles survivent aux redémarrages normaux. - Les horodatages des tâches ne sont avancés qu’après qu’une exécution Heartbeat a terminé son chemin de réponse normal. Les exécutions ignorées
empty-heartbeat-file/no-tasks-duene marquent pas les tâches comme terminées.
L’agent peut-il mettre à jour HEARTBEAT.md ?
Oui — si vous le lui demandez.HEARTBEAT.md est simplement un fichier normal dans l’espace de travail de l’agent, vous pouvez donc dire à l’agent (dans un chat normal) quelque chose comme :
- « Mets à jour
HEARTBEAT.mdpour ajouter une vérification quotidienne du calendrier. » - « Réécris
HEARTBEAT.mdpour qu’il soit plus court et centré sur les suivis de boîte de réception. »
Réveil manuel (à la demande)
Vous pouvez mettre en file un événement système et déclencher immédiatement un Heartbeat avec :heartbeat configuré, un réveil manuel exécute immédiatement chacun de ces Heartbeats d’agent.
Utilisez --mode next-heartbeat pour attendre le prochain tick planifié.
Livraison du raisonnement (facultatif)
Par défaut, les Heartbeats livrent uniquement la charge utile finale de « réponse ». Si vous voulez de la transparence, activez :agents.defaults.heartbeat.includeReasoning: true
Reasoning: (même forme que /reasoning on). Cela peut être utile lorsque l’agent gère plusieurs sessions/codex et que vous voulez voir pourquoi il a décidé de vous envoyer un ping — mais cela peut aussi révéler plus de détails internes que vous ne le souhaitez. Préférez le laisser désactivé dans les chats de groupe.
Sensibilité aux coûts
Les Heartbeats exécutent des tours d’agent complets. Des intervalles plus courts consomment plus de tokens. Pour réduire le coût :- Utilisez
isolatedSession: truepour éviter d’envoyer l’historique complet de conversation (~100K tokens réduit à ~2-5K par exécution). - Utilisez
lightContext: truepour limiter les fichiers d’amorçage au seulHEARTBEAT.md. - Définissez un
modelmoins cher (par exempleollama/llama3.2:1b). - Gardez
HEARTBEAT.mdpetit. - Utilisez
target: "none"si vous voulez seulement des mises à jour d’état internes.
Débordement de contexte après Heartbeat
Si un Heartbeat a précédemment laissé une session existante sur un modèle local plus petit, par exemple un modèle Ollama avec une fenêtre de 32k, et que le tour suivant de session principale signale un débordement de contexte, réinitialisez le modèle d’exécution de session vers le modèle principal configuré. Le message de réinitialisation d’OpenClaw le signale lorsque le dernier modèle d’exécution correspond auheartbeat.model configuré.
Les Heartbeats actuels préservent le modèle d’exécution existant de la session partagée après la fin de l’exécution. Vous pouvez toujours utiliser isolatedSession: true pour exécuter les Heartbeats dans une session fraîche, le combiner avec lightContext: true pour obtenir le plus petit prompt, ou choisir un modèle Heartbeat avec une fenêtre de contexte suffisamment grande pour la session partagée.
Associé
- Automatisation — tous les mécanismes d’automatisation en un coup d’œil
- Tâches en arrière-plan — comment le travail détaché est suivi
- Fuseau horaire — comment le fuseau horaire affecte la planification Heartbeat
- Dépannage — débogage des problèmes d’automatisation