PipelimePipelime Docs
CLI

Commands

Complete reference of all Pipelime CLI commands.

CLI Commands

All commands support --format table|json|quiet for output formatting and --profile <name> for profile selection.

Authentication

# Login with API key
Pipelime auth login --api-key ki_your_key

# Show current user
Pipelime whoami

# Logout
Pipelime auth logout

Campaigns

# List campaigns
Pipelime campaign list

# Create a campaign
Pipelime campaign create --name "Campaign Name"

# Show campaign details
Pipelime campaign show <campaign-id>

# Update campaign settings
Pipelime campaign update <campaign-id> \
  --timezone "America/New_York" \
  --send-days "mon,tue,wed,thu,fri" \
  --send-window-start "09:00" \
  --send-window-end "17:00"

# Add a step to a campaign
Pipelime campaign add-step <campaign-id> \
  --subject "Email subject" \
  --body "<p>Email body</p>" \
  --delay-days 0

# Assign email accounts
Pipelime campaign assign-accounts <campaign-id> \
  --account-ids ea_123,ea_456

# Add contacts to campaign
Pipelime campaign add-contacts <campaign-id> \
  --contact-ids cont_123,cont_456

# Start campaign
Pipelime campaign start <campaign-id>

# Pause campaign
Pipelime campaign pause <campaign-id>

# Preview a step with contact data
Pipelime campaign preview <campaign-id> --step 1 --contact-id cont_123

# Send test email
Pipelime campaign test-send <campaign-id> --step 1 --to test@example.com

Contacts

# List contacts
Pipelime contact list

# Create a contact
Pipelime contact create \
  --email john@example.com \
  --first-name John \
  --last-name Doe \
  --company-name "Pipelime" \
  --title "VP Engineering"

# Show contact details
Pipelime contact show <contact-id>

# Update a contact
Pipelime contact update <contact-id> --title "CTO"

# Import from CSV
Pipelime contact import --file contacts.csv --campaign-id <campaign-id>

# Export contact data (GDPR)
Pipelime contact export --contact-id <contact-id> --format json

# Delete a contact
Pipelime contact delete --contact-id <contact-id>
Pipelime contact delete --contact-id <contact-id> --hard  # permanent

Companies

# List companies
Pipelime company list

# Show company details
Pipelime company show <company-id>

# Create a company
Pipelime company create --name "Pipelime" --domain "pipelime.app"

# Update a company
Pipelime company update <company-id> --industry "SaaS"

Email Accounts

# List email accounts
Pipelime email-account list

# Show account details and health
Pipelime email-account show <account-id>

# Update daily send limit
Pipelime email-account update <account-id> --daily-limit 150

# Disconnect an account
Pipelime email-account disconnect <account-id>

Blocklist

# List blocklist entries
Pipelime blocklist list

# Add to blocklist
Pipelime blocklist add --email spam@example.com
Pipelime blocklist add --domain competitor.com

# Remove from blocklist (admin only)
Pipelime blocklist remove --email previously@example.com

Activity

# List recent activity
Pipelime activity list

# Filter by campaign
Pipelime activity list --campaign-id <campaign-id>

# Filter by event type
Pipelime activity list --type email.opened

# Stream events in real-time
Pipelime events listen
Pipelime events listen --types email.sent,email.replied

Webhooks

# List webhooks
Pipelime webhook list

# Create a webhook
Pipelime webhook create \
  --url https://your-app.com/webhooks \
  --events email.sent,email.replied,email.bounced

# Delete a webhook
Pipelime webhook delete <webhook-id>

# Rotate secret
Pipelime webhook rotate-secret <webhook-id>

API Keys

# List API keys
Pipelime api-key list

# Create an API key
Pipelime api-key create --name "CI/CD Key" --scope full-access

# Revoke an API key
Pipelime api-key revoke <key-id>

On this page