1-
2-
3- The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows.
4-
5-
6-
7-
1+ <p align =" center " >
2+ <a href =" https://sim.ai " target =" _blank " rel =" noopener noreferrer " >
3+ <picture>
4+ <source media="(prefers-color-scheme: dark)" srcset="apps/sim/public/logo/wordmark.svg">
5+ <source media="(prefers-color-scheme: light)" srcset="apps/sim/public/logo/wordmark-dark.svg">
6+ <img src="apps/sim/public/logo/wordmark-dark.svg" alt="Sim Logo" width="380"/>
7+ </picture>
8+ </a >
9+ </p >
10+
11+ <p align =" center " >The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows.</p >
12+
13+ <p align =" center " >
14+ <a href =" https://sim.ai " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/badge/sim.ai-33c482 " alt =" Sim.ai " ></a >
15+ <a href =" https://discord.gg/Hr4UWYEcTT " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/badge/Discord-Join%20Server-5865F2?logo=discord&logoColor=white " alt =" Discord " ></a >
16+ <a href =" https://x.com/simdotai " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/twitter/follow/simdotai?style=social " alt =" Twitter " ></a >
17+ <a href =" https://docs.sim.ai " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/badge/Docs-33c482.svg " alt =" Documentation " ></a >
18+ </p >
19+
20+ <p align =" center " >
21+ <a href="https://deepwiki.com/simstudioai/sim" target="_blank" rel="noopener noreferrer"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a> <a href="https://cursor.com/link/prompt?text=Help%20me%20set%20up%20Sim%20locally.%20Follow%20these%20steps%3A%0A%0A1.%20First%2C%20verify%20Docker%20is%20installed%20and%20running%3A%0A%20%20%20docker%20--version%0A%20%20%20docker%20info%0A%0A2.%20Clone%20the%20repository%3A%0A%20%20%20git%20clone%20https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim.git%0A%20%20%20cd%20sim%0A%0A3.%20Start%20the%20services%20with%20Docker%20Compose%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20up%20-d%0A%0A4.%20Wait%20for%20all%20containers%20to%20be%20healthy%20(this%20may%20take%201-2%20minutes)%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.prod.yml%20ps%0A%0A5.%20Verify%20the%20app%20is%20accessible%20at%20http%3A%2F%2Flocalhost%3A3000%0A%0AIf%20there%20are%20any%20errors%2C%20help%20me%20troubleshoot%20them.%20Common%20issues%3A%0A-%20Port%203000%2C%203002%2C%20or%205432%20already%20in%20use%0A-%20Docker%20not%20running%0A-%20Insufficient%20memory%20(needs%2012GB%2B%20RAM)%0A%0AFor%20local%20AI%20models%20with%20Ollama%2C%20use%20this%20instead%20of%20step%203%3A%0A%20%20%20docker%20compose%20-f%20docker-compose.ollama.yml%20--profile%20setup%20up%20-d"><img src="https://img.shields.io/badge/Set%20Up%20with-Cursor-000000?logo=cursor&logoColor=white" alt="Set Up with Cursor"></a>
22+ </p >
823
924### Build Workflows with Ease
10-
1125Design agent workflows visually on a canvas—connect agents, tools, and blocks, then run them instantly.
1226
13-
27+ <p align =" center " >
28+ <img src =" apps/sim/public/static/workflow.gif " alt =" Workflow Builder Demo " width =" 800 " />
29+ </p >
1430
1531### Supercharge with Copilot
16-
1732Leverage Copilot to generate nodes, fix errors, and iterate on flows directly from natural language.
1833
19-
34+ <p align =" center " >
35+ <img src =" apps/sim/public/static/copilot.gif " alt =" Copilot Demo " width =" 800 " />
36+ </p >
2037
2138### Integrate Vector Databases
22-
2339Upload documents to a vector store and let agents answer questions grounded in your specific content.
2440
25-
41+ <p align =" center " >
42+ <img src =" apps/sim/public/static/knowledge.gif " alt =" Knowledge Uploads and Retrieval Demo " width =" 800 " />
43+ </p >
2644
2745## Quickstart
2846
2947### Cloud-hosted: [ sim.ai] ( https://sim.ai )
3048
31-
49+ <a href="https://sim.ai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/sim.ai-33c482?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iNjE2IiBoZWlnaHQ9IjYxNiIgdmlld0JveD0iMCAwIDYxNiA2MTYiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxnIGNsaXAtcGF0aD0idXJsKCNjbGlwMF8xMTU5XzMxMykiPgo8cGF0aCBkPSJNNjE2IDBIMFY2MTZINjE2VjBaIiBmaWxsPSIjMzNjNDgyIi8+CjxwYXRoIGQ9Ik04MyAzNjUuNTY3SDExM0MxMTMgMzczLjgwNSAxMTYgMzgwLjM3MyAxMjIgMzg1LjI3MkMxMjggMzg5Ljk0OCAxMzYuMTExIDM5Mi4yODUgMTQ2LjMzMyAzOTIuMjg1QzE1Ny40NDQgMzkyLjI4NSAxNjYgMzkwLjE3MSAxNzIgMzg1LjkzOUMxNzcuOTk5IDM4MS40ODcgMTgxIDM3NS41ODYgMTgxIDM2OC4yMzlDMTgxIDM2Mi44OTUgMTc5LjMzMyAzNTguNDQyIDE3NiAzNTQuODhDMTcyLjg4OSAzNTEuMzE4IDE2Ny4xMTEgMzQ4LjQyMiAxNTguNjY3IDM0Ni4xOTZMMTMwIDMzOS41MTdDMTE1LjU1NSAzMzUuOTU1IDEwNC43NzggMzMwLjQ5OSA5Ny42NjY1IDMyMy4xNTFDOTAuNzc3NSAzMTUuODA0IDg3LjMzMzQgMzA2LjExOSA4Ny4zMzM0IDI5NC4wOTZDODcuMzMzNCAyODQuMDc2IDg5Ljg4OSAyNzUuMzkyIDk0Ljk5OTYgMjY4LjA0NUMxMDAuMzMzIDI2MC42OTcgMTA3LjU1NSAyNTUuMDIgMTE2LjY2NiAyNTEuMDEyQzEyNiAyNDcuMDA0IDEzNi42NjcgMjQ1IDE0OC42NjYgMjQ1QzE2MC42NjcgMjQ1IDE3MSAyNDcuMTE2IDE3OS42NjcgMjUxLjM0NkMxODguNTU1IDI1NS41NzYgMTk1LjQ0NCAyNjEuNDc3IDIwMC4zMzMgMjY5LjA0N0MyMDUuNDQ0IDI3Ni42MTcgMjA4LjExMSAyODUuNjM0IDIwOC4zMzMgMjk2LjA5OUgxNzguMzMzQzE3OC4xMTEgMjg3LjYzOCAxNzUuMzMzIDI4MS4wNyAxNjkuOTk5IDI3Ni4zOTRDMTY0LjY2NiAyNzEuNzE5IDE1Ny4yMjIgMjY5LjM4MSAxNDcuNjY3IDI2OS4zODFDMTM3Ljg4OSAyNjkuMzgxIDEzMC4zMzMgMjcxLjQ5NiAxMjUgMjc1LjcyNkMxMTkuNjY2IDI3OS45NTcgMTE3IDI4NS43NDYgMTE3IDI5My4wOTNDMTE3IDMwNC4wMDMgMTI1IDMxMS40NjIgMTQxIDMxNS40N0wxNjkuNjY3IDMyMi40ODNDMTgzLjQ0NSAzMjUuNiAxOTMuNzc4IDMzMC43MjIgMjAwLjY2NyAzMzcuODQ3QzIwNy41NTUgMzQ0Ljc0OSAyMTEgMzU0LjIxMiAyMTEgMzY2LjIzNUMyMTEgMzc2LjQ3NyAyMDguMjIyIDM4NS40OTQgMjAyLjY2NiAzOTMuMjg3QzE5Ny4xMTEgNDAwLjg1NyAxODkuNDQ0IDQwNi43NTggMTc5LjY2NyA0MTAuOTg5QzE3MC4xMTEgNDE0Ljk5NiAxNTguNzc4IDQxNyAxNDUuNjY3IDQxN0MxMjYuNTU1IDQxNyAxMTEuMzMzIDQxMi4zMjUgOTkuOTk5NyA0MDIuOTczQzg4LjY2NjggMzkzLjYyMSA4MyAzODEuMTUzIDgzIDM2NS41NjdaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBkPSJNMjMyLjI5MSA0MTNWMjUwLjA4MkMyNDQuNjg0IDI1NC42MTQgMjUwLjE0OCAyNTQuNjE0IDI2My4zNzEgMjUwLjA4MlY0MTNIMjMyLjI5MVpNMjQ3LjUgMjM5LjMxM0MyNDEuOTkgMjM5LjMxMyAyMzcuMTQgMjM3LjMxMyAyMzIuOTUyIDIzMy4zMTZDMjI4Ljk4NCAyMjkuMDk1IDIyNyAyMjQuMjA5IDIyNyAyMTguNjU2QzIyNyAyMTIuODgyIDIyOC45ODQgMjA3Ljk5NSAyMzIuOTUyIDIwMy45OTdDMjM3LjE0IDE5OS45OTkgMjQxLjk5IDE5OCAyNDcuNSAxOThDMjUzLjIzMSAxOTggMjU4LjA4IDE5OS45OTkgMjYyLjA0OSAyMDMuOTk3QzI2Ni4wMTYgMjA3Ljk5NSAyNjggMjEyLjg4MiAyNjggMjE4LjY1NkMyNjggMjI0LjIwOSAyNjYuMDE2IDIyOS4wOTUgMjYyLjA0OSAyMzMuMzE2QzI1OC4wOCAyMzcuMzEzIDI1My4yMzEgMjM5LjMxMyAyNDcuNSAyMzkuMzEzWiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZD0iTTMxOS4zMzMgNDEzSDI4OFYyNDkuNjc2SDMxNlYyNzcuMjMzQzMxOS4zMzMgMjY4LjEwNCAzMjUuNzc4IDI2MC4zNjQgMzM0LjY2NyAyNTQuMzUyQzM0My43NzggMjQ4LjExNyAzNTQuNzc4IDI0NSAzNjcuNjY3IDI0NUMzODIuMTExIDI0NSAzOTQuMTEyIDI0OC44OTcgNDAzLjY2NyAyNTYuNjlDNDEzLjIyMiAyNjQuNDg0IDQxOS40NDQgMjc0LjgzNyA0MjIuMzM0IDI4Ny43NTJINDE2LjY2N0M0MTguODg5IDI3NC44MzcgNDI1IDI2NC40ODQgNDM1IDI1Ni42OUM0NDUgMjQ4Ljg5NyA0NTcuMzM0IDI0NSA0NzIgMjQ1QzQ5MC42NjYgMjQ1IDUwNS4zMzQgMjUwLjQ1NSA1MTYgMjYxLjM2NkM1MjYuNjY3IDI3Mi4yNzYgNTMyIDI4Ny4xOTUgNTMyIDMwNi4xMjFWNDEzSDUwMS4zMzNWMzEzLjgwNEM1MDEuMzMzIDMwMC44ODkgNDk4IDI5MC45ODEgNDkxLjMzMyAyODQuMDc4QzQ4NC44ODkgMjc2Ljk1MiA0NzYuMTExIDI3My4zOSA0NjUgMjczLjM5QzQ1Ny4yMjIgMjczLjM5IDQ1MC4zMzMgMjc1LjE3MSA0NDQuMzM0IDI3OC43MzRDNDM4LjU1NiAyODIuMDc0IDQzNCAyODYuOTcyIDQzMC42NjcgMjkzLjQzQzQyNy4zMzMgMjk5Ljg4NyA0MjUuNjY3IDMwNy40NTcgNDI1LjY2NyAzMTYuMTQxVjQxM0gzOTQuNjY3VjMxMy40NjlDMzk0LjY2NyAzMDAuNTU1IDM5MS40NDUgMjkwLjc1OCAzODUgMjg0LjA3OEMzNzguNTU2IDI3Ny4xNzUgMzY5Ljc3OCAyNzMuNzI0IDM1OC42NjcgMjczLjcyNEMzNTAuODg5IDI3My43MjQgMzQ0IDI3NS41MDUgMzM4IDI3OS4wNjhDMzMyLjIyMiAyODIuNDA4IDMyNy42NjcgMjg3LjMwNyAzMjQuMzMzIDI5My43NjNDMzIxIDI5OS45OTggMzE5LjMzMyAzMDcuNDU3IDMxOS4zMzMgMzE2LjE0MVY0MTNaIiBmaWxsPSJ3aGl0ZSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzExNTlfMzEzIj4KPHJlY3Qgd2lkdGg9IjYxNiIgaGVpZ2h0PSI2MTYiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+&logoColor=white" alt="Sim.ai"></a>
3250
3351### Self-hosted: NPM Package
3452
3553``` bash
3654npx simstudio
3755```
38-
39- → [ http://localhost:3000 ] ( http://localhost:3000 )
56+ → http://localhost:3000
4057
4158#### Note
42-
4359Docker must be installed and running on your machine.
4460
4561#### Options
4662
47-
48- | Flag | Description |
49- | ------------------- | ----------------------------------- |
63+ | Flag | Description |
64+ | ------| -------------|
5065| ` -p, --port <port> ` | Port to run Sim on (default ` 3000 ` ) |
51- | ` --no-pull ` | Skip pulling latest Docker images |
52-
66+ | ` --no-pull ` | Skip pulling latest Docker images |
5367
5468### Self-hosted: Docker Compose
5569
@@ -75,15 +89,15 @@ bun install
7589bun run prepare # Set up pre-commit hooks
7690```
7791
78- 1 . Set up PostgreSQL with pgvector:
92+ 2 . Set up PostgreSQL with pgvector:
7993
8094``` bash
8195docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17
8296```
8397
8498Or install manually via the [ pgvector guide] ( https://github.com/pgvector/pgvector#installation ) .
8599
86- 1 . Configure environment:
100+ 3 . Configure environment:
87101
88102``` bash
89103cp apps/sim/.env.example apps/sim/.env
@@ -96,13 +110,13 @@ cp packages/db/.env.example packages/db/.env
96110# Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"
97111```
98112
99- 1 . Run migrations:
113+ 4 . Run migrations:
100114
101115``` bash
102116cd packages/db && bun run db:migrate
103117```
104118
105- 1 . Start development servers:
119+ 5 . Start development servers:
106120
107121``` bash
108122bun run dev:full # Starts Next.js app and realtime socket server
@@ -114,12 +128,12 @@ Or run separately: `bun run dev` (Next.js) and `cd apps/sim && bun run dev:socke
114128
115129Copilot is a Sim-managed service. To use Copilot on a self-hosted instance:
116130
117- - Go to [ https://sim.ai ] ( https://sim.ai ) → Settings → Copilot and generate a Copilot API key
131+ - Go to https://sim.ai → Settings → Copilot and generate a Copilot API key
118132- Set ` COPILOT_API_KEY ` environment variable in your self-hosted apps/sim/.env file to that value
119133
120134## Environment Variables
121135
122- 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.
136+ 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.
123137
124138## Tech Stack
125139
@@ -146,4 +160,4 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI
146160
147161This project is licensed under the Apache License 2.0 - see the [ LICENSE] ( LICENSE ) file for details.
148162
149- Made with ❤️ by the Sim Team
163+ < p align = " center " > Made with ❤️ by the Sim Team</ p >
0 commit comments