Fin CLI（@intercom/cli）は、Claude Code、Cursor、Codexなどの開発者やAIコーディングエージェント向けに作られたコマンドラインツールで、IntercomとFinをプログラム的にセットアップ、構成、管理できます。コーディングエージェントにCLIを指示し、Finのセットアップ、コンテンツのインポート、FinやMessengerの設定変更をコーディング環境を離れずに自然言語で依頼できます。すべてのコマンドは対話型プロンプトなしで動作し、構造化されたJSON出力と明確なエラーメッセージを提供し、自動化されたworkflowsでの使用に適しています。詳細はfin.ai/cliをご覧ください。
要件
Node.js 18以上（v20.6.0以上推奨）
米国リージョンのIntercomワークスペース（他のリージョンは現在サポートされていません）
Fin CLIまたはFin Agent API MCPサーバー？ ワークスペースの設定や変更（手順、ガイダンス、audiences、データコネクター、workflows、Messenger、記事の構成など）をコーディングエージェントに行わせたい場合はFin CLIを使用してください。ユーザーに代わって質問したり手順を実行したりするなど、Finを利用させたい場合はFin Agent API MCPサーバーを使用してください。
インストール
npmでCLIをグローバルにインストールします:
npm install -g @intercom/cli
またはグローバルインストールなしで直接実行:
npx @intercom/cli
認証
セットアップに応じてCLIは3つの認証方法を提供します:
auth login — 既存のトークンを直接入力します。
auth bootstrap — メールアドレスとパスワードを使って自動的にアプリを作成し、トークンを取得します。
auth signup — 新しいIntercomワークスペースをゼロから作成します。
資格情報はシステムのキーチェーン（macOS Keychain、Windows Credential Manager、Linux libsecret）に安全に保存され、暗号化ファイルのフォールバックもあります。トークンは約14日で期限切れになります。現在、自動トークン更新はなく、期限切れ時に再認証が必要です。
主要コマンド
ワンコマンドでのワークスペース設定
intercom setupコマンドはワークスペース作成、Messengerインストール、help centerのコンテンツ投入を一度に自動化します。UIは不要です。
intercom setup
Markdownからのコンテンツ取り込み
CLIをローカルのMarkdownファイルディレクトリに向けてhelp centerを充実させます:
intercom setup --content-dir ./docs
Raw APIアクセス
intercom apiコマンドはGitHub CLIのgh apiのように任意のIntercom APIエンドポイントに直接アクセスできます:
intercom api
Finの設定
ターミナルから直接Finの手順、ガイダンス、audiences、データコネクター、シミュレーション、workflowsを管理できます。Intercom UIにアクセスする必要はありません。
Claude Codeや他のコーディングエージェントとCLIを使う
CLIをインストールして認証した後、コーディングエージェントに自然言語でやりたいことを伝えます。例えば「当社サイトでFinをセットアップし、./docs/helpを記事としてインポートして」「ログインユーザーにのみMessengerランチャーを表示して」など。エージェントが対応するCLIコマンドを実行します。変更内容を適用前に確認したい場合は、まず--planまたは--dry-runフラグを使うよう依頼してください。
リソース管理
CLIには一般的なIntercomリソース管理用の専用コマンドがあります:
コマンド | 操作 |
intercom articles | 一覧、取得、作成、更新、削除 |
intercom contacts | 一覧、取得、作成、更新、削除 |
intercom conversations | 一覧、取得、返信 |
intercom help-center | 一覧、取得、作成 |
intercom messenger | 取得、更新、スニペット |
intercom fin | 手順、ガイダンス、audiences、データコネクター、シミュレーション、workflows |
intercom me | 現在のワークスペース情報を表示 |
計画およびドライランモード
コマンド実行前に検証するための2つのフラグがあります:
--plan: CLIが実行するステップを実行せずに一覧表示します。AIエージェントがworkflowsを確認する際に便利です。
--dry-run: コマンドと入力を検証し、変更は行いません。
出力モード
すべてのコマンドは--jsonをサポートし、他のツールにパイプ可能な構造化出力を提供します。--jqでインラインフィルターも可能で、システムjqのインストールは不要です。
既知の制限事項
米国リージョンのみ対応。他のリージョンは現在サポートされていません。
トークンは約14日で期限切れになり、自動更新はありません。
auth signupおよびauth bootstrapコマンドは内部エンドポイントを使用しており、一部の本番環境ではWeb Application Firewall（WAF）例外が必要な場合があります。
Node.js 18以上が必要です。 OAuthブラウザフローはまだサポートされておらず、トークンベース認証（auth login --token）が主な認証方法です。