CLI

Configuração

Flags globais, formatos de output e ambientes. A CLI resolve credenciais nesta ordem: flags → env → perfil.

Arquivo de configuração

Credenciais e preferências ficam em:

~/.hyzepay/config.json

O diretório é criado com permissão 0700 e o arquivo com 0600. Exemplo:

{
  "defaultProfile": "prod",
  "profiles": {
    "prod": {
      "apiKey": "hzp_live_…",
      "baseUrl": "https://hyzepay.pro"
    },
    "local": {
      "apiKey": "hzp_live_test_…",
      "baseUrl": "http://localhost:3000"
    }
  }
}

Não versione este arquivo. Prefira secrets no CI via HYZEPAY_API_KEY.

Flags globais

Flag	Descrição
`--profile, -p`	Nome do perfil de credenciais
`--api-key`	Sobrescreve a chave do perfil / env
`--base-url`	URL base (sem barra final)
`--json`	Saída machine-readable (JSON)
`--quiet, -q`	Silencioso — só erros no stderr
`--help, -h`	Ajuda do comando

Variáveis de ambiente

Variável	Descrição
`HYZEPAY_API_KEY`	Chave hzp_live_…
`HYZEPAY_BASE_URL`	Base URL da API
`HYZEPAY_PROFILE`	Perfil padrão da sessão
`HYZEPAY_WEBHOOK_SECRET`	Secret whsec_… para verify/listen

Formato de saída

Por padrão a saída é legível para humanos. Com --json, o CLI imprime o payload da API (ou um envelope estruturado) — ideal para jq e pipelines.

hyzepay payments list --status paid --json \
  | jq '.payments[] | {id, amount_label, external_id}'

Exit code 0 = sucesso; 1 = erro de uso ou da API.

Comandos `config`