CLI Overview

Install and use the Keplars CLI to send emails and manage resources from your terminal

The Keplars CLI lets you send emails, manage contacts, audiences, automations, and domains directly from your terminal.

Installation

brew tap KeplarsHQ/cli
brew install keplars

scoop bucket add keplars https://github.com/KeplarsHQ/cli
scoop install keplars

curl -fsSL https://cli.keplars.com/install.sh | sh

irm https://cli.keplars.com/install.ps1 | iex

Verify the installation:

keplars --version

Quick Start

1. Set your API key

keplars config set api-key YOUR_API_KEY

Your key is saved to ~/.keplars/config.json and used automatically for all commands.

2. Send your first email

keplars send \
  --to [email protected] \
  --from [email protected] \
  --subject "Hello from CLI" \
  --text "This email was sent from the Keplars CLI."

3. Check API status

keplars status

API Key Types

Two key types are supported:

Regular API key (kms_...) - required for sending emails via keplars send
Admin API key - required for managing contacts, audiences, automations, and domains

Get both keys from the Keplars Dashboard under Settings → API Keys.

Next Steps

Command Reference - Full list of commands, flags, and examples
Send Emails - Learn about the email API
Authentication - API key setup