@zapsterapi/cli
v0.1.3
Published
Official CLI for Zapster API. Send WhatsApp messages, manage instances, and automate flows from the shell.
Downloads
35
Maintainers
Readme
@zapsterapi/cli
Official CLI for the Zapster API. Send WhatsApp messages, manage instances, and automate flows from your shell or from any AI agent that can run shell commands.
Install
npm i -g @zapsterapi/cliQuickstart
zapsterapi auth login --token <your-token>
zapsterapi auth whoami
zapsterapi instance list
zapsterapi message send --recipient 5511999999999 --text "olá"Multi-profile
Credentials are stored in ~/.zapsterapi/credentials (INI format). Use --profile <name> or ZAPSTERAPI_PROFILE=<name> to switch:
zapsterapi auth login --token <other-token> --profile work
zapsterapi --profile work instance listJSON output for agents
Every command supports --json:
zapsterapi instance list --json | jq '.data.instances[].id'Environment variables
| Variable | Effect |
|---|---|
| ZAPSTERAPI_PROFILE | Default profile when --profile is not provided. |
| ZAPSTERAPI_API_BASE_URL | Override the API base URL (default https://api.zapsterapi.com). |
| ZAPSTERAPI_CREDENTIALS_FILE | Override the credentials file path. |
| ZAPSTERAPI_CONFIG_DIR | Override the directory used for state markers (e.g. first-run telemetry). |
| ZAPSTERAPI_DISABLE_TELEMETRY | Set to 1 to opt out of CLI usage telemetry. |
Telemetry
The CLI sends privacy-safe usage events (command name, OS, Node version, success/failure code) to PostHog so we can prioritize fixes and features. No tokens, phone numbers, or message content are ever sent. Set ZAPSTERAPI_DISABLE_TELEMETRY=1 to opt out.
Documentation
Full reference and an "agent quickstart" prompt for Claude Code / Codex / OpenClaw lives at developer.zapsterapi.com/pt-BR/v1/cli.
License
MIT
