Die Fin CLI (@intercom/cli) ist ein Kommandozeilen-Tool für Entwickler und AI-Coding-Agenten wie Claude Code, Cursor oder Codex, um Intercom und Fin programmatisch einzurichten, zu konfigurieren und zu verwalten. Sie können Ihren Coding-Agenten auf die CLI verweisen und ihn in einfacher Sprache bitten, Fin einzurichten, Inhalte zu importieren oder Ihre Fin- und Messenger-Konfiguration zu ändern, ohne Ihre Entwicklungsumgebung zu verlassen. Jeder Befehl ist so gestaltet, dass er ohne interaktive Eingabeaufforderungen funktioniert, mit strukturiertem JSON-Ausgabeformat und klaren Fehlermeldungen für die Nutzung in automatisierten workflows. Erfahren Sie mehr unter fin.ai/cli.
Anforderungen
Node.js 18 oder höher (v20.6.0+ empfohlen)
Ein Intercom-Arbeitsbereich in der US-Region (andere Regionen werden derzeit nicht unterstützt)
Fin CLI oder Fin Agent API MCP server? Verwenden Sie die Fin CLI, wenn Sie möchten, dass ein Coding-Agent Ihren Arbeitsbereich einrichtet oder ändert, z. B. um Verfahren, Anleitungen, Zielgruppen, Datenanschlüsse, workflows, den Messenger oder Artikel zu konfigurieren. Verwenden Sie den Fin Agent API MCP server, wenn ein Agent Fin nutzt, z. B. um Fragen zu stellen oder Verfahren im Auftrag eines Benutzers auszuführen.
Installation
Installieren Sie die CLI global über npm:
npm install -g @intercom/cli
Oder führen Sie sie direkt ohne globale Installation aus:
npx @intercom/cli
Authentifizierung
Die CLI bietet je nach Einrichtung drei Authentifizierungspfade an:
auth login — Geben Sie ein bestehendes Token direkt ein.
auth bootstrap — Erstellen Sie automatisch eine App und erhalten Sie ein Token mit Ihrer E-Mail und Ihrem Passwort.
auth signup — Erstellen Sie einen brandneuen Intercom-Arbeitsbereich von Grund auf.
Anmeldedaten werden sicher in Ihrem System-Schlüsselbund gespeichert (macOS Keychain, Windows Credential Manager oder Linux libsecret) mit einer verschlüsselten Datei als Fallback. Tokens laufen nach etwa 14 Tagen ab. Es gibt derzeit keine automatische Token-Aktualisierung – Sie müssen sich erneut authentifizieren, wenn Ihr Token abläuft.
Wichtige Befehle
Ein-Befehl-Arbeitsbereich-Einrichtung
Der Befehl intercom setup automatisiert die Erstellung des Arbeitsbereichs, die Installation des Messengers und die Befüllung des help center in einem Schritt – keine Benutzeroberfläche erforderlich.
intercom setup
Inhaltserfassung aus Markdown
Befüllen Sie Ihr help center, indem Sie die CLI auf ein lokales Verzeichnis mit Markdown-Dateien verweisen:
intercom setup --content-dir ./docs
Direkter API-Zugriff
Der Befehl intercom api bietet direkten Zugriff auf jeden Intercom API-Endpunkt, ähnlich wie die GitHub CLI mit gh api funktioniert:
intercom api
Fin-Konfiguration
Verwalten Sie Fin-Verfahren, Anleitungen, Zielgruppen, Datenanschlüsse, Simulationen und workflows direkt vom Terminal aus – kein Besuch der Intercom-Benutzeroberfläche erforderlich.
Verwenden Sie die CLI mit Claude Code oder einem anderen Coding-Agenten
Installieren und authentifizieren Sie die CLI, und fragen Sie dann Ihren Coding-Agenten in einfacher Sprache, was Sie tun möchten. Zum Beispiel: „Richten Sie Fin auf unserer Website ein und importieren Sie ./docs/help als Artikel“ oder „Zeigen Sie den Messenger-Launcher nur angemeldeten users an“. Der Agent führt die passenden CLI-Befehle für Sie aus. Um zu überprüfen, was geändert wird, bevor etwas angewendet wird, bitten Sie ihn, zuerst die --plan- oder --dry-run-Flags zu verwenden.
Ressourcenverwaltung
Die CLI enthält spezielle Befehle zur Verwaltung gängiger Intercom-Ressourcen:
Befehl | Operationen |
intercom articles | auflisten, abrufen, erstellen, aktualisieren, löschen |
intercom contacts | auflisten, abrufen, erstellen, aktualisieren, löschen |
intercom conversations | auflisten, abrufen, antworten |
intercom help-center | auflisten, abrufen, erstellen |
intercom messenger | abrufen, aktualisieren, Snippet |
intercom fin | Verfahren, Anleitungen, Zielgruppen, Datenanschlüsse, Simulationen, workflows |
intercom me | zeige aktuelle Arbeitsbereichsinformationen |
Planungs- und Trockenlauf-Modi
Zwei Flags stehen zur Verfügung, um Befehle vor der Ausführung zu validieren:
--plan: Listet die Schritte auf, die die CLI ausführen würde, ohne sie tatsächlich auszuführen. Nützlich für AI-Agenten, die einen workflow vor der Ausführung überprüfen.
--dry-run: Validiert den Befehl und seine Eingaben, ohne Änderungen vorzunehmen.
Ausgabemodi
Alle Befehle unterstützen --json für strukturierte Ausgaben, die sich zum Weiterleiten an andere Tools eignen. Sie können die Ausgabe auch inline mit --jq filtern – keine System-jq-Installation erforderlich.
Bekannte Einschränkungen
Nur US-Region – andere Regionen werden derzeit nicht unterstützt.
Tokens laufen nach etwa 14 Tagen ab, ohne automatische Aktualisierung.
Die Befehle auth signup und auth bootstrap verwenden interne Endpunkte, die in einigen Produktionsumgebungen Web Application Firewall (WAF)-Ausnahmen erfordern können.
Node.js 18 oder höher ist erforderlich. OAuth-Browser-Flow wird noch nicht unterstützt – tokenbasierte Authentifizierung (auth login --token) ist der primär unterstützte Weg.