> ## 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.

# Zapster CLI

> Send messages, manage instances, and automate Zapster from your shell.

The Zapster CLI (`zapsterapi`) is a thin wrapper around our REST API. It exists for two cases where the dashboard gets in the way:

* **AI agents** running shell commands (Claude Code, Codex, OpenClaw): paste a prompt, the agent installs and configures, and you're sending messages in seconds.
* **CI pipelines** that need to fire messages, list instances, or validate tokens without opening a browser.

The CLI **does not replace** the API or the MCP server — it's a shell-optimized shortcut.

<CardGroup cols={2}>
  <Card title="Agent Quickstart" icon="bot" href="/en/v1/cli/agent-quickstart">
    Paste a prompt into Claude Code / Codex and the agent installs and configures everything.
  </Card>

  <Card title="Reference (pt-BR)" icon="book" href="/pt-BR/v1/cli/introduction">
    Full reference and examples in Portuguese.
  </Card>
</CardGroup>

## v1 commands

| Command                      | Purpose                                      |
| ---------------------------- | -------------------------------------------- |
| `zapsterapi auth login`      | Save a token to `~/.zapsterapi/credentials`. |
| `zapsterapi auth logout`     | Remove the active profile's credentials.     |
| `zapsterapi auth whoami`     | Verify the active token.                     |
| `zapsterapi instance list`   | List instances.                              |
| `zapsterapi message send`    | Send a text message.                         |
| `zapsterapi recipient fetch` | Check if a number exists on WhatsApp.        |

Webhook tunneling, mock server, device-flow auth and plugins are deliberately out of scope for v1 — they're on the post-v1 roadmap.

## Privacy and telemetry

The CLI sends privacy-safe events to PostHog (command name, success/failure, error code, Node version, OS). **No tokens, phone numbers, or message content are ever collected.** To opt out:

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