Sequenzy CLI
The Sequenzy CLI lets you manage subscribers, send emails, and view analytics directly from your terminal.
Installation
# Using npx (no install needed)
npx sequenzy --help
# Or install globally
npm install -g @sequenzy/cli
Authentication
Login
This opens your browser to authenticate. Once approved, you’re logged in.
Check login status
Logout
Commands
Subscribers
# List subscribers
sequenzy subscribers list
sequenzy subscribers list --tag vip
sequenzy subscribers list --segment active-users
# Add a subscriber
sequenzy subscribers add user@example.com
sequenzy subscribers add user@example.com --tag premium --attr name=John
# Get subscriber details
sequenzy subscribers get user@example.com
# Remove a subscriber
sequenzy subscribers remove user@example.com
sequenzy subscribers remove user@example.com --hard # permanent delete
Send Email
Send transactional emails to single recipients:
# Using a template
sequenzy send user@example.com --template welcome --var name=John
# Using raw HTML
sequenzy send user@example.com --subject "Hello" --html "<h1>Hi!</h1>"
# From a file
sequenzy send user@example.com --subject "Report" --html-file ./email.html
Statistics
# Overview stats
sequenzy stats
sequenzy stats --period 30d
# Campaign stats
sequenzy stats --campaign camp_abc123
# Sequence stats
sequenzy stats --sequence seq_xyz789
Campaigns
# List campaigns
sequenzy campaigns list
sequenzy campaigns list --status draft
# Get campaign details
sequenzy campaigns get camp_abc123
# Create a draft campaign
sequenzy campaigns create --name "Launch" --subject "Big News!" --template launch
# Send test email
sequenzy campaigns test camp_abc123 --to me@example.com
Campaigns can only be created as drafts via CLI. Schedule and send from the dashboard.
Sequences
# List sequences
sequenzy sequences list
# Get sequence details
sequenzy sequences get seq_abc123
# Enable/disable
sequenzy sequences enable seq_abc123
sequenzy sequences disable seq_abc123
Templates
# List templates
sequenzy templates list
# Get template
sequenzy templates get tmpl_abc123
sequenzy tags
sequenzy lists
sequenzy segments
Account
sequenzy account
sequenzy websites
AI Generation
# Generate email
sequenzy generate email "Welcome email for new SaaS trial users"
sequenzy generate email "Product launch announcement" --style branded --tone professional
# Generate sequence
sequenzy generate sequence "Onboarding for SaaS trial users"
sequenzy generate sequence "Re-engagement for inactive users" --count 3 --days 7
# Generate subject lines
sequenzy generate subjects "Black Friday sale" --count 5
Environment Variables
| Variable | Description | Default |
|---|
SEQUENZY_API_URL | API server URL | https://api.sequenzy.com |
SEQUENZY_APP_URL | App URL for auth | https://app.sequenzy.com |
Config Location
The CLI stores configuration in:
- macOS/Linux:
~/.config/sequenzy/config.json
- Windows:
%APPDATA%\sequenzy\config.json
Scripting
The CLI is designed to work well in scripts:
#!/bin/bash
# Import subscribers from CSV
while IFS=, read -r email name plan; do
sequenzy subscribers add "$email" --attr "name=$name" --attr "plan=$plan"
done < subscribers.csv
# Check if logged in
if ! sequenzy whoami > /dev/null 2>&1; then
echo "Not logged in"
exit 1
fi
Exit Codes
| Code | Meaning |
|---|
| 0 | Success |
| 1 | Error |
Troubleshooting
”Not logged in”
Run sequenzy login to authenticate.
”API error: 401”
Your session may have expired. Run sequenzy login again.
Browser doesn’t open
Manually visit the URL shown in the terminal to complete authentication.