Skip to main content

​
Visão Geral

A CLI da Garu permite criar cobranças, gerenciar clientes e diagnosticar sua integração sem sair do terminal. Ideal para automações, scripts e agentes de IA que preferem trabalhar com comandos.
Pré-requisito: Você precisa de uma chave de API. Veja como obter em Autenticação.

​
Instalação

npm install -g @garuhq/cli
Verifique a instalação: 
garu --version

​
Autenticação

Existem três formas de autenticar: 
garu login
Abre o navegador para autenticação. O token é salvo em ~/.config/garu/credentials.json.
Para encerrar a sessão: 
garu logout

​
Referência de Comandos

​
Autenticação

ComandoDescrição
garu loginAutentica via navegador
garu logoutRemove credenciais salvas

​
Cobranças

ComandoDescrição
garu charges createCria uma nova cobrança
garu charges listLista cobranças
garu charges get <id>Consulta detalhes de uma cobrança
garu charges refund <id>Reembolsa uma cobrança

​
Clientes

ComandoDescrição
garu customers createCadastra um novo cliente
garu customers listLista clientes
garu customers get <id>Consulta detalhes de um cliente
garu customers update <id>Atualiza dados de um cliente
garu customers delete <id>Remove um cliente

​
Diagnóstico

ComandoDescrição
garu doctorVerifica configuração e conectividade

​
Flags Globais

FlagDescrição
--api-keyChave de API inline (prioridade sobre env e login)
--jsonSaída em JSON (ideal para scripts e agentes de IA)

​
Modos de Saída

A CLI detecta automaticamente se está rodando em um terminal interativo (TTY) ou em um script:
Saída formatada com cores e tabelas:
garu charges list

┌────────┬──────────────────┬──────────┬─────────┐
│ ID     │ Cliente          │ Valor    │ Status  │
├────────┼──────────────────┼──────────┼─────────┤
│ 12345  │ joao@email.com   │ R$ 49,90 │ paid    │
│ 12346  │ maria@email.com  │ R$ 99,00 │ pending │
└────────┴──────────────────┴──────────┴─────────┘
Use --json quando estiver integrando a CLI com outros scripts ou quando um agente de IA estiver usando a CLI.

​
Diagnóstico com garu doctor

O comando garu doctor verifica se tudo está configurado corretamente: 
garu doctor

✔ Versão da CLI: 1.0.0
✔ Node.js: v20.11.0
✔ Credenciais: configuradas
✔ Conectividade: API acessível
✔ Chave de API: válida (sk_test_***abc)
O que ele verifica:
  • Versão da CLI e do Node.js
  • Se as credenciais estão configuradas
  • Se a API está acessível
  • Se a chave de API é válida

​
Exemplos de Uso

​
Criar uma cobrança PIX

garu charges create \
  --amount 4990 \
  --method pix \
  --customer-email joao@email.com

​
Listar cobranças pagas

garu charges list --status paid

​
Cadastrar um cliente

garu customers create \
  --name "Maria Silva" \
  --email maria@email.com \
  --document 12345678900

​
Recursos

Repositório GitHub

Código-fonte e documentação técnica

Pacote npm

@garuhq/cli no npm

​
Próximos Passos

MCP Server

Conecte agentes de IA à API Garu

Node SDK

Use a SDK para integrar no seu código