OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

CLI commands

Sessions

openclaw sessions

Répertorier les sessions de conversation stockées.

Les listes de sessions ne constituent pas des contrôles de disponibilité des canaux ou des fournisseurs. Elles affichent les lignes de conversation persistantes provenant des magasins de sessions. Un canal Discord, Slack, Telegram ou autre resté inactif peut se reconnecter correctement sans créer de nouvelle ligne de session tant qu’aucun message n’est traité. Utilisez openclaw channels status --probe, openclaw status --deep ou openclaw health --verbose lorsque vous devez vérifier la connectivité du canal en temps réel.

bash
openclaw sessionsopenclaw sessions --agent workopenclaw sessions --all-agentsopenclaw sessions --active 120openclaw sessions --limit 25openclaw sessions --store ./tmp/sessions.jsonopenclaw sessions --json

Options :

Option Description
--agent <id> Un magasin d’agent configuré (par défaut : l’agent par défaut configuré).
--all-agents Agréger tous les magasins d’agents configurés.
--store <path> Chemin explicite du magasin (incompatible avec --agent ou --all-agents).
--active <minutes> Afficher uniquement les sessions mises à jour au cours des N dernières minutes.
--limit <n|all> Nombre maximal de lignes à afficher (valeur par défaut : 100 ; all rétablit l’affichage complet).
--json Sortie lisible par une machine.
--verbose Journalisation détaillée.

openclaw sessions et le RPC sessions.list du Gateway sont limités par défaut afin que les magasins volumineux et persistants ne puissent pas monopoliser le processus de la CLI ou la boucle d’événements du Gateway. Par défaut, la CLI renvoie les 100 sessions les plus récentes ; transmettez --limit <n> pour définir une fenêtre plus petite ou plus grande, ou --limit all lorsque vous avez délibérément besoin du magasin complet. Les réponses JSON incluent totalCount, limitApplied et hasMore lorsque les appelants doivent indiquer que d’autres lignes existent.

Les clients RPC peuvent transmettre configuredAgentsOnly: true afin de conserver la source de découverte combinée étendue, tout en ne renvoyant que les lignes des agents actuellement présents dans la configuration. Control UI utilise ce mode par défaut afin que les magasins d’agents supprimés ou présents uniquement sur le disque ne réapparaissent pas dans la vue Sessions.

--all-agents lit les magasins d’agents configurés. La découverte de sessions du Gateway et d’ACP est plus étendue : elle inclut également les magasins SQLite résolus à partir des racines d’agents configurées ou d’une racine session.store basée sur un modèle. Les anciens chemins de sélecteur doivent être résolus dans la racine de l’agent ; les liens symboliques et les chemins extérieurs à la racine sont ignorés.

openclaw sessions --all-agents --json :

json
{  "path": null,  "stores": [    { "agentId": "main", "path": "/home/user/.openclaw/agents/main/sessions/sessions.json" },    { "agentId": "work", "path": "/home/user/.openclaw/agents/work/sessions/sessions.json" }  ],  "allAgents": true,  "count": 2,  "totalCount": 2,  "limitApplied": 100,  "hasMore": false,  "activeMinutes": null,  "sessions": [    { "agentId": "main", "key": "agent:main:main", "model": "openai/gpt-5.6-sol" },    { "agentId": "work", "key": "agent:work:main", "model": "anthropic/claude-sonnet-4-6" }  ]}

Suivre la progression de la trajectoire

bash
openclaw sessions tailopenclaw sessions tail --followopenclaw sessions tail --session-key "agent:main:telegram:direct:123" --tail 25openclaw sessions --agent work tail --followopenclaw sessions --all-agents tail --follow

openclaw sessions tail affiche les événements récents de la trajectoire d’exécution sous forme de lignes de progression compactes. Sans --session-key, il suit d’abord les sessions en cours d’exécution, puis la dernière session stockée. --tail <count> détermine le nombre d’événements existants affichés avant le mode de suivi ; la valeur par défaut est 80, tandis que 0 commence à la fin actuelle. --follow continue de surveiller la session sélectionnée adossée à SQLite ou un fichier de trajectoire hérité explicite.

