Chatwoot CLIOpen source

Chatwoot CLI met vos agents de codage au travail sur le support.

La CLI officielle permet aux agents de codage de lire les conversations, de rechercher dans votre centre d’aide et de préparer le travail de support depuis le terminal. La compétence d’agent incluse leur fait soumettre à votre approbation tout ce qui est visible par le client.

Voir sur GitHub Lire la documentation CLI

Open source · Chatwoot Cloud et auto-hébergé

support-agent — chatwoot

agent Résumez les conversations urgentes. Lecture seule, ne modifiez rien.

● Chargement de la skill Chatwoot CLI et vérification de la file.

$ chatwoot convs --assignee all -s open -o json

{

"data": { "payload": [

{ "id": 8421, "priority": "urgent",

"status": "open", "inbox_id": 7 },

{ "id": 8398, "priority": "high",

"status": "open", "inbox_id": 3 }

] }

}

File lue

2 conversations demandent votre attention

Modifications effectuées

Aucune

Résumé prêt.

Une interface, du vrai travail de support

Ce que votre agent IA peut faire dans Chatwoot

La CLI renvoie des données structurées sur lesquelles votre agent peut raisonner. Lorsque l’étape suivante consiste à répondre, assigner, étiqueter ou résoudre, la compétence officielle demande à votre agent de vous montrer d’abord la commande exacte.

Briefing de la file

Commencez la journée avec un brief de support utile.

Lecture seule
Demandez à votre agent

Résumez les conversations ouvertes qui me sont assignées. Regroupez-les par urgence et ne modifiez rien dans Chatwoot.

Commande
$ chatwoot convs --assignee me -s open -o json

Sortie structurée → résumé de l’agent

File ouverte : 12 conversations
Urgentes : 2 · Hautes : 3 · Standard : 7

#8421 — remboursement bloqué après un débit en double
#8398 — configuration SSO enterprise en attente depuis 18h

Aucune modification effectuée.

Triage

Trouvez les conversations qui exigent un humain maintenant.

Lecture seule
Demandez à votre agent

Trouvez toutes les conversations urgentes ouvertes dans toutes les boîtes de réception. Renvoyez les ID et le dernier message de chaque client. Lecture seule.

Commande
$ chatwoot convs --assignee all -s open -o json | jq '.data.payload[] | select(.priority == "urgent")'

JSON filtré

{
  "id": 8421,
  "priority": "urgent",
  "status": "open",
  "inbox_id": 7
}

Recherche documentaire

Appuyez une réponse sur du contenu d’aide publié.

Lecture seule
Demandez à votre agent

Recherchez dans notre centre d’aide des articles sur le changement d’e-mail de facturation. Donnez-moi la meilleure correspondance et citez son lien public.

Commande
$ chatwoot hc articles --query "billing email" -o json

Résultat de recherche du centre d’aide

{
  "title": "Mettre à jour vos informations de facturation",
  "slug": "update-billing-details",
  "category": "Paramètres du compte",
  "link": "https://support.example.com/..."
}

Action privilégiée

Rédigez d’abord. N’envoyez qu’après votre approbation.

Approbation requise
Demandez à votre agent

Lisez la conversation 8421 et rédigez une réponse concise. Montrez-moi la commande de réponse exacte, mais ne l’exécutez pas avant mon approbation.

Commande
$ chatwoot conv 8421 reply "J’ai identifié le débit en double et demandé à notre équipe facturation de l’annuler. Je vous tiens informé ici sous un jour ouvré."

Point de contrôle d’approbation

Réponse visible par le client préparée.
Commande non exécutée.

En attente d’une approbation explicite pour la conversation #8421.

Chatwoot pour les agents de codage

Chatwoot CLI : une véritable interface vers la file de support.

Un agent de codage est utile lorsqu’il peut obtenir un contexte fiable et montrer son travail. Chatwoot CLI lui offre les deux. Au lieu de cliquer dans le tableau de bord ou d’extraire des tableaux du terminal, l’agent peut demander les conversations du centre de support, les contacts CRM, les boîtes de réception, les étiquettes, les équipes et les articles du centre d’aide dans un format prévisible.

En plus de la CLI, Chatwoot propose aussi Captain, le copilote IA intégré au produit, et les Agent Bots, qui connectent des bots personnalisés à vos boîtes de réception. La CLI est destinée à l’agent de codage qui travaille déjà avec vous dans un terminal : Codex, Claude, Cursor, Grok ou tout autre outil capable d’exécuter des commandes shell.

01

Triez sans jongler entre les onglets

Demandez la file ouverte, une seule conversation ou tous les messages qui mentionnent un remboursement. L’agent peut résumer ce qu’il trouve, regrouper les problèmes liés et vous indiquer les conversations qui méritent d’être ouvertes dans Chatwoot.

convsconv <id>messagescontactsinboxes
02

Utilisez les réponses publiées

Recherchez dans votre centre d’aide Chatwoot avant de rédiger une réponse. La CLI peut lister les portails, rechercher des articles par requête ou par catégorie, et récupérer l’article complet que votre agent doit utiliser comme contexte.

hcshc articles --queryhc article <slug>
03

Renvoyez des données fiables pour un agent

La sortie texte est destinée aux humains. Les agents peuvent demander du JSON pour l’analyse, du CSV pour un export, ou le mode silencieux quand un pipeline n’a besoin que des ID de ressources. Les codes de sortie et les erreurs se comportent comme un outil en ligne de commande classique.

-o json-o csv-qcode de sortie non nul en cas d'erreur
04

Gérez les cas inhabituels

Les tâches de support courantes disposent de commandes dédiées. Lorsque la CLI ne couvre pas encore un endpoint, la commande API brute peut effectuer une requête authentifiée sur le compte Chatwoot configuré. Les appels non-GET nécessitent toujours une approbation.

chatwoot api /conversations/123-X PATCH--data
L'IA dans Chatwoot

Trois façons de mettre l'IA au travail

Captain

Le copilote IA intégré à Chatwoot. Il répond aux clients directement à partir de votre contenu d'aide.

Agent Bots

Connectez votre propre bot à n'importe quelle boîte de réception via des webhooks et l'API Agent Bots.

Chatwoot CLI

Vous êtes ici

Des agents de codage dans votre terminal. Ils lisent la file et préparent le travail que vous approuvez.

Comment ça marche

Configurez Chatwoot CLI en quatre étapes.

La compétence d’agent officielle enseigne à votre agent de codage la grammaire de la CLI, le contrat de sortie structurée et la règle selon laquelle les écritures sur l’état partagé attendent une confirmation explicite.

  1. 01

    Installez la CLI

    L’installateur détecte votre système d’exploitation et votre architecture, télécharge le binaire correspondant et vérifie sa somme de contrôle SHA256.

    curl -fsSL https://chwt.app/install-cli | sh
  2. 02

    Authentifiez-vous

    Saisissez votre URL de base Chatwoot, votre clé API et votre ID de compte. La CLI les valide avant de les enregistrer ; la clé API est stockée dans le trousseau de votre système d’exploitation.

    chatwoot auth login
  3. 03

    Ajoutez la compétence d’agent

    Installez la compétence officielle incluse pour que votre agent de codage connaisse la grammaire des commandes, les formats de sortie et les règles d’approbation des écritures.

    npx skills add chatwoot/cli
  4. 04

    Demandez, inspectez, approuvez

    Laissez l’agent lire et résumer librement. Pour les réponses, les assignations, les étiquettes, les priorités, les statuts ou les appels API mutatifs, examinez la commande exacte et confirmez-la d’abord.

Conçu pour les agents. Responsable devant les humains.

Les lectures sont libres. Les écritures vous attendent.

Un agent peut inspecter la file et préparer un plan de manière autonome. La compétence officielle lui demande de s’arrêter et de vous consulter avant de modifier des données de support partagées ou d’envoyer un message.

Lecture libre

convsmessagescontactsinboxesagentslabelsteamscentre d’aiderequêtes GET

Confirmation avant écriture

replyassignresolvelabelprioritychangements de statutappels API non GET
Identifiants
Les clés API locales sont stockées dans le trousseau du système d’exploitation. CHATWOOT_API_KEY est disponible pour la CI et les environnements sans interface.
Déploiement
La connexion accepte votre URL de base : la même CLI fonctionne donc avec Chatwoot Cloud ou votre installation auto-hébergée.
Sortie agent
Utilisez le JSON pour une analyse fiable, le CSV pour les exports ou le mode silencieux pour les pipelines qui ne manipulent que des ID. Le texte lisible par un humain reste le format par défaut.
Couverture API
Privilégiez les commandes dédiées. Lorsqu’une commande n’existe pas encore, la commande brute chatwoot api offre une issue de secours authentifiée sur le compte configuré.

Démarrage rapide

Installez Chatwoot CLI en quelques minutes.

Installez la version publiée, connectez-vous à votre compte Chatwoot, puis ajoutez la compétence officielle pour que votre agent connaisse les commandes et les règles de sécurité.

quick-start

1 — Installer

$ curl -fsSL https://chwt.app/install-cli | sh

2 — Connecter

$ chatwoot auth login

3 — Former votre agent

$ npx skills add chatwoot/cli

✓ Identifiants validés

✓ Clé API enregistrée dans le trousseau du système

✓ Compétence d’agent prête

Nouveau sur Chatwoot ?

Gérez le support client avec les agents de codage que vous utilisez déjà.

Chatwoot est la plateforme open source de support client derrière la CLI : boîte de réception omnicanale, centre d’aide et IA Captain. Si votre équipe travaille déjà dans un agent de codage, celui-ci peut trier les conversations, consulter les réponses publiées et rédiger des réponses soumises à votre approbation dès le premier jour, sur Chatwoot Cloud ou en auto-hébergé.

  • Claude Code
  • Codex
  • Cursor
  • GitHub Copilot
  • Gemini CLI
  • Grok
  • Windsurf

…et tout autre agent capable d’exécuter des commandes shell.

Vos questions, nos réponses

Chatwoot CLI et les agents IA

Les détails pratiques avant de donner à un agent l’accès à un vrai compte de support.

Qu’est-ce que Chatwoot CLI ?

Chatwoot CLI est l’interface en ligne de commande officielle et open source de Chatwoot. Elle permet aux personnes, aux scripts et aux agents de codage de lire les données de support et d’exécuter les workflows de conversation courants depuis un terminal.

En quoi la CLI diffère-t-elle de Captain et des Agent Bots ?

Ils couvrent trois surfaces différentes. Captain est le copilote IA de Chatwoot intégré au produit, qui répond aux clients à partir de votre contenu d’aide. Les Agent Bots connectent un bot personnalisé à vos boîtes de réception via l’API Agent Bots. Chatwoot CLI s’adresse aux agents de codage dans votre terminal, qui lisent les données de support et préparent le travail que vous approuvez.

Quels agents de codage IA peuvent l’utiliser ?

Tout agent capable d’exécuter des commandes shell peut utiliser la CLI. Cela inclut Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Grok et Windsurf. La compétence Chatwoot incluse est conçue pour les environnements d’agent qui prennent en charge les compétences installables ou les instructions de projet.

Fonctionne-t-elle avec Chatwoot auto-hébergé ?

Oui. Lors de la connexion, vous fournissez l’URL de base Chatwoot, la clé API et l’ID de compte. La même CLI peut ainsi se connecter à Chatwoot Cloud ou à une installation Chatwoot auto-hébergée.

Un agent peut-il envoyer des réponses ou résoudre des conversations ?

La CLI prend en charge les réponses, les notes privées, les assignations, les étiquettes, les priorités et les changements de statut. La compétence d’agent officielle les traite comme des écritures privilégiées : l’agent doit montrer la commande exacte et attendre une approbation explicite avant de l’exécuter.

Où la CLI stocke-t-elle ma clé API ?

La connexion interactive stocke la clé API dans le trousseau de votre système d’exploitation. Les paramètres non sensibles se trouvent dans le fichier de configuration de Chatwoot CLI. La CI et les environnements sans interface peuvent fournir CHATWOOT_API_KEY à la place.

Puis-je utiliser Chatwoot CLI dans des scripts ?

Oui. Utilisez la sortie JSON quand le code a besoin de la réponse complète, le CSV pour les exports tabulaires, ou le mode silencieux pour obtenir un ID par ligne. La commande API brute est disponible lorsqu’un workflow ne dispose pas encore d’une commande CLI dédiée.

L’interface officielle pour les agents de codage

Mettez la file là où votre agent travaille.

Obtenir Chatwoot CLI Démarrez votre essai gratuit

ou demandez une démo