> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão Geral

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

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

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

***

## Principais Capacidades

<CardGroup cols={3}>
  <Card title="Autenticação" icon="key" href="./auth">
    Login via OAuth, múltiplos perfis e gerenciamento de sessões.
  </Card>

  <Card title="Webhooks" icon="webhook" href="./webhooks">
    Escute, encaminhe e depure webhooks em tempo real.
  </Card>

  <Card title="Pagamentos" icon="wallet" href="./payments">
    Crie, consulte e simule cobranças pelo terminal.
  </Card>

  <Card title="Automação" icon="gear" href="./cases">
    Output em JSON, não-interativo e scriptável.
  </Card>

  <Card title="Configuração" icon="sliders" href="./flags">
    Flags globais, formatos de output e ambientes.
  </Card>

  <Card title="Utilitários" icon="wrench" href="./utils">
    Verificação de webhooks, atualização e debugging.
  </Card>
</CardGroup>

***

## Instalação

### Go (recomendado)

```bash theme={null}
go install github.com/AbacatePay/abacatepay-cli@latest
```

### Homebrew (macOS / Linux)

```bash theme={null}
brew install --build-from-source github.com/AbacatePay/abacatepay-cli
```

**Verificar instalação:**

```bash theme={null}
abacatepay --version
```

<Steps>
  <Step title="Autentique-se">
    ```bash theme={null}
    abacatepay login
    ```

    O navegador abrirá para autenticação OAuth. Após autorizar, informe a URL do seu servidor local para receber webhooks.
  </Step>

  <Step title="Inicie o listener">
    ```bash theme={null}
    abacatepay listen --forward-to http://localhost:3000/webhooks/abacatepay
    ```

    Você também pode rodar apenas `abacatepay listen` para configurar o encaminhamento via menu interativo.
  </Step>

  <Step title="Crie uma cobrança de teste">
    Em outro terminal:

    ```bash theme={null}
    abacatepay payments create pix
    ```

    Você também pode rodar apenas `abacatepay payments create` para escolher via menu, ou usar a flag `-i` para preencher os dados manualmente.
  </Step>
</Steps>

***

## Design & Filosofia

A AbacatePay CLI foi projetada para ser:

* **Explícita** — Nada de mágica escondida
* **Scriptável** — Output estruturado e previsível
* **Compatível com CI/CD** — Totalmente não-interativa com flags
* **Rápida** — Inicialização rápida e footprint mínimo

<CardGroup cols={2}>
  <Card title="Unix-friendly" icon="terminal">
    Output simples, fácil de parsear e integrar.
  </Card>

  <Card title="Sem dependências pesadas" icon="feather">
    Binário único, sem runtime adicional.
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="REST Client" icon="repeat" href="../ecosystem/rest">
    Camada HTTP leve e tipada para integrações avançadas.
  </Card>

  <Card title="SDKs Oficiais" icon="boxes-stacked" href="../sdks">
    Bibliotecas oficiais para diferentes linguagens.
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Repositório Open Source" icon="github" href="https://github.com/abacatepay/abacatepay-cli">
    Código-fonte, issues e contribuições.
  </Card>

  <Card title="Ecossistema AbacatePay" icon="boxes-stacked" href="../ecosystem">
    Veja o ecossistema completo da AbacatePay.
  </Card>
</CardGroup>

<Card title="Open source de verdade" icon="heart">
  A AbacatePay CLI é mantida pela equipe AbacatePay e pela comunidade.
</Card>