La vue de progression est volontairement prudente : le texte des invites, les arguments des outils et le contenu des résultats d’outils ne sont pas affichés. Les appels d’outils indiquent le nom de l’outil avec {...redacted...} ; les résultats d’outils indiquent un état tel que ok, error ou done ; les lignes d’achèvement du modèle indiquent le fournisseur/modèle et l’état final.

Exporter un lot de trajectoire

bash
openclaw sessions export-trajectory --session-key "agent:main:telegram:direct:123" --workspace .openclaw sessions export-trajectory --session-key "agent:main:telegram:direct:123" --output bug-123 --json

Il s’agit du chemin de commande utilisé par la commande oblique /export-trajectory après que le propriétaire a approuvé la demande d’exécution. Le répertoire de sortie est toujours résolu dans .openclaw/trajectory-exports/, sous l’espace de travail sélectionné.

Maintenance de nettoyage

Exécutez la maintenance maintenant au lieu d’attendre le prochain cycle d’écriture :

bash
openclaw sessions cleanup --dry-runopenclaw sessions cleanup --agent work --dry-runopenclaw sessions cleanup --all-agents --dry-runopenclaw sessions cleanup --enforceopenclaw sessions cleanup --enforce --active-key "agent:main:telegram:direct:123"openclaw sessions cleanup --dry-run --fix-dm-scopeopenclaw sessions cleanup --json

openclaw sessions cleanup utilise les paramètres session.maintenance de la configuration (Référence de configuration) :

  • Remarque sur la portée : openclaw sessions cleanup assure la maintenance des magasins de sessions, des transcriptions, des lignes de trajectoire et des fichiers annexes de trajectoire hérités. Il ne purge pas l’historique des exécutions Cron, qui conserve automatiquement les 2000 lignes les plus récentes par tâche (Configuration de Cron).
  • Le nettoyage purge également les artefacts de transcription hérités ou archivés non référencés, les points de contrôle de Compaction et les fichiers annexes de trajectoire antérieurs à session.maintenance.pruneAfter ; les artefacts encore référencés par des lignes de session SQLite sont conservés.
  • Le nettoyage signale séparément le nettoyage des sondes d’exécution de modèle éphémères du Gateway sous le nom modelRunPruned. Cela ne correspond qu’aux clés explicites strictes ayant une forme telle que agent:*:explicit:model-run-<uuid>. La durée de conservation est fixée à 24h et dépend de la pression : les lignes de sondes obsolètes ne sont supprimées que lorsque la pression liée à la maintenance ou à la limite des entrées de session est atteinte. Lorsqu’il est exécuté, le nettoyage des exécutions de modèle précède le nettoyage global des éléments obsolètes et l’application des limites.

Options :

Option Description
--dry-run Prévisualiser le nombre d’entrées qui seraient purgées ou limitées sans effectuer d’écriture. En mode texte, affiche un tableau des actions par session (Action, Key, Age, Model, Flags), ainsi qu’un récapitulatif regroupé par libellé de session.
--enforce Appliquer la maintenance même lorsque session.maintenance.mode vaut warn.
--fix-missing Supprimer les entrées héritées dont les artefacts de transcription archivés sont absents ou ne contiennent qu’un en-tête/sont vides, même si leur âge ou leur nombre n’entraînerait normalement pas encore leur suppression.
--fix-dm-scope Lorsque session.dmScope vaut main, retirer les lignes de messages privés directs indexées par pair et devenues obsolètes, laissées par un routage per-peer, per-channel-peer ou per-account-channel-peer antérieur. Utilisez d’abord --dry-run ; l’application supprime ces lignes de SQLite et conserve leurs artefacts de transcription hérités sous forme d’archives supprimées.
--active-key <key> Protéger une clé active particulière contre l’éviction liée au budget disque. Les pointeurs durables vers des conversations externes, tels que les sessions de groupe et les sessions de discussion limitées à un fil, sont également conservés par la maintenance fondée sur l’âge, le nombre et le budget disque.
--agent <id> Exécuter le nettoyage pour un magasin d’agent configuré.
--all-agents Exécuter le nettoyage pour tous les magasins d’agents configurés.
--store <path> Exécuter le nettoyage sur le chemin d’un sélecteur de magasin hérité spécifique.
--json Afficher un récapitulatif JSON. Avec --all-agents, la sortie inclut un récapitulatif par magasin.

