sim README

The project's README from github.com/simstudioai/sim. As one markdown file: README.md.

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

Open sim.ai

Self-hosted

npx sim-setup

Open http://localhost:3000

Desktop: macOS

Download Sim for macOS

macOS 12+, Apple Silicon and Intel. See the desktop docs to point it at a self-hosted deployment.

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

Capabilities

One workspace, every surface

Chat and workflows are just the start — tables, files, and knowledge all live in the same workspace, in the browser or on your desktop.

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

Sim Desktop — Chat on the left, the built-in browser on the right

Desktop — Sim on your Mac, browser and terminal included

Self-hosting

Requirements: Node.js 20+ and Docker.

npx sim-setup is an interactive wizard that creates a small sim/ deployment directory, provisions the database, generates secrets, writes .env, connects a Chat API key, and starts the published Sim images with Docker Compose. It does not clone the repository.

When it finishes, open http://localhost:3000.

Inside a cloned Sim repository, run bun run sim-setup to unlock the source-only local development and Kubernetes modes.

Reconfigure an optional capability without rerunning the full wizard:

npx sim-setup config
npx sim-setup add email
npx sim-setup add storage
npx sim-setup add sandbox
npx sim-setup add jobs
npx sim-setup add cache
npx sim-setup add knowledge
npx sim-setup add chat
npx sim-setup add llm
npx sim-setup add integration slack

npx sim-setup config detects the effective local-dev, Docker Compose, or current-context Helm configuration and reports configured, missing, or invalid capabilities and OAuth integrations without printing credential values. This is separate from npx sim-setup status, which reports whether installed services are running and healthy.

Manage your install from its directory:

npx sim-setup start | stop | restart   # bring your install up / down / cycle
npx sim-setup update                   # pull and apply Compose images
npx sim-setup status                   # what's installed and healthy
npx sim-setup logs                     # follow logs
npx sim-setup doctor                   # diagnose configuration problems
npx sim-setup down                     # remove containers (data kept)
npx sim-setup reset                    # archive .env and wipe managed data

The setup package detects how you're running and acts accordingly. Use --dir <path> to create or manage a deployment somewhere other than ./sim.

Sim also supports local models via Ollama and vLLM. See the self-hosting docs for details.

Chat API Keys

Chat is a Sim-managed service. npx sim-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.

Environment Variables

See the environment variables reference for the full list, or apps/sim/.env.example for defaults.

Tech Stack

Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack

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.

Built by the Sim team in San Francisco

sim (simstudioai/sim)

Searching Database…

29.8K ·GitHub
What is this?Sim is a collaborative workspace for building, deploying, and monitoring AI agents and workflows, used by 100,000+ builders. Agents can be built visually, in chat, or with code.
Is it a hosted website, a desktop app, or something I run myself?All three. There's a cloud version at sim.ai, an open-source self-hosted deployment, and a macOS desktop app (12+, Apple Silicon and Intel) that can point at your own self-hosted instance.
How do I self-host it?Install Node.js 20+ and Docker, then run 'npx sim-setup'. The wizard creates a sim/ directory, provisions the database, generates secrets, writes .env, and starts everything with Docker Compose — no repo clone needed.
Do I need paid API keys, or can I plug in local models?Both work. Major LLM providers are supported, and self-hosted installs can also run local models via Ollama and vLLM.
If I self-host, does chat still run on Sim's servers?Yes — Chat is a Sim-managed service. The wizard connects a Chat API key for you (just sign in when it opens the browser); keys can be viewed, created, or revoked at sim.ai/selfhost/settings/chat-keys.
What can agents connect to out of the box?Over 1,000 integrations and every major LLM — Slack, Notion, HubSpot, Salesforce, databases, and more. Agents can also ingest files, knowledge bases, and structured table data as context.
Is building an agent drag-and-drop or coding?Your choice: the README lists three ways — visually, conversationally, or with code. The flow editor underneath is ReactFlow, so visual building happens on a node canvas.
What else is in the workspace besides chat and workflows?Tables (a built-in database shared by your team and every agent), Files (one store for everything), and Knowledge — your agents' memory. All of it is reachable from the browser or the Mac desktop app.
Can I see what my agents did after a run?Yes — the workspace monitors runs, logs, schedules, and workflow activity, so you can watch behavior and debug from the same place you build.
What are similar projects?Flowise, ruflo, dify, LangBot, brigade, trueforge, LibreChat, bytebot
Size
701.4 MB
Stars
29.8K
Age
1y
Commits · 90 Days