CLI

Visão Geral

Ferramenta oficial de linha de comando da HyzePay para desenvolvimento, testes e automações.

A HyzePay CLI é a ferramenta oficial de linha de comando para interagir com a plataforma HyzePay diretamente do terminal.

Projetada para desenvolvedores, permite criar cobranças, escutar webhooks, validar assinaturas e automatizar fluxos — tudo sem sair do terminal.

Principais Capacidades

Autenticação

Webhooks

Escute, encaminhe e depure webhooks em tempo real.

Pagamentos

Crie, consulte e cancele cobranças PIX pelo terminal.

Automação

Output em JSON, não-interativo e scriptável.

Configuração

Flags globais, formatos de output e ambientes.

Utilitários

Verificação de webhooks, health check e versão.

Instalação

A CLI roda em Node.js 18+ (Windows, macOS e Linux).

npm / npx (recomendado)

Instale globalmente ou rode sob demanda com npx:

# instalar globalmente
npm install -g @hyzepay/cli

# ou sem instalar
npx @hyzepay/cli --help

# conferir versão
hyzepay version

Link local (monorepo)

Se você clonou o repositório HyzePay:

cd cli
npm link
hyzepay --help

Gere uma API Key no dashboard: Integração → API → Nova chave. Depois: hyzepay auth login --api-key hzp_live_…

Design & Filosofia

A CLI espelha a API pública /api/v1: mesmos recursos, mesmos erros, saída pronta para scripts.

Scriptável — use --json e exit codes previsíveis em CI
Perfis — troque entre sandbox e produção sem reexportar variáveis
Segurança — chaves ficam em ~/.hyzepay/config.json com permissões restritas; nunca no frontend
Zero dependências — Node puro, instalação leve

# fluxo típico
hyzepay auth login --api-key $HYZEPAY_API_KEY --base-url https://hyzepay.pro
hyzepay payments create --amount 19.90 --external-id pedido-1001 --json
hyzepay webhooks listen --port 4242 --forward http://localhost:3000/webhooks