Lorsqu’un Gateway est joignable, le nettoyage avec écriture des magasins d’agents configurés est envoyé par le Gateway afin d’utiliser le même processus d’écriture dans le magasin de sessions que le trafic d’exécution. Utilisez --store <path> pour réparer explicitement hors ligne un ancien sélecteur de magasin.

openclaw sessions cleanup --all-agents --dry-run --json :

json
{  "allAgents": true,  "mode": "warn",  "dryRun": true,  "stores": [    {      "agentId": "main",      "storePath": "/home/user/.openclaw/agents/main/sessions/sessions.json",      "beforeCount": 120,      "afterCount": 80,      "missing": 0,      "dmScopeRetired": 0,      "pruned": 40,      "capped": 0    },    {      "agentId": "work",      "storePath": "/home/user/.openclaw/agents/work/sessions/sessions.json",      "beforeCount": 18,      "afterCount": 18,      "missing": 0,      "dmScopeRetired": 0,      "pruned": 0,      "capped": 0    }  ]}

Compacter une session

Récupérez du budget de contexte pour une session bloquée ou surdimensionnée. openclaw sessions compact <key> est l’enveloppe de premier ordre autour du RPC sessions.compact du Gateway et nécessite un Gateway en cours d’exécution.

bash
openclaw sessions compact "agent:main:main"openclaw sessions compact "agent:main:main" --max-lines 200openclaw sessions compact "agent:work:main" --agent work --json
  • Sans --max-lines, le Gateway résume la transcription à l’aide d’un LLM. Par défaut, la CLI n’impose aucun délai au client ; le Gateway gère le cycle de vie configuré de la Compaction.
  • Avec --max-lines <n>, la transcription est tronquée aux n dernières lignes et la transcription précédente est archivée dans un fichier annexe .bak.
  • --agent <id> : agent propriétaire de la session ; requis pour les clés global.
  • --url / --token / --password : paramètres de remplacement de la connexion au Gateway.
  • --timeout <ms> : délai d’expiration RPC facultatif côté client, en millisecondes.
  • --json : afficher la charge utile RPC brute.

La commande se termine avec un code différent de zéro lorsque le Gateway signale l’échec d’une Compaction ou est injoignable, afin que les tâches Cron et les scripts ne prennent jamais une absence d’opération silencieuse pour une réussite.

RPC sessions.compact

openclaw gateway call sessions.compact --params '<json>' accepte :

Champ Type Obligatoire Description
key string oui Clé de session à compacter (par exemple agent:main:main).
agentId string non Identifiant de l’agent propriétaire de la session (pour les clés global).
maxLines integer ≥ 1 non Tronquer aux N dernières lignes au lieu d’utiliser la synthèse par LLM.

Exemple de réponse de synthèse par LLM :

json
{  "ok": true,  "key": "agent:main:main",  "compacted": true,  "result": { "tokensBefore": 243868, "tokensAfter": 34941 }}

Exemple de réponse de troncature (--max-lines 200) :

json
{  "ok": true,  "key": "agent:main:main",  "compacted": true,  "archived": "/home/user/.openclaw/agents/main/sessions/transcripts/<id>.jsonl.bak",  "kept": 200}

Ressources connexes

Was this useful?
On this page

On this page