Quickstart

Prerequisites

A running Sendy installation (v6.x)
Linux server (same server as Sendy, or with MySQL access)
A SendyKit license key (get one here)

Install

Download and install

curl -sSL https://install.sendykit.dev | bash

The installer:

Detects your OS and architecture
Downloads the correct Go binary
Prompts for your license key
Validates the license
Creates the configuration file

Configure database connection

Edit .env with your Sendy database credentials:

.env

DB_HOST=localhost
DB_PORT=3306
DB_USER=sendy_user
DB_PASS=your_password
DB_NAME=sendy_database

# Your license key (set during install)
SENDYKIT_LICENSE_KEY=sk_lic_xxxxxxxxxxxxx

SendyKit reads the same database as Sendy. Use the same credentials from Sendy’s includes/config.php.

Start SendyKit

# Run migrations (adds sendykit_ prefixed tables, never modifies Sendy tables)
sendykit migrate

# Start the API server
sendykit serve

Your SendyKit API is now running at http://localhost:3939/sendykit/api/v2/.

Verify installation

# Check health
sendykit health

# Run the doctor (68 automated checks)
sendykit doctor

# List your Sendy brands
sendykit brands list

What’s Next?

Explore the API

Generated API reference plus overview pages for auth, errors, pagination, and rate limiting.

Try the CLI

Install the CLI, then use health, doctor, brands, and licensing commands from the shell.

Set up SMTP

Run SendyKit with provider-flexible outbound transport instead of SES-only constraints.

Enable AI

Configure your provider and use AI-assisted subject lines, email generation, and rewrites.

SendyKit Documentation Installation

Getting Started

Concepts

Self-Hosted

Billing

Features

Readiness

CLI

Prerequisites

Install

What’s Next?

Explore the API

Try the CLI

Set up SMTP

Enable AI

​Prerequisites

​Install

​What’s Next?

Explore the API

Try the CLI

Set up SMTP

Enable AI

Prerequisites

Install

What’s Next?