You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<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-E6E6E6?logo=cursor&logoColor=1A1A1A&labelColor=C3C3C3&color=E6E6E6" alt="Set Up with Cursor"></a>
<palign="center">The open-source AI workspace where teams build, deploy, and manage AI agents. Build conversationally, visually, or with code. Connect 1,000+ integrations and every major LLM to automate real work.</p>
<imgsrc="apps/sim/public/static/readme-platform-banner.png"alt="A workspace to build, deploy and manage AI agents and workflows"width="800"/>
18
27
</p>
19
28
20
-
<palign="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>
29
+
<palign="center">A workspace to build, deploy and manage AI agents and workflows.</p>
23
30
24
-
### Build everything in Chat
25
-
Your AI command center. Describe what you want in plain language. Sim knows your entire workspace and takes action: building agents, running them, querying data, and more.
31
+
## Quickstart
26
32
27
-
<palign="center">
28
-
<imgsrc="apps/sim/public/static/mothership.gif"alt="Sim building and running an agent from chat"width="800"/>
29
-
</p>
33
+
### Cloud-hosted: [sim.ai](https://sim.ai)
30
34
31
-
### Create files and documents
32
-
Generate documents, reports, and presentations from a single prompt, grounded in your workspace data.
<imgsrc="apps/sim/public/static/files.gif"alt="Sim generating a document from a prompt"width="800"/>
36
-
</p>
37
+
### Self-hosted
37
38
38
-
### Ground agents in your knowledge
39
-
Upload documents to a knowledge base and let agents answer questions from your own content.
39
+
```bash
40
+
npx simstudio
41
+
```
40
42
41
-
<palign="center">
42
-
<imgsrc="apps/sim/public/static/knowledge.gif"alt="Creating a knowledge base"width="460"/>
43
-
</p>
43
+
Open [http://localhost:3000](http://localhost:3000)
44
44
45
-
### Structured data with Tables
46
-
A database, built in. Store, query, and wire structured data into agent runs.
45
+
Docker must be installed and running. Use `-p, --port <port>` to run Sim on a different port, or `--no-pull` to skip pulling the latest Docker images.
47
46
48
47
<palign="center">
49
-
<imgsrc="apps/sim/public/static/tables.png"alt="Tables view with typed columns"width="800"/>
48
+
<imgsrc="apps/sim/public/static/readme-feature-row.svg"alt="Integrate, Ingest, Build, and Monitor"width="800"/>
50
49
</p>
51
50
52
-
### Build visually with Workflows
53
-
Prefer a canvas? Design agents block by block in the visual builder, and let Sim generate blocks, wire variables, and fix errors from natural language.
<imgsrc="apps/sim/public/static/readme-tour.gif"alt="A tour of Sim: start a chat to build an agent, connect Slack and other integrations, add a knowledge base, build the workflow visually, deploy it, and monitor runs in the logs"width="800"/>
@@ -90,7 +73,7 @@ Open [http://localhost:3000](http://localhost:3000)
90
73
91
74
Sim also supports local models via [Ollama](https://ollama.ai) and [vLLM](https://docs.vllm.ai/). See the [Docker self-hosting docs](https://docs.sim.ai/self-hosting/docker) for setup details.
92
75
93
-
### Self-hosted: Manual Setup
76
+
### Manual Setup
94
77
95
78
**Requirements:**[Bun](https://bun.sh/), [Node.js](https://nodejs.org/) v20+, PostgreSQL 12+ with [pgvector](https://github.com/pgvector/pgvector)
96
79
@@ -175,4 +158,6 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI
175
158
176
159
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
177
160
178
-
<palign="center">Made with ❤️ by the Sim Team</p>
161
+
<palign="center">
162
+
<imgsrc="apps/sim/public/static/readme-built-by-sim-team.png"alt="Built by the Sim team in San Francisco"width="800"/>
0 commit comments