> ## Documentation Index
> Fetch the complete documentation index at: https://ahasend.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Quick Start
> Get started with the AhaSend CLI in minutes
# Quick Start
This guide will help you send your first email using the AhaSend CLI in just a few minutes.
## Prerequisites
Before you begin, make sure you have:
1. [Installed the AhaSend CLI](/cli/installation)
2. An AhaSend account ([sign up here](https://dash.ahasend.com/user/register))
3. Your API key and Account ID from the [dashboard](https://dash.ahasend.com)
## Step 1: Authentication
First, authenticate with your AhaSend API credentials:
```bash theme={null}
# Interactive login (recommended)
ahasend auth login
```
You'll be prompted to enter:
* Your API key
* Your Account ID
* A profile name (default: "default")
Your credentials are securely stored in `~/.ahasend/config.yaml` for future use.
Alternatively, provide credentials directly:
```bash theme={null}
ahasend auth login --api-key YOUR_API_KEY --account-id YOUR_ACCOUNT_ID
```
Verify your authentication:
```bash theme={null}
ahasend auth status
```
## Step 2: Add a Sending Domain
Before sending emails, you need to add and verify a domain:
```bash theme={null}
# Add your domain
ahasend domains create example.com
```
This command will return DNS records that you need to configure, including SPF, DKIM, and DMARC records that must be added to your domain's DNS settings.
After configuring your DNS records, verify the domain:
```bash theme={null}
# Verify domain configuration
ahasend domains verify example.com
# Check verification status
ahasend domains get example.com
```
DNS propagation can take up to 24 hours, but typically completes within minutes.
## Step 3: Send Your First Email
### Simple Text Email
```bash theme={null}
ahasend messages send \
--from noreply@example.com \
--to recipient@email.com \
--subject "Hello from AhaSend CLI" \
--text "This is my first email sent using the AhaSend CLI!"
```
### HTML Email
```bash theme={null}
ahasend messages send \
--from noreply@example.com \
--to recipient@email.com \
--subject "Welcome to AhaSend" \
--html "Welcome!
Thank you for using AhaSend.
"
```
### Email with Both HTML and Text
```bash theme={null}
ahasend messages send \
--from noreply@example.com \
--to recipient@email.com \
--subject "Welcome" \
--html "Welcome to AhaSend!
We're glad you're here.
" \
--text "Welcome to AhaSend! We're glad you're here."
```
## Step 4: Test with Sandbox Mode
Before sending real emails, test your integration using sandbox mode:
```bash theme={null}
ahasend messages send \
--from noreply@example.com \
--to test@example.com \
--subject "Test Email" \
--text "This is a test email in sandbox mode" \
--sandbox
```
Sandbox mode simulates the entire email sending process without actually delivering emails. Perfect for testing!
You can also simulate different outcomes:
```bash theme={null}
# Simulate a bounce
ahasend messages send \
--from noreply@example.com \
--to test@example.com \
--subject "Test Bounce" \
--text "Testing bounce scenario" \
--sandbox \
--sandbox-result bounce
# Simulate successful delivery
ahasend messages send \
--from noreply@example.com \
--to test@example.com \
--subject "Test Success" \
--text "Testing successful delivery" \
--sandbox \
--sandbox-result deliver
```
## Step 5: Send Batch Emails
### Prepare Recipients File
Create a CSV file with recipient data (`recipients.csv`):
```csv theme={null}
email,name,first_name,company
john@example.com,John Doe,John,ACME Corp
jane@example.com,Jane Smith,Jane,Tech Inc
alice@example.com,Alice Johnson,Alice,StartUp Ltd
```
### Create an HTML Template
Create a template file (`welcome.html`):
```html theme={null}
Welcome {{first_name}}!
Welcome to {{company}}, {{first_name}}!
We're excited to have you on board.
Best regards,
The AhaSend Team
```
### Send Batch Emails
```bash theme={null}
ahasend messages send \
--from welcome@example.com \
--recipients recipients.csv \
--subject "Welcome to {{company}}" \
--html-template welcome.html \
--progress \
--show-metrics
```
The CLI will:
* Send personalized emails to each recipient
* Show a progress bar
* Display performance metrics
* Save any failed recipients for retry
## Step 6: Monitor Your Emails
### Check Delivery Statistics
```bash theme={null}
# View today's statistics
ahasend stats deliverability
# View statistics for a date range
ahasend stats deliverability \
--start-date 2024-01-01 \
--end-date 2024-01-31
```
### List Recent Messages
```bash theme={null}
# List recent sent messages
ahasend messages list
# Filter by status
ahasend messages list --status delivered
```
## Common Patterns
### Using Different Output Formats
```bash theme={null}
# Default table format
ahasend domains list
# JSON format for automation
ahasend domains list --output json
# CSV format for analysis
ahasend stats deliverability --output csv > stats.csv
```
### Working with Multiple Environments
```bash theme={null}
# Set up different profiles
ahasend auth login --profile production
ahasend auth login --profile staging
# Use specific profile for commands
ahasend messages send --profile staging \
--from test@staging.example.com \
--to dev@example.com \
--subject "Staging Test" \
--text "Testing staging environment"
# Switch default profile
ahasend auth switch production
```
### Adding Attachments
```bash theme={null}
ahasend messages send \
--from noreply@example.com \
--to customer@example.com \
--subject "Your Invoice" \
--text "Please find your invoice attached." \
--attach invoice.pdf \
--attach receipt.pdf
```
### Scheduling Emails
```bash theme={null}
# Schedule for a specific time
ahasend messages send \
--from reminder@example.com \
--to user@example.com \
--subject "Reminder: Meeting Tomorrow" \
--text "Don't forget about our meeting at 2 PM." \
--schedule "2024-12-25T10:00:00Z"
```
## What's Next?
Now that you've sent your first emails, explore more features:
Learn about profiles and credential management
Explore all email sending options
Send high-volume emails efficiently
Use templates for personalized emails
## Getting Help
If you need help at any point:
```bash theme={null}
# General help
ahasend --help
# Command-specific help
ahasend messages send --help
# Check current status
ahasend auth status
ahasend ping
```
For additional support:
* [GitHub Issues](https://github.com/AhaSend/ahasend-cli/issues)
* [API Documentation](/api-reference)
* Email: [support@ahasend.com](mailto:support@ahasend.com)