|
1 | | -<p align="center"> |
2 | | - <a href="https://sim.ai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Sim-sim.ai-3B3B3B?labelColor=1A1A1A" alt="Sim.ai"></a> |
3 | | - <a href="https://docs.sim.ai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Docs-Read-E6E6E6?labelColor=C3C3C3&color=E6E6E6" alt="Documentation"></a> |
4 | | - <a href="https://join.slack.com/t/sim-ott9864/shared_invite/zt-43lp8tc5v-0qrrqHGBKUsvQlpoouH~TA" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Slack-Join-E6E6E6?logo=slack&logoColor=1A1A1A&labelColor=C3C3C3&color=E6E6E6" alt="Slack"></a> |
5 | | - <a href="https://x.com/simdotai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/X-%40simdotai-525252?logo=x&logoColor=white&labelColor=1A1A1A" alt="X"></a> |
6 | | -</p> |
7 | | - |
8 | | -<p align="center"> |
9 | | - <a href="https://deepwiki.com/simstudioai/sim" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Ask-DeepWiki-E6E6E6?labelColor=C3C3C3&color=E6E6E6" alt="Ask DeepWiki"></a> |
10 | | - <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.%20Generate%20required%20secrets%20%28the%20stack%20will%20not%20start%20without%20them%29%3A%0A%20%20%20cat%20%3E%20.env%20%3C%3C%20EOF%0A%20%20%20BETTER_AUTH_SECRET%3D%24%28openssl%20rand%20-hex%2032%29%0A%20%20%20ENCRYPTION_KEY%3D%24%28openssl%20rand%20-hex%2032%29%0A%20%20%20INTERNAL_API_SECRET%3D%24%28openssl%20rand%20-hex%2032%29%0A%20%20%20CRON_SECRET%3D%24%28openssl%20rand%20-hex%2032%29%0A%20%20%20POSTGRES_PASSWORD%3D%24%28openssl%20rand%20-hex%2024%29%0A%20%20%20EOF%0A%0A4.%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%20or%203002%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> |
11 | | -</p> |
12 | | - |
13 | | -<p align="center"> |
14 | | - <a href="https://sim.ai" target="_blank" rel="noopener noreferrer"> |
15 | | - <img src="apps/sim/public/static/readme-banner.png" alt="Sim — Integrate, Context, Build, and Monitor AI agents" width="100%"/> |
16 | | - </a> |
17 | | -</p> |
18 | | - |
19 | | -<p align="center">A workspace to build, deploy and manage AI agents and workflows.</p> |
20 | | - |
21 | | -## Quickstart |
22 | | - |
23 | | -### Cloud-hosted: [sim.ai](https://sim.ai) |
24 | | - |
25 | | -<a href="https://sim.ai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Open-sim.ai-3B3B3B?labelColor=1A1A1A" alt="Open sim.ai"></a> |
26 | | - |
27 | | -### Self-hosted |
28 | | - |
29 | | -```bash |
30 | | -npx sim-setup |
31 | | -``` |
32 | | - |
33 | | -### Desktop: [macOS](https://sim.ai/api/desktop/update/download) |
34 | | - |
35 | | -<a href="https://sim.ai/api/desktop/update/download" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Download-macOS-3B3B3B?logo=apple&logoColor=white&labelColor=1A1A1A" alt="Download Sim for macOS"></a> |
36 | | - |
37 | | -macOS 12+, Apple Silicon and Intel. See the [desktop docs](https://docs.sim.ai/desktop) to point it at a self-hosted deployment. |
38 | | - |
39 | | -<p align="center"> |
40 | | - <img src="apps/sim/public/static/readme-platform.png" alt="The Sim platform — chat on the left, the visual workflow builder on the right" width="100%"/> |
41 | | -</p> |
42 | | - |
43 | | -## Capabilities |
44 | | - |
45 | | -- Connect 1,000+ integrations and every major LLM |
46 | | -- Add Slack, Notion, HubSpot, Salesforce, databases, and more |
47 | | -- Build agents visually, conversationally, or with code |
48 | | -- Ingest files, knowledge bases, and structured table data |
49 | | -- Monitor runs, logs, schedules, and workflow activity |
50 | | - |
51 | | -## One workspace, every surface |
52 | | - |
53 | | -<p align="center">Chat and workflows are just the start — tables, files, and knowledge all live in the same workspace, in the browser or on your desktop.</p> |
54 | | - |
55 | | -<table> |
56 | | - <tr> |
57 | | - <td width="50%" valign="top"> |
58 | | - <img src="apps/sim/public/static/readme-tables.png" alt="Tables in Sim — structured data your agents can query" width="100%"/> |
59 | | - <p align="center"><b>Tables</b> — a database, built in</p> |
60 | | - </td> |
61 | | - <td width="50%" valign="top"> |
62 | | - <img src="apps/sim/public/static/readme-files.png" alt="Files in Sim — documents for your team and every agent" width="100%"/> |
63 | | - <p align="center"><b>Files</b> — one store for your team and every agent</p> |
64 | | - </td> |
65 | | - </tr> |
66 | | - <tr> |
67 | | - <td width="50%" valign="top"> |
68 | | - <img src="apps/sim/public/static/readme-knowledge.png" alt="Knowledge bases in Sim — synced docs your agents can search" width="100%"/> |
69 | | - <p align="center"><b>Knowledge</b> — your agents' memory</p> |
70 | | - </td> |
71 | | - <td width="50%" valign="top"> |
72 | | - <img src="apps/sim/public/static/readme-desktop.png" alt="Sim Desktop — Chat on the left, the built-in browser on the right" width="100%"/> |
73 | | - <p align="center"><b>Desktop</b> — Sim on your Mac, browser and terminal included</p> |
74 | | - </td> |
75 | | - </tr> |
76 | | -</table> |
77 | | - |
78 | | -## Self-hosting |
79 | | - |
80 | | -**Requirements:** [Node.js 20+](https://nodejs.org/) and [Docker](https://www.docker.com/). |
81 | | - |
82 | | -`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. |
83 | | - |
84 | | -When it finishes, open [http://localhost:3000](http://localhost:3000). |
85 | | - |
86 | | -Inside a cloned Sim repository, run `bun run sim-setup` to unlock the source-only local development and Kubernetes modes. |
87 | | - |
88 | | -Reconfigure an optional capability without rerunning the full wizard: |
89 | | - |
90 | | -```bash |
91 | | -npx sim-setup config |
92 | | -npx sim-setup add email |
93 | | -npx sim-setup add storage |
94 | | -npx sim-setup add sandbox |
95 | | -npx sim-setup add jobs |
96 | | -npx sim-setup add cache |
97 | | -npx sim-setup add knowledge |
98 | | -npx sim-setup add chat |
99 | | -npx sim-setup add llm |
100 | | -npx sim-setup add integration slack |
101 | | -``` |
102 | | - |
103 | | -`npx sim-setup config` detects the effective local-dev, Docker Compose, or current-context |
104 | | -Helm configuration and reports configured, missing, or invalid capabilities and OAuth |
105 | | -integrations without printing credential values. This is separate from `npx sim-setup status`, |
106 | | -which reports whether installed services are running and healthy. |
107 | | - |
108 | | -Manage your install from its directory: |
109 | | - |
110 | | -```bash |
111 | | -npx sim-setup start | stop | restart # bring your install up / down / cycle |
112 | | -npx sim-setup update # pull and apply Compose images |
113 | | -npx sim-setup status # what's installed and healthy |
114 | | -npx sim-setup logs # follow logs |
115 | | -npx sim-setup doctor # diagnose configuration problems |
116 | | -npx sim-setup down # remove containers (data kept) |
117 | | -npx sim-setup reset # archive .env and wipe managed data |
118 | | -``` |
119 | | - |
120 | | -The setup package detects how you're running and acts accordingly. Use `--dir <path>` to create or manage a deployment somewhere other than `./sim`. |
121 | | - |
122 | | -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. |
123 | | - |
124 | | -## Chat API Keys |
125 | | - |
126 | | -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](https://sim.ai/selfhost/settings/chat-keys). |
127 | | - |
128 | | -## Environment Variables |
129 | | - |
130 | | -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. |
131 | | - |
132 | | -## Tech Stack |
133 | | - |
134 | | -<details> |
135 | | -<summary>Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack</summary> |
136 | | - |
137 | | -- **Framework**: [Next.js](https://nextjs.org/) (App Router) |
138 | | -- **Runtime**: [Bun](https://bun.sh/) |
139 | | -- **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team) |
140 | | -- **Authentication**: [Better Auth](https://better-auth.com) |
141 | | -- **Schema Validation**: [Zod](https://zod.dev) |
142 | | -- **UI**: [Shadcn](https://ui.shadcn.com/), [Tailwind CSS](https://tailwindcss.com) |
143 | | -- **Streaming Markdown**: [Streamdown](https://github.com/vercel/streamdown) |
144 | | -- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/), [TanStack Query](https://tanstack.com/query) |
145 | | -- **Flow Editor**: [ReactFlow](https://reactflow.dev/) |
146 | | -- **Docs**: [Fumadocs](https://fumadocs.vercel.app/) |
147 | | -- **Monorepo**: [Turborepo](https://turborepo.org/) |
148 | | -- **Realtime**: [Socket.io](https://socket.io/) |
149 | | -- **Background Jobs**: [Trigger.dev](https://trigger.dev/) |
150 | | -- **Remote Code Execution**: [E2B](https://www.e2b.dev/) |
151 | | -- **Isolated Code Execution**: [isolated-vm](https://github.com/laverdet/isolated-vm) |
152 | | - |
153 | | -</details> |
154 | | - |
155 | | -## Contributing |
156 | | - |
157 | | -We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details. |
158 | | - |
159 | | -## License |
160 | | - |
161 | | -This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. |
162 | | - |
163 | | -<p align="center"> |
164 | | - <img src="apps/sim/public/static/readme-built-by-sim-team.png" alt="Built by the Sim team in San Francisco" width="100%"/> |
165 | | -</p> |
0 commit comments