> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendykit.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get SendyKit running in under 5 minutes

## Prerequisites

* A running [Sendy](https://sendy.co) installation (v6.x)
* Linux server (same server as Sendy, or with MySQL access)
* A SendyKit license key ([get one here](https://sendykit.dev/pricing))

## Install

<Steps>
  <Step title="Download and install">
    ```bash theme={null}
    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
  </Step>

  <Step title="Configure database connection">
    Edit `.env` with your Sendy database credentials:

    ```bash .env theme={null}
    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
    ```

    <Tip>SendyKit reads the **same database** as Sendy. Use the same credentials from Sendy's `includes/config.php`.</Tip>
  </Step>

  <Step title="Start SendyKit">
    ```bash theme={null}
    # 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/`.
  </Step>

  <Step title="Verify installation">
    ```bash theme={null}
    # Check health
    sendykit health

    # Run the doctor (68 automated checks)
    sendykit doctor

    # List your Sendy brands
    sendykit brands list
    ```
  </Step>
</Steps>

## What's Next?

<Columns cols={2}>
  <Card title="Explore the API" icon="code" href="/api-reference/introduction">
    Generated API reference plus overview pages for auth, errors, pagination, and rate limiting.
  </Card>

  <Card title="Try the CLI" icon="terminal" href="/cli/installation">
    Install the CLI, then use health, doctor, brands, and licensing commands from the shell.
  </Card>

  <Card title="Set up SMTP" icon="envelope" href="/features/smtp-overlay">
    Run SendyKit with provider-flexible outbound transport instead of SES-only constraints.
  </Card>

  <Card title="Enable AI" icon="wand-magic-sparkles" href="/features/ai-authoring">
    Configure your provider and use AI-assisted subject lines, email generation, and rewrites.
  </Card>
</Columns>