Chatwoot CLIOpen Source

Chatwoot CLI lässt deine Coding-Agents im Support mitarbeiten.

Das offizielle CLI lässt Coding-Agents Gespräche lesen, dein Help Center durchsuchen und Support-Arbeit direkt im Terminal vorbereiten. Der mitgelieferte Agent-Skill sorgt dafür, dass alles Kundensichtbare auf deine Freigabe wartet.

Open Source · Chatwoot Cloud und Self-Hosted

support-agent — chatwoot

agent Fasse dringende Konversationen zusammen. Nur lesen, nichts verändern.

● Chatwoot-CLI-Skill wird geladen, Queue wird geprüft.

$ 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 }

] }

}

Queue gelesen

2 Konversationen brauchen Aufmerksamkeit

Änderungen

Keine

Zusammenfassung ist bereit.

Ein Interface, echte Support-Arbeit

Was dein KI-Agent in Chatwoot kann

Das CLI liefert strukturierte Daten, mit denen dein Agent arbeiten kann. Sobald der nächste Schritt antworten, zuweisen, labeln oder lösen würde, zeigt dir dein Agent dank des offiziellen Skills zuerst den genauen Befehl.

Queue-Briefing

Starte den Tag mit einem brauchbaren Support-Briefing.

Nur Lesen
Prompte deinen Agent

Fasse die offenen Gespräche zusammen, die mir zugewiesen sind. Gruppiere sie nach Dringlichkeit und ändere nichts in Chatwoot.

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

Strukturierte Ausgabe → Agent-Zusammenfassung

Offene Queue: 12 Konversationen
Dringend: 2 · Hoch: 3 · Standard: 7

#8421 — Rückerstattung nach doppelter Abbuchung blockiert
#8398 — Enterprise-SSO-Einrichtung wartet seit 18h

Keine Änderungen vorgenommen.

Triage

Finde die Gespräche, die jetzt einen Menschen brauchen.

Nur Lesen
Prompte deinen Agent

Finde alle offenen dringenden Gespräche über alle Posteingänge hinweg. Gib die IDs und die letzten Kundennachrichten zurück. Nur lesen.

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

Gefiltertes JSON

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

Wissensabfrage

Stütze eine Antwort auf veröffentlichte Hilfe-Inhalte.

Nur Lesen
Prompte deinen Agent

Durchsuche unser Help Center nach Artikeln zum Ändern der Rechnungs-E-Mail. Gib mir den besten Treffer und zitiere den öffentlichen Link.

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

Help-Center-Suchergebnis

{
  "title": "Rechnungsdaten aktualisieren",
  "slug": "update-billing-details",
  "category": "Kontoeinstellungen",
  "link": "https://support.example.com/..."
}

Privilegierte Aktion

Erst entwerfen. Gesendet wird erst nach deiner Freigabe.

Freigabe erforderlich
Prompte deinen Agent

Lies Gespräch 8421 und entwirf eine knappe Antwort. Zeig mir den genauen Antwort-Befehl, aber führe ihn erst aus, wenn ich zustimme.

Befehl
$ chatwoot conv 8421 reply "Ich habe die doppelte Abbuchung gefunden und unser Billing-Team um die Rückbuchung gebeten. Ich melde mich hier innerhalb eines Werktags."

Freigabe-Checkpoint

Kundensichtbare Antwort vorbereitet.
Befehl nicht ausgeführt.

Warte auf explizite Freigabe für Konversation #8421.

Chatwoot für Coding-Agents

Das Chatwoot CLI: eine richtige Schnittstelle zur Support-Queue.

Ein Coding-Agent ist dann nützlich, wenn er verlässlichen Kontext bekommt und seine Arbeit zeigen kann. Das Chatwoot CLI gibt ihm beides. Statt sich durch das Dashboard zu klicken oder Terminal-Tabellen zu scrapen, kann der Agent Gespräche aus dem Support Desk, CRM-Kontakte, Posteingänge, Labels, Teams und Help-Center-Artikel in einem vorhersehbaren Format abrufen.

Neben dem CLI bietet Chatwoot auch Captain, den KI-Copiloten im Produkt, und Agent Bots, mit denen du eigene Bots an deine Posteingänge anbindest. Das CLI ist für den Coding-Agent, der schon mit dir im Terminal arbeitet: Codex, Claude, Cursor, Grok oder ein anderes Tool, das Shell-Befehle ausführen kann.

