O Fin CLI (@intercom/cli) é uma ferramenta de linha de comando criada para desenvolvedores e agentes de codificação AI, como Claude Code, Cursor ou Codex, para configurar, ajustar e gerenciar Intercom e Fin programaticamente. Você pode direcionar seu agente de codificação para o CLI e pedir em linguagem simples para configurar o Fin, importar conteúdo ou alterar sua configuração do Fin e Messenger, sem sair do seu ambiente de codificação. Cada comando é projetado para funcionar sem prompts interativos, com saída JSON estruturada e mensagens de erro claras para uso em workflows automatizados. Saiba mais em fin.ai/cli.
Requisitos
Node.js 18 ou superior (v20.6.0+ recomendado)
Um workspace Intercom na região dos EUA (outras regiões não são suportadas atualmente)
Fin CLI ou Fin Agent API MCP server? Use o Fin CLI quando quiser que um agente de codificação configure ou altere seu workspace, como configurar procedimentos, guidance, audiences, data connectors, workflows, o Messenger ou artigos. Use o Fin Agent API MCP server quando quiser que um agente use o Fin, como fazer perguntas ou executar procedimentos em nome de um usuário.
Instalação
Instale o CLI globalmente via npm:
npm install -g @intercom/cli
Ou execute diretamente sem instalação global:
npx @intercom/cli
Autenticação
O CLI oferece três caminhos de autenticação dependendo da sua configuração:
auth login — Insira um token existente diretamente.
auth bootstrap — Crie automaticamente um app e recupere um token usando seu e-mail e senha.
auth signup — Crie um workspace Intercom totalmente novo do zero.
As credenciais são armazenadas com segurança no keychain do seu sistema (macOS Keychain, Windows Credential Manager ou Linux libsecret), com fallback para arquivo criptografado. Tokens expiram após aproximadamente 14 dias. Atualmente não há atualização automática de token — será necessário reautenticar quando seu token expirar.
Comandos principais
Configuração do workspace com um comando
O comando intercom setup automatiza a criação do workspace, instalação do Messenger e preenchimento do help center em uma única etapa — sem necessidade de UI.
intercom setup
Ingestão de conteúdo a partir de Markdown
Preencha seu help center apontando o CLI para um diretório local de arquivos Markdown:
intercom setup --content-dir ./docs
Acesso direto à API
O comando intercom api fornece acesso direto a qualquer endpoint da API Intercom, semelhante a como o GitHub CLI funciona com gh api:
intercom api
Configuração do Fin
Gerencie procedimentos, guidance, audiences, data connectors, simulações e workflows do Fin diretamente pelo terminal — sem necessidade de visitar a UI do Intercom.
Use o CLI com Claude Code ou outro agente de codificação
Instale e autentique o CLI, depois peça ao seu agente de codificação o que deseja fazer em linguagem simples. Por exemplo, "Configure o Fin no nosso site e importe ./docs/help como artigos", ou "Mostre o lançador do Messenger apenas para usuários logados". O agente executa os comandos CLI correspondentes para você. Para revisar o que será alterado antes de aplicar, peça para usar as flags --plan ou --dry-run primeiro.
Gerenciamento de recursos
O CLI inclui comandos dedicados para gerenciar recursos comuns do Intercom:
Comando | Operações |
intercom articles | listar, obter, criar, atualizar, deletar |
intercom contacts | listar, obter, criar, atualizar, deletar |
intercom conversations | listar, obter, responder |
intercom help-center | listar, obter, criar |
intercom messenger | obter, atualizar, snippet |
intercom fin | procedures, guidance, audiences, data connectors, simulations, workflows |
intercom me | mostrar informações do workspace atual |
Modos de planejamento e simulação
Duas flags estão disponíveis para validar comandos antes de executá-los:
--plan: Lista os passos que o CLI executaria sem realmente executá-los. Útil para agentes AI revisarem um workflow antes de confirmar.
--dry-run: Valida o comando e suas entradas sem fazer alterações.
Modos de saída
Todos os comandos suportam --json para saída estruturada adequada para ser usada em outras ferramentas. Você também pode filtrar a saída inline usando --jq — não é necessária instalação do jq no sistema.
Limitações conhecidas
Apenas região dos EUA — outras regiões não são suportadas atualmente.
Tokens expiram após aproximadamente 14 dias sem atualização automática.
Os comandos auth signup e auth bootstrap usam endpoints internos que podem exigir exceções no Web Application Firewall (WAF) em alguns ambientes de produção.
Node.js 18 ou superior é obrigatório. OAuth browser flow ainda não é suportado — autenticação baseada em token (auth login --token) é o caminho principal suportado.