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

# CLI Zapster

> Envie mensagens, gerencie instâncias e automatize fluxos da Zapster direto do shell.

A CLI Zapster (`zapsterapi`) é um wrapper fino sobre nossa REST API. Ela existe para dois cenários onde a UI do dashboard atrapalha:

* **Agentes de IA** que executam comandos shell (Claude Code, Codex, OpenClaw): copia o prompt, o agente instala e configura, e você manda mensagem em segundos.
* **Pipelines de CI** que precisam disparar mensagens, listar instâncias ou validar tokens sem abrir um browser.

A CLI **não substitui** a API nem o MCP server — ela é um atalho otimizado para shell e agentes.

<CardGroup cols={2}>
  <Card title="Quickstart para Agentes" icon="bot" href="/pt-BR/v1/cli/agent-quickstart">
    Cole um prompt no Claude Code / Codex e o agente instala e configura tudo.
  </Card>

  <Card title="Instalação" icon="download" href="/pt-BR/v1/cli/installation">
    `npm i -g @zapsterapi/cli`. Requer Node.js 22+.
  </Card>

  <Card title="Múltiplos perfis" icon="users" href="/pt-BR/v1/cli/profiles">
    Estilo aws-cli — `--profile` e `ZAPSTERAPI_PROFILE` para alternar contas.
  </Card>

  <Card title="Saída JSON" icon="code" href="/pt-BR/v1/cli/json-output">
    Toda saída em JSON estruturado com `--json`. Pronto para `jq` e agentes.
  </Card>
</CardGroup>

## Atalhos para agentes de IA

<CardGroup cols={2}>
  <Card title="llms.txt" icon="file-lines" href="/llms.txt">
    Índice da documentação no formato [llmstxt.org](https://llmstxt.org/). Cole como contexto inicial num agente — ele já fica orientado sobre toda a CLI sem precisar navegar página por página.
  </Card>

  <Card title="SKILL para agentes" icon="puzzle-piece" href="/pt-BR/v1/cli/skill">
    Skill no formato Claude Code, com botão de copy-paste pronto. Cole em `~/.claude/skills/zapsterapi-cli/SKILL.md` e o agente passa a usar a CLI sem prompts adicionais.
  </Card>
</CardGroup>

## O que está em v1

| Comando                      | O que faz                                          |
| ---------------------------- | -------------------------------------------------- |
| `zapsterapi auth login`      | Salva um token em `~/.zapsterapi/credentials`.     |
| `zapsterapi auth logout`     | Remove credenciais do perfil.                      |
| `zapsterapi auth whoami`     | Verifica o token e mostra o perfil ativo.          |
| `zapsterapi instance list`   | Lista as instâncias da conta.                      |
| `zapsterapi message send`    | Envia uma mensagem de texto.                       |
| `zapsterapi recipient fetch` | Verifica se um número está disponível no WhatsApp. |

Ficou de fora propositalmente: webhook tunneling estilo Stripe `listen`, mock server local, device-flow auth e plugins. Esses estão no roadmap pós-v1.

## Privacidade e telemetria

A CLI envia eventos privacy-safe ao PostHog (nome do comando, sucesso/falha, código de erro, versão do Node, OS). **Nenhum token, número ou conteúdo de mensagem é coletado**. Para opt-out:

```bash theme={null}
export ZAPSTERAPI_DISABLE_TELEMETRY=1
```