Command Reference

Authentication

Authenticate with your Envloped API key.

envloped login --api-key en_xxxxx       # Direct flag
envloped login                          # Interactive prompt

`envloped logout`

Clear stored credentials for the current profile.

envloped logout
envloped logout --profile staging

`envloped whoami`

Show the authenticated user and organization info.

envloped whoami
envloped whoami --json

Sending Emails

`envloped send`

Send an email from the terminal.

# Inline text
envloped send --from hello@mydomain.com --to user@example.com \
  --subject "Welcome!" --text "Hello world"

# HTML body
envloped send --from hello@mydomain.com --to user@example.com \
  --subject "Welcome!" --html "<h1>Hello</h1>"

# From file
envloped send --from hello@mydomain.com --to user@example.com \
  --subject "Newsletter" --html-file template.html

# JSON stdin (best for CI/CD and agents)
echo '{"from":"a@b.com","to":"c@d.com","subject":"Hi","text":"Hello"}' | envloped send --stdin

# Multiple recipients
envloped send --from a@b.com --to user1@example.com --to user2@example.com \
  --subject "Broadcast" --text "Hello all"

# Dry run (validate without sending)
envloped send --from a@b.com --to user@example.com --subject "Test" --text "Hi" --dry-run

Flag	Description
`--from`	Sender email address
`--to`	Recipient email address (repeatable)
`--subject`	Email subject
`--html`	HTML body
`--text`	Plain text body
`--html-file`	Read HTML body from file
`--text-file`	Read text body from file
`--stdin`	Read full email payload as JSON from stdin
`--dry-run`	Validate without sending

Email Management

`envloped emails list`

List sent emails with optional filtering.

envloped emails list
envloped emails list --status sent
envloped emails list --status failed --limit 10
envloped emails list --search "welcome"
envloped emails list --json

Flag	Description
`--status`	Filter by status: `sent`, `failed`, `bounced`
`--search`	Search by recipient address or subject
`--limit`	Number of results (default: 20)
`--page`	Page number (default: 1)

`envloped emails get [id]`

Get details for a specific email.

envloped emails get abc123
envloped emails get abc123 --json

Domain Management

`envloped domains list`

List all domains for your account.

envloped domains list
envloped domains list --json

`envloped domains add [domain]`

Add a new domain and display DNS records for verification.

envloped domains add mydomain.com

`envloped domains verify [domain]`

Check the verification status of a domain.

envloped domains verify mydomain.com

`envloped domains records [domain]`

Re-display DNS records needed to verify a domain.

envloped domains records mydomain.com

API Key Management

`envloped keys list`

List all API keys for your account.

envloped keys list
envloped keys list --json

`envloped keys create [name]`

Create a new API key. The key is only displayed once.

envloped keys create "Production Key"
envloped keys create "CI Pipeline Key" --json

`envloped keys delete [id]`

Delete an API key. Requires confirmation unless --force is used.

envloped keys delete abc123
envloped keys delete abc123 --force

Configuration

`envloped config set [key] [value]`

Set a configuration value.

envloped config set default_from hello@mydomain.com
envloped config set api_url https://api.envloped.com

`envloped config get [key]`

Get a configuration value.

envloped config get default_from

Valid keys: api_url, default_from, output_format

Shell Completions

`envloped completion [shell]`

Generate shell completion scripts.

# Bash
source <(envloped completion bash)

# Zsh
source <(envloped completion zsh)

# Fish
envloped completion fish | source

Other

`envloped version`

Print the CLI version, commit, and build date.

envloped version
# envloped v0.1.0 (commit: abc123, built: 2026-03-28)

Command Reference

On this page