@sendpigeon-sdk/cli
v1.2.1
Published
SendPigeon CLI - send emails and manage your account
Downloads
175
Maintainers
Readme
@sendpigeon-sdk/cli
SendPigeon CLI - send emails and manage your account from the terminal.
Installation
npm install -g @sendpigeon-sdk/cli
# Or use with npx
npx @sendpigeon-sdk/cli <command>Commands
sendpigeon dev
Start a local dev server for catching emails:
sendpigeon devThis starts:
- API at
http://localhost:4100/v1/emails - UI at
http://localhost:4100 - SMTP at
localhost:4125
Options:
-p, --port <port>- HTTP port (default: 4100)--smtp-port <port>- SMTP port (default: 4125)--no-smtp- Disable SMTP server
sendpigeon send
Send an email:
sendpigeon send \
--from [email protected] \
--to [email protected] \
--subject "Hello" \
--html "<p>Hi there!</p>"
# With template
sendpigeon send \
--from [email protected] \
--to [email protected] \
--template welcome \
--var name=John \
--var company=AcmeOptions:
--from <email>- Sender address (required, must be verified domain)--to <email>- Recipient (required, comma-separated for multiple)--subject <text>- Email subject--html <html>- HTML body--text <text>- Plain text body--template <id>- Template ID--var <key=value>- Template variable (repeatable)--cc, --bcc, --reply-to- Additional recipients--tag <tag>- Add tag (repeatable, max 5)--track-opens- Enable open tracking--track-clicks- Enable click tracking
sendpigeon status
Check API key and account status:
sendpigeon statussendpigeon templates
Manage email templates:
sendpigeon templates list # List all templates
sendpigeon templates get <id> # Get template details
sendpigeon templates pull # Download to ./sendpigeon-templates/
sendpigeon templates push # Upload from ./sendpigeon-templates/sendpigeon logs
View email logs:
sendpigeon logs # Show recent emails
sendpigeon logs --status bounced # Filter by status
sendpigeon logs tail # Stream in real-time
sendpigeon logs get <id> # Get email detailssendpigeon webhooks
Manage webhooks:
sendpigeon webhooks # Show webhook config
sendpigeon webhooks test # Send test webhook
sendpigeon webhooks deliveries # List recent deliveriessendpigeon domains
Manage sending domains:
sendpigeon domains list # List all domains
sendpigeon domains verify <id> # Check DNS recordsAuthentication
Set your API key via environment variable:
export SENDPIGEON_API_KEY=sk_live_xxxOr pass it to any command:
sendpigeon status --api-key sk_live_xxxLocal Development
Set SENDPIGEON_DEV=true to route SDK requests to the local dev server:
# Terminal 1
sendpigeon dev
# Terminal 2
SENDPIGEON_DEV=true node your-app.jsLicense
MIT
