Sim.ai Documentation Slack X

Ask DeepWiki Set Up with Cursor

Sim — Integrate, Context, Build, and Monitor AI agents

A workspace to build, deploy and manage AI agents and workflows.

## Quickstart ### Cloud-hosted: [sim.ai](https://sim.ai) Open sim.ai ### Self-hosted ```bash git clone https://github.com/simstudioai/sim.git && cd sim bun run setup ``` Open [http://localhost:3000](http://localhost:3000)

The Sim platform — chat on the left, the visual workflow builder on the right

## Capabilities - Connect 1,000+ integrations and every major LLM - Add Slack, Notion, HubSpot, Salesforce, databases, and more - Build agents visually, conversationally, or with code - Ingest files, knowledge bases, and structured table data - Monitor runs, logs, schedules, and workflow activity ## One workspace, every surface

Chat and workflows are just the start — tables, files, knowledge, and scheduled tasks all live in the same workspace.

Tables in Sim — structured data your agents can query

Tables — a database, built in

Files in Sim — documents for your team and every agent

Files — one store for your team and every agent

Knowledge bases in Sim — synced docs your agents can search

Knowledge — your agents' memory

Scheduled tasks in Sim — recurring agent runs on a calendar

Scheduled tasks — runs on your schedule

## Self-hosting **Requirements:** [Bun](https://bun.sh/) and [Docker](https://www.docker.com/). `bun run setup` is an interactive wizard: it provisions the database, generates secrets, writes your `.env` files, connects a Chat API key, and starts Sim the way you choose: - **Local dev** — run from source to contribute or hack on Sim - **Docker Compose** — a self-contained instance for testing self-hosting - **Kubernetes (Helm)** — deploy to a local cluster When it finishes, open [http://localhost:3000](http://localhost:3000). Manage your install with `bun run sim`: ```bash bun run sim start | stop | restart # bring your install up / down / cycle bun run sim status # what's installed and healthy bun run sim logs # follow logs bun run sim doctor # diagnose configuration problems bun run sim down # remove containers (data kept) bun run sim reset # archive .env and wipe managed data ``` `sim` detects how you're running (Docker Compose, local dev, or Kubernetes) and acts accordingly. Prefer a bare `sim`? Run `bun link` once — but note `sim` lands in `~/.bun/bin`, which Homebrew's bun doesn't add to your PATH, so you may need `export PATH="$HOME/.bun/bin:$PATH"` in your shell profile. Sim also supports local models via [Ollama](https://ollama.ai) and [vLLM](https://docs.vllm.ai/). See the [self-hosting docs](https://docs.sim.ai/self-hosting/docker) for details. ## Chat API Keys Chat is a Sim-managed service. `bun run setup` connects a Chat API key for you — sign in when it opens your browser and the key is stored automatically. To view, create, or revoke keys later, go to [sim.ai/selfhost/settings/chat-keys](https://sim.ai/selfhost/settings/chat-keys). ## Environment Variables See the [environment variables reference](https://docs.sim.ai/self-hosting/environment-variables) for the full list, or [`apps/sim/.env.example`](apps/sim/.env.example) for defaults. ## Tech Stack
Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack - **Framework**: [Next.js](https://nextjs.org/) (App Router) - **Runtime**: [Bun](https://bun.sh/) - **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team) - **Authentication**: [Better Auth](https://better-auth.com) - **Schema Validation**: [Zod](https://zod.dev) - **UI**: [Shadcn](https://ui.shadcn.com/), [Tailwind CSS](https://tailwindcss.com) - **Streaming Markdown**: [Streamdown](https://github.com/vercel/streamdown) - **State Management**: [Zustand](https://zustand-demo.pmnd.rs/), [TanStack Query](https://tanstack.com/query) - **Flow Editor**: [ReactFlow](https://reactflow.dev/) - **Docs**: [Fumadocs](https://fumadocs.vercel.app/) - **Monorepo**: [Turborepo](https://turborepo.org/) - **Realtime**: [Socket.io](https://socket.io/) - **Background Jobs**: [Trigger.dev](https://trigger.dev/) - **Remote Code Execution**: [E2B](https://www.e2b.dev/) - **Isolated Code Execution**: [isolated-vm](https://github.com/laverdet/isolated-vm)
## Contributing We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details. ## License This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

Built by the Sim team in San Francisco