​
Quick Setup

1

Install the CLI

Install the SuprSend CLI using your preferred package manager:
npm install -g @suprsend/cli
2

Authenticate

Authenticate with your SuprSend workspace:
suprsend auth login
3

Enable Autocompletion

Enable command autocompletion for a smoother development experience:
# For bash
suprsend completion bash >> ~/.bashrc
source ~/.bashrc
4

Sync Your Project

Pull your existing workflows and sync your project:
# Pull all workflows from your workspace
suprsend workflow pull

# Initialize sync for your project
suprsend sync
This will create a suprsend directory with your workflows, schemas, and configurations.

​
Try a Complete Workflow

Let’s walk through a typical development workflow:
1

Pull Latest Changes

suprsend sync
2

Create a New Workflow

Create a new workflow file locally:
# Create a new workflow
suprsend workflow create --name "welcome-email" --template "email"
3

Test Your Workflow

Test the workflow with sample data:
# Test with sample user data
suprsend workflow test --workflow-id "welcome-email" --user-id "test-user"
4

Deploy to Production

Push your changes to production:
suprsend workflow push --workflow-id "welcome-email"
suprsend workflow enable --workflow-id "welcome-email"

​
Key Developer Features

The SuprSend CLI is designed with developers in mind, offering several advantages. For a complete reference of all available commands and options, see the CLI Reference.

No Color Output

Clean, parseable output perfect for CI/CD pipelines

Verbosity Control

Fine-tune output detail with verbosity flags

Profile Management

Switch between different workspaces and environments

Type Generation

Generate TypeScript types from your schemas

Structured Output

Multiple output formats: JSON, YAML, and pretty for different use cases

Batch Operations

Perform bulk operations efficiently