01

Triage ohne Tab-Hopping

Frag nach der offenen Queue, einem einzelnen Gespräch oder jeder Nachricht, in der eine Rückerstattung erwähnt wird. Der Agent kann zusammenfassen, was er findet, verwandte Fälle gruppieren und dich auf die Gespräche hinweisen, die du in Chatwoot öffnen solltest.

convsconv <id>messagescontactsinboxes
02

Nutze veröffentlichte Antworten

Durchsuche dein Chatwoot Help Center, bevor du eine Antwort entwirfst. Das CLI kann Portale auflisten, Artikel nach Suchbegriff oder Kategorie durchsuchen und den vollständigen Artikel abrufen, den dein Agent als Kontext nutzen soll.

hcshc articles --queryhc article <slug>
03

Daten, denen ein Agent vertrauen kann

Textausgabe ist für Menschen gedacht. Agents können JSON zum Parsen anfordern, CSV für einen Export oder den Quiet-Modus, wenn eine Pipeline nur Ressourcen-IDs braucht. Exit-Codes und Fehler verhalten sich wie bei einem normalen Kommandozeilen-Tool.

-o json-o csv-qExit-Code ungleich null bei Fehlern
04

Auch für die ungewöhnlichen Fälle

Die häufigen Support-Aufgaben haben eigene Befehle. Wenn das CLI einen Endpunkt noch nicht abdeckt, kann der rohe API-Befehl eine authentifizierte Anfrage an den konfigurierten Chatwoot-Account stellen. Nicht-GET-Aufrufe brauchen weiterhin eine Freigabe.

chatwoot api /conversations/123-X PATCH--data
KI in Chatwoot

Drei Wege, KI für dich arbeiten zu lassen

So funktioniert’s

Richte das Chatwoot CLI in vier Schritten ein.

Der offizielle Agent-Skill bringt deinem Coding-Agent die CLI-Grammatik, den Vertrag für strukturierte Ausgaben und die Regel bei, dass Schreibzugriffe auf geteilte Daten auf deine ausdrückliche Bestätigung warten.

  1. 01

    CLI installieren

    Der Installer erkennt dein Betriebssystem und deine Architektur, lädt das passende Release-Binary herunter und prüft dessen SHA256-Checksumme.

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

    Anmelden

    Gib deine Chatwoot-Basis-URL, deinen API-Schlüssel und deine Account-ID ein. Das CLI validiert sie vor dem Speichern; der API-Schlüssel landet im Schlüsselbund deines Betriebssystems.

    chatwoot auth login
  3. 03

    Agent-Skill hinzufügen

    Installiere den offiziellen mitgelieferten Skill, damit dein Coding-Agent die Befehlsgrammatik, Ausgabeformate und Freigabe-Regeln für Schreibzugriffe kennt.

    npx skills add chatwoot/cli
  4. 04

    Fragen, prüfen, freigeben

    Lass den Agent frei lesen und zusammenfassen. Bei Antworten, Zuweisungen, Labels, Prioritäten, Statusänderungen oder verändernden API-Aufrufen prüfst du zuerst den genauen Befehl und bestätigst ihn.

Für Agents gebaut. Menschen behalten die Kontrolle.

Lesen ist einfach. Schreiben wartet auf dich.

Ein Agent kann die Queue selbstständig prüfen und einen Plan vorbereiten. Der offizielle Skill weist ihn an, anzuhalten und dich zu fragen, bevor er geteilte Support-Daten ändert oder eine Nachricht sendet.

Frei lesen

convsmessagescontactsinboxesagentslabelsteamsHelp CenterGET-Anfragen

Vor Schreibzugriffen bestätigen

replyassignresolvelabelpriorityStatusänderungenNicht-GET-API-Aufrufe
Zugangsdaten
Lokale API-Schlüssel liegen im Schlüsselbund des Betriebssystems. CHATWOOT_API_KEY steht für CI und Headless-Umgebungen zur Verfügung.
Deployment
Beim Login gibst du deine Basis-URL an, daher funktioniert dasselbe CLI mit Chatwoot Cloud oder deiner Self-Hosted-Installation.
Agent-Ausgabe
Nutze JSON für verlässliches Parsen, CSV für Exporte oder den Quiet-Modus für reine ID-Pipelines. Menschenlesbarer Text bleibt der Standard.
API-Abdeckung
Bevorzuge die eingebauten Befehle. Wenn es keinen gibt, bietet der rohe chatwoot api-Befehl einen authentifizierten Ausweg innerhalb des konfigurierten Accounts.

Schnellstart

Installiere das Chatwoot CLI in wenigen Minuten.

Installiere das Release, melde dich bei deinem Chatwoot-Account an und füge dann den offiziellen Skill hinzu, damit dein Agent die Befehle und Sicherheitsregeln kennt.

quick-start

1 — Installieren

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

2 — Verbinden

$ chatwoot auth login

3 — Bring es deinem Agent bei

$ npx skills add chatwoot/cli

✓ Zugangsdaten validiert

✓ API-Schlüssel im OS-Schlüsselbund gespeichert

✓ Agent-Skill bereit

Neu bei Chatwoot?

Erledige Kundensupport mit den Coding-Agents, die du schon nutzt.

Chatwoot ist die Open-Source-Kundensupport-Plattform hinter dem CLI: Omnichannel-Posteingang, Help Center und Captain AI. Wenn dein Team schon in einem Coding-Agent arbeitet, kann dieser vom ersten Tag an Gespräche triagieren, veröffentlichte Antworten nachschlagen und Antwortentwürfe für deine Freigabe vorbereiten, auf Chatwoot Cloud oder Self-Hosted.

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

…und jeder andere Agent, der Shell-Befehle ausführen kann.

Fragen, beantwortet

Chatwoot CLI und KI-Agents

Die praktischen Details, bevor du einem Agent Zugriff auf einen echten Support-Account gibst.

Was ist das Chatwoot CLI?

Das Chatwoot CLI ist das offizielle Open-Source-Kommandozeilen-Interface für Chatwoot. Es lässt Menschen, Skripte und Coding-Agents Support-Daten lesen und gängige Gesprächs-Workflows aus dem Terminal ausführen.

Wie unterscheidet sich das CLI von Captain und Agent Bots?

Die drei decken unterschiedliche Bereiche ab. Captain ist Chatwoots KI-Copilot im Produkt und beantwortet Kundenanfragen aus deinen Hilfe-Inhalten. Agent Bots verbinden einen eigenen Bot über die Agent Bot API mit deinen Posteingängen. Das Chatwoot CLI ist für Coding-Agents in deinem Terminal, die Support-Daten lesen und Arbeit vorbereiten, die du freigibst.

Welche KI-Coding-Agents können es nutzen?

Jeder Agent, der Shell-Befehle ausführen kann, kann das CLI nutzen. Dazu gehören Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Grok und Windsurf. Der mitgelieferte Chatwoot-Skill ist für Agent-Umgebungen gedacht, die installierbare Skills oder Projekt-Anweisungen unterstützen.

Funktioniert es mit selbst gehostetem Chatwoot?

Ja. Beim Login gibst du die Chatwoot-Basis-URL, den API-Schlüssel und die Account-ID an. So verbindet sich dasselbe CLI mit Chatwoot Cloud oder einer selbst gehosteten Chatwoot-Installation.

Kann ein Agent Antworten senden oder Gespräche lösen?

Das CLI unterstützt Antworten, private Notizen, Zuweisungen, Labels, Prioritäten und Statusänderungen. Der offizielle Agent-Skill behandelt sie als privilegierte Schreibzugriffe: Der Agent soll den genauen Befehl zeigen und auf deine ausdrückliche Freigabe warten, bevor er ihn ausführt.

Wo speichert das CLI meinen API-Schlüssel?

Beim interaktiven Login landet der API-Schlüssel im Schlüsselbund deines Betriebssystems. Nicht geheime Einstellungen liegen in der Konfigurationsdatei des Chatwoot CLI. CI- und Headless-Umgebungen können stattdessen CHATWOOT_API_KEY setzen.

Kann ich das Chatwoot CLI in Skripten nutzen?

Ja. Nutze JSON-Ausgabe, wenn Code die vollständige Antwort braucht, CSV für tabellarische Exporte oder den Quiet-Modus für eine ID pro Zeile. Der rohe API-Befehl steht bereit, wenn ein Workflow noch keinen eigenen CLI-Befehl hat.

Das offizielle Interface für Coding-Agents

Bring die Queue dorthin, wo dein Agent arbeitet.

oder Demo anfragen