Pular para o conteúdo principal

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.

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.

Quickstart para Agentes

Cole um prompt no Claude Code / Codex e o agente instala e configura tudo.

Instalação

npm i -g @zapsterapi/cli. Requer Node.js 22+.

Múltiplos perfis

Estilo aws-cli — --profile e ZAPSTERAPI_PROFILE para alternar contas.

Saída JSON

Toda saída em JSON estruturado com --json. Pronto para jq e agentes.

Atalhos para agentes de IA

llms.txt

Índice da documentação no formato llmstxt.org. Cole como contexto inicial num agente — ele já fica orientado sobre toda a CLI sem precisar navegar página por página.

SKILL para agentes

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.

O que está em v1

ComandoO que faz
zapsterapi auth loginSalva um token em ~/.zapsterapi/credentials.
zapsterapi auth logoutRemove credenciais do perfil.
zapsterapi auth whoamiVerifica o token e mostra o perfil ativo.
zapsterapi instance listLista as instâncias da conta.
zapsterapi message sendEnvia uma mensagem de texto.
zapsterapi recipient fetchVerifica 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:
export ZAPSTERAPI_DISABLE_TELEMETRY=1