Quickstart

Run Sugabots on your own computer with one command.

This guide runs Sugabots and its PostgreSQL database in Docker on your own computer, with nothing else to install. It's the quickest way to try Sugabots by yourself.

Before you start

You need Docker with Docker Compose. Check it's there:

Terminal
docker compose version

Set it up

  1. Install and start Sugabots

    On macOS or Linux, in a terminal:

    macOS and Linux
    curl -fsSL https://sugabots.ai/install.sh | sh

    On Windows, in PowerShell:

    Windows
    irm https://sugabots.ai/install.ps1 | iex

    This makes a sugabots folder in the current directory and puts two files in it: compose.yml, which runs Sugabots and its database, and .env, with two freshly made secret keys. Then it starts both, and waits until Sugabots answers. The first start downloads the images, so give it a minute.

    Running it again is safe: it keeps the files that are already there.

  2. Say hello

    Open http://localhost:3000 and create your account. You're the first one in, so the installation is yours. Emails, such as your verification link, are printed in the logs:

    Terminal
    cd sugabots
docker compose logs sugabots

What's running

ServiceAddress
Web apphttp://localhost:3000
APIhttp://localhost:3000/api
API health checkhttp://localhost:3000/api/health

The web app and the API share one address: the API answers under /api. Your data lives in the sugabots_postgres_data Docker volume, so it survives restarts. In the sugabots folder, docker compose down stops Sugabots and docker compose up -d starts it again.

To change a setting, add it under environment in compose.yml and run docker compose up -d. The configuration reference lists the settings.

Next

Your workspace is empty. Set up your first workspace to connect a model and meet your first bot.