Envloped Docs

CLI Getting Started

Install the Envloped CLI and send your first email in minutes.

Envloped CLI

The Envloped CLI lets you send emails, manage domains, and API keys directly from your terminal or CI/CD pipelines.

Installation

curl (Linux / macOS)

curl -fsSL https://envloped.com/install.sh | bash

Manual download

Download the latest binary from GitHub Releases for your platform.

Quick Start

1. Authenticate

envloped login --api-key en_YOUR_API_KEY

Or interactively:

envloped login
> Paste your API key: ****
> Logged in as you@company.com at Company (pro plan)

2. Send your first email

envloped send \
  --from hello@yourdomain.com \
  --to user@example.com \
  --subject "Hello from the CLI" \
  --text "This email was sent from the terminal!"

3. Check status

envloped emails list

Configuration

Configuration is stored in ~/.config/envloped/config.toml. Set defaults:

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

Environment Variables

For CI/CD, use environment variables instead of envloped login:

VariableDescription
ENVLOPED_API_KEYAPI key for authentication
ENVLOPED_API_URLOverride API base URL
ENVLOPED_PROFILEConfiguration profile to use

Global Flags

All commands support these flags:

FlagDescription
--jsonOutput in JSON format (for piping to jq, scripts, etc.)
--quietSuppress non-essential output
--api-keyOverride API key for this command
--profileUse a specific configuration profile
--api-urlOverride API base URL

On this page