Package Exports
- @truncus/cli
- @truncus/cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@truncus/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@truncus/cli
Command-line interface for Truncus Email.
Installation
npm install -g @truncus/cliQuick Start
# Authenticate
truncus login
# Send an email
truncus send \
--to user@example.com \
--from noreply@mail.yourdomain.com \
--subject "Hello" \
--html "<p>Hi there!</p>"
# Read HTML from file
truncus send --to user@example.com --from noreply@mail.yourdomain.com \
--subject "Report" --file ./report.html
# Check status
truncus status <email-id>
# Validate without sending
truncus validate \
--to user@example.com \
--from noreply@mail.yourdomain.com \
--subject "Test"
# List domains
truncus domains listCommands
| Command | Description |
|---|---|
truncus login |
Store API key |
truncus login --logout |
Clear credentials |
truncus send |
Send an email |
truncus validate |
Dry-run validation |
truncus status <id> |
Check email status |
truncus domains list |
List verified domains |
Environment Variables
TRUNCUS_API_KEY— alternative totruncus loginTRUNCUS_BASE_URL— override API base URL