Skip to content

Quick Start

This guide walks you through setting up Synatra on your local machine.

  • Node.js 22+
  • pnpm 10+
  • Docker & Docker Compose
  1. Clone the repository

    Terminal window
    git clone https://github.com/synatrahq/synatra.git
    cd synatra
  2. Install dependencies

    Terminal window
    pnpm install
  3. Configure environment

    Terminal window
    cp .env.example .env
  4. Start services

    Terminal window
    make compose-up
  5. Apply database migrations

    Terminal window
    make db-migrations-push
ServiceURL
Consolehttp://localhost:5173
API Serverhttp://localhost:8787
Temporal UIhttp://localhost:8080

Now that Synatra is running, learn about the core concepts:

  • Agents - AI executors with versioned configurations
  • Tools - User-defined functions agents can call
  • Resources - External integrations with encrypted credentials
  • Triggers - Cron, webhooks, and app events to start workflows