A CLI oficial permite que agentes de código leiam conversas, pesquisem na sua central de ajuda e preparem o trabalho de suporte a partir do terminal. A skill de agente incluída faz com que tudo o que for visível ao cliente aguarde sua aprovação.
Código aberto · Chatwoot Cloud e auto-hospedado
agent Resuma as conversas urgentes. Somente leitura, não altere nada.
● Carregando a skill do Chatwoot CLI e verificando a fila.
$ 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 }
] }
}
Fila lida
2 conversas precisam de atenção
Alterações feitas
Nenhuma
Resumo pronto.
Uma interface, trabalho real de suporte
A CLI retorna dados estruturados sobre os quais seu agente pode raciocinar. Quando o próximo passo for responder, atribuir, rotular ou resolver, a skill oficial faz o agente mostrar primeiro o comando exato para você.
Resumo da fila
Resuma as conversas abertas atribuídas a mim. Agrupe por urgência e não altere nada no Chatwoot.
$ chatwoot convs --assignee me -s open -o jsonSaída estruturada → resumo do agente
Fila aberta: 12 conversas
Urgentes: 2 · Altas: 3 · Padrão: 7
#8421 — reembolso bloqueado após cobrança duplicada
#8398 — configuração de SSO enterprise aguardando há 18h
Nenhuma alteração feita.Triagem
Encontre todas as conversas urgentes abertas em todas as caixas de entrada. Retorne os IDs e a última mensagem de cada cliente. Somente leitura.
$ chatwoot convs --assignee all -s open -o json | jq '.data.payload[] | select(.priority == "urgent")'JSON filtrado
{
"id": 8421,
"priority": "urgent",
"status": "open",
"inbox_id": 7
}Consulta de conhecimento
Pesquise em nossa central de ajuda artigos sobre como alterar o e-mail de cobrança. Traga o melhor resultado e cite o link público.
$ chatwoot hc articles --query "billing email" -o jsonResultado da busca na central de ajuda
{
"title": "Atualize seus dados de cobrança",
"slug": "update-billing-details",
"category": "Configurações da conta",
"link": "https://support.example.com/..."
}Ação privilegiada
Leia a conversa 8421 e redija uma resposta concisa. Mostre o comando exato da resposta, mas não o execute até que eu aprove.
$ chatwoot conv 8421 reply "Encontrei a cobrança duplicada e pedi ao nosso time de cobrança para estorná-la. Atualizo você por aqui em até um dia útil."Ponto de aprovação
Resposta visível ao cliente preparada.
Comando não executado.
Aguardando aprovação explícita para a conversa #8421.Chatwoot para agentes de código
Um agente de código é útil quando consegue obter contexto confiável e mostrar seu trabalho. O Chatwoot CLI oferece os dois. Em vez de navegar pelo painel ou raspar tabelas do terminal, o agente pode solicitar conversas da central de suporte, contatos do CRM, caixas de entrada, rótulos, equipes e artigos da central de ajuda em um formato previsível.
Junto com a CLI, o Chatwoot também oferece o Captain, o copiloto de IA dentro do produto, e os Agent Bots, que conectam bots personalizados às suas caixas de entrada. A CLI é para o agente de código que já trabalha com você no terminal: Codex, Claude, Cursor, Grok ou outra ferramenta capaz de executar comandos de shell.
Peça a fila aberta, uma única conversa ou todas as mensagens que mencionam um reembolso. O agente pode resumir o que encontrar, agrupar problemas relacionados e apontar as conversas que valem a pena abrir no Chatwoot.
Pesquise na sua central de ajuda do Chatwoot antes de redigir uma resposta. A CLI pode listar portais, pesquisar artigos por consulta ou categoria e buscar o artigo completo que seu agente deve usar como contexto.
A saída em texto é feita para pessoas. Agentes podem solicitar JSON para análise, CSV para exportação ou o modo silencioso quando um pipeline precisa apenas dos IDs dos recursos. Códigos de saída e erros se comportam como em uma ferramenta de linha de comando comum.
Os trabalhos comuns de suporte têm comandos de primeira classe. Quando a CLI ainda não cobre um endpoint, o comando de API bruta pode fazer uma solicitação autenticada na conta configurada do Chatwoot. Chamadas que não sejam GET continuam exigindo aprovação.
O copiloto de IA dentro do Chatwoot. Responde aos clientes diretamente a partir do seu conteúdo de ajuda.
Conecte o seu próprio bot a qualquer caixa de entrada por meio de webhooks e da API de Agent Bots.
Agentes de código no seu terminal, que leem a fila e preparam o trabalho que você aprova.
Como funciona
A skill de agente oficial ensina ao seu agente de código a gramática da CLI, o contrato de saída estruturada e a regra de que escritas em dados compartilhados aguardam confirmação explícita.
O instalador detecta seu sistema operacional e arquitetura, baixa o binário da versão correspondente e verifica o checksum SHA256.
curl -fsSL https://chwt.app/install-cli | shInforme a URL base do seu Chatwoot, a chave de API e o ID da conta. A CLI os valida antes de salvar; a chave de API vai para o keyring do seu sistema operacional.
chatwoot auth loginInstale a skill oficial incluída para que seu agente de código conheça a gramática dos comandos, os formatos de saída e as regras de aprovação de escrita.
npx skills add chatwoot/cliDeixe o agente ler e resumir livremente. Para respostas, atribuições, rótulos, prioridades, status ou chamadas de API que alteram dados, revise o comando exato e confirme primeiro.
Feito para agentes. Prestando contas a humanos.
Um agente pode inspecionar a fila e preparar um plano por conta própria. A skill oficial o instrui a parar e perguntar a você antes de alterar dados compartilhados de suporte ou enviar uma mensagem.
Leia livremente
Confirme antes de escrever
CHATWOOT_API_KEY está disponível para CI e ambientes sem interface.chatwoot api oferece uma saída de emergência autenticada na conta configurada.Início rápido
Instale a versão publicada, entre na sua conta do Chatwoot e adicione a skill oficial para que seu agente conheça os comandos e as regras de segurança.
1 — Instale
$ curl -fsSL https://chwt.app/install-cli | sh
2 — Conecte
$ chatwoot auth login
3 — Ensine seu agente
$ npx skills add chatwoot/cli
✓ Credenciais validadas
✓ Chave de API salva no keyring do sistema
✓ Skill de agente pronta
Novo no Chatwoot?
O Chatwoot é a plataforma de código aberto de suporte ao cliente por trás da CLI: caixa de entrada omnichannel, central de ajuda e Captain AI. Se sua equipe já trabalha em um agente de código, ele pode fazer a triagem de conversas, consultar respostas publicadas e redigir respostas para sua aprovação desde o primeiro dia, no Chatwoot Cloud ou auto-hospedado.
…e qualquer outro agente capaz de executar comandos de shell.
Perguntas respondidas
Os detalhes práticos antes de dar a um agente acesso a uma conta real de suporte.
O Chatwoot CLI é a interface de linha de comando oficial e de código aberto do Chatwoot. Ele permite que pessoas, scripts e agentes de código leiam dados de suporte e executem fluxos de trabalho comuns de conversas a partir de um terminal.
Eles cobrem três superfícies diferentes. O Captain é o copiloto de IA do Chatwoot dentro do produto, respondendo aos clientes a partir do seu conteúdo de ajuda. Os Agent Bots conectam um bot personalizado às suas caixas de entrada por meio da API de Agent Bots. O Chatwoot CLI é para agentes de código no seu terminal, que leem dados de suporte e preparam o trabalho que você aprova.
Qualquer agente capaz de executar comandos de shell pode usar a CLI. Isso inclui Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Grok e Windsurf. A skill do Chatwoot incluída foi projetada para ambientes de agente que suportam skills instaláveis ou instruções de projeto.
Sim. Durante o login, você informa a URL base do Chatwoot, a chave de API e o ID da conta. Isso permite que a mesma CLI se conecte ao Chatwoot Cloud ou a uma instalação auto-hospedada do Chatwoot.
A CLI suporta respostas, notas privadas, atribuições, rótulos, prioridades e mudanças de status. A skill de agente oficial trata essas ações como escritas privilegiadas: o agente deve mostrar o comando exato e aguardar aprovação explícita antes de executá-lo.
O login interativo armazena a chave de API no keyring do seu sistema operacional. Configurações não sigilosas ficam no arquivo de configuração do Chatwoot CLI. Ambientes de CI e sem interface podem fornecer CHATWOOT_API_KEY.
Sim. Use a saída em JSON quando o código precisar da resposta completa, CSV para exportações tabulares ou o modo silencioso para um ID por linha. O comando de API bruta está disponível quando um fluxo de trabalho ainda não tem um comando de primeira classe na CLI.
A interface oficial para agentes de código