The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows.

Build Workflows with Ease

Design agent workflows visually on a canvas—connect agents, tools, and blocks, then run them instantly.

Supercharge with Copilot

Leverage Copilot to generate nodes, fix errors, and iterate on flows directly from natural language.

Integrate Vector Databases

Upload documents to a vector store and let agents answer questions grounded in your specific content.

Quickstart

Cloud-hosted: sim.ai

Self-hosted: NPM Package

npx simstudio

→ http://localhost:3000

Note

Docker must be installed and running on your machine.

Options

Flag	Description
-p, --port <port>	Port to run Sim on (default 3000)
--no-pull	Skip pulling latest Docker images

Self-hosted: Docker Compose

git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d

Open http://localhost:3000

Sim also supports local models via Ollama and vLLM — see the Docker self-hosting docs for setup details.

Self-hosted: Manual Setup

Requirements: Bun, Node.js v20+, PostgreSQL 12+ with pgvector

1. Clone and install:

git clone https://github.com/simstudioai/sim.git
cd sim
bun install
bun run prepare  # Set up pre-commit hooks

1. Set up PostgreSQL with pgvector:

docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17

Or install manually via the pgvector guide.

1. Configure environment:

# Main app env (large, app-specific: OAuth secrets, LLM keys, etc.)
cp apps/sim/.env.example apps/sim/.env
perl -i -pe "s/your_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_internal_api_secret/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_api_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env

# Realtime server env (small: just the ~6 shared values)
cp apps/realtime/.env.example apps/realtime/.env
# Copy DATABASE_URL, BETTER_AUTH_URL, BETTER_AUTH_SECRET, INTERNAL_API_SECRET,
# and NEXT_PUBLIC_APP_URL from apps/sim/.env into apps/realtime/.env so both
# services use the same auth secret and DB.

# DB migration env
cp packages/db/.env.example packages/db/.env

# Edit each .env to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"

We use per-app .env files (the Turborepo-canonical pattern) rather than a single root .env. This mirrors production — each service has its own env block in Docker Compose / k8s — and keeps sim's app secrets (OAuth, LLM keys, Stripe, etc.) out of the realtime server's process scope. The shared values (DATABASE_URL, BETTER_AUTH_SECRET, INTERNAL_API_SECRET, etc.) are duplicated across apps/sim/.env and apps/realtime/.env; that's the trade-off.

Production uses env vars passed through Docker Compose / Kubernetes directly and does not read any .env files.

1. Run migrations:

cd packages/db && bun run db:migrate

1. Start development servers:

bun run dev:full  # Starts Next.js app and realtime socket server

Or run separately: bun run dev (Next.js) and bun run dev:sockets (realtime). All scripts run from the repo root.

Copilot API Keys

Copilot is a Sim-managed service. To use Copilot on a self-hosted instance:

• Go to https://sim.ai → Settings → Copilot and generate a Copilot API key
• Set COPILOT_API_KEY in apps/sim/.env to that value

Environment Variables

See the environment variables reference for the full list, or apps/sim/.env.example (main app) and apps/realtime/.env.example (realtime server) for defaults.

Tech Stack

• Framework: Next.js (App Router)
• Runtime: Bun
• Database: PostgreSQL with Drizzle ORM
• Authentication: Better Auth
• UI: Shadcn, Tailwind CSS
• Streaming Markdown: Streamdown
• State Management: Zustand, TanStack Query
• Flow Editor: ReactFlow
• Docs: Fumadocs
• Monorepo: Turborepo
• Realtime: Socket.io
• Background Jobs: Trigger.dev
• Remote Code Execution: E2B
• Isolated Code Execution: isolated-vm

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Made with ❤️ by the Sim Team