Command Reference

keplars send

Send a transactional email immediately.

keplars send [flags]

Flags:

Flag	Description
`--to`	Recipient email address (required)
`--from`	Sender email address
`--subject`	Email subject line
`--html`	HTML body content (sets `is_html: true`)
`--text`	Plain text body content

Examples:

keplars send \
  --to [email protected] \
  --from [email protected] \
  --subject "Welcome!" \
  --html "<h1>Thanks for signing up!</h1>"

keplars send \
  --to [email protected] \
  --subject "Quick note" \
  --text "Just checking in."

keplars status

Check the Keplars API status.

keplars status

Output:

✓ Keplars API is operational
  API:       https://api.keplars.com
  Status:    operational
  Latency:   42ms

keplars config

Manage your local CLI configuration stored in ~/.keplars/config.json.

keplars config set api-key

Save your API key.

keplars config set api-key YOUR_API_KEY

keplars config set base-url

Override the default API base URL (useful for self-hosted or staging environments).

keplars config set base-url https://api.yourdomain.com

keplars config get

Display the current configuration.

keplars config get

Output:

{
  "api_key": "kms_••••••••••••••••••••••••",
  "base_url": "https://api.keplars.com"
}

keplars config delete

Remove the saved configuration file.

keplars config delete

keplars contacts

Manage contacts in your workspace.

Contacts commands require an admin API key.

Add a contact

keplars contacts add --email [email protected] --name "Jane Doe"

Get a contact

keplars contacts get --email [email protected]

List contacts

keplars contacts list

Update a contact

keplars contacts update --email [email protected] --name "Jane Smith"

Delete a contact

keplars contacts delete --email [email protected]

keplars audiences

Manage audience lists.

Audiences commands require an admin API key.

Create an audience

keplars audiences create --name "Newsletter Subscribers"

List audiences

keplars audiences list

Get an audience

keplars audiences get --id AUDIENCE_ID

Delete an audience

keplars audiences delete --id AUDIENCE_ID

keplars automations

Manage email automations.

Automations commands require an admin API key.

List automations

keplars automations list

Get an automation

keplars automations get --id AUTOMATION_ID

Enroll a contact

keplars automations enroll --id AUTOMATION_ID --email [email protected]

Unenroll a contact

keplars automations unenroll --id AUTOMATION_ID --email [email protected]

keplars domains

Manage custom sending domains.

Domains commands require an admin API key.

Add a domain

keplars domains add --domain yourdomain.com

List domains

keplars domains list

Check domain status

keplars domains status --domain yourdomain.com

Trigger domain verification

keplars domains verify --domain yourdomain.com

Delete a domain

keplars domains delete --domain yourdomain.com

Create a domain API key

keplars domains create-api-key --domain yourdomain.com

Global Flags

These flags work with any command:

Flag	Description
`--api-key`	Override the saved API key for this command
`--base-url`	Override the saved base URL for this command
`--json`	Output response as raw JSON
`--help`, `-h`	Show help for any command
`--version`, `-v`	Print CLI version

Example - one-off key override:

keplars send --api-key kms_other_key --to [email protected] --subject "Test"

Command Reference

On this page