11<p align =" center " >
2- <img src =" apps/sim/public/static/sim.png " alt =" Sim Logo " width =" 500 " />
2+ <a href =" https://sim.ai " target =" _blank " rel =" noopener noreferrer " >
3+ <img src="apps/sim/public/logo/reverse/text/large.png" alt="Sim Logo" width="500"/>
4+ </a >
35</p >
46
5- <p align =" center " >
6- <a href =" https://www.apache.org/licenses/LICENSE-2.0 " ><img src =" https://img.shields.io/badge/License-Apache%202.0-blue.svg " alt =" License: Apache-2.0 " ></a >
7- <a href =" https://discord.gg/Hr4UWYEcTT " ><img src =" https://img.shields.io/badge/Discord-Join%20Server-7289DA?logo=discord&logoColor=white " alt =" Discord " ></a >
8- <a href =" https://x.com/simdotai " ><img src =" https://img.shields.io/twitter/follow/simstudioai?style=social " alt =" Twitter " ></a >
9- <a href =" https://github.com/simstudioai/sim/pulls " ><img src =" https://img.shields.io/badge/PRs-welcome-brightgreen.svg " alt =" PRs welcome " ></a >
10- <a href =" https://docs.sim.ai " ><img src =" https://img.shields.io/badge/Docs-visit%20documentation-blue.svg " alt =" Documentation " ></a >
11- </p >
7+ <p align =" center " >Build and deploy AI agent workflows in minutes.</p >
128
139<p align =" center " >
14- <strong >Sim</strong > is a lightweight, user-friendly platform for building AI agent workflows.
10+ <a href =" https://sim.ai " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/badge/sim.ai-6F3DFA " alt =" Sim.ai " ></a >
11+ <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 >
12+ <a href =" https://x.com/simdotai " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/twitter/follow/simstudioai?style=social " alt =" Twitter " ></a >
13+ <a href =" https://docs.sim.ai " target =" _blank " rel =" noopener noreferrer " ><img src =" https://img.shields.io/badge/Docs-6F3DFA.svg " alt =" Documentation " ></a >
1514</p >
1615
1716<p align =" center " >
1817 <img src =" apps/sim/public/static/demo.gif " alt =" Sim Demo " width =" 800 " />
1918</p >
2019
21- ## Getting Started
20+ ## Quickstart
2221
23- 1 . Use our [ cloud-hosted version] ( https://sim.ai )
24- 2 . Self-host using one of the methods below
22+ ### Cloud-hosted: [ sim.ai] ( https://sim.ai )
2523
26- ## Self-Hosting Options
24+ <a href="https://sim.ai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/sim.ai-6F3DFA?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iNjE2IiBoZWlnaHQ9IjYxNiIgdmlld0JveD0iMCAwIDYxNiA2MTYiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxnIGNsaXAtcGF0aD0idXJsKCNjbGlwMF8xMTU5XzMxMykiPgo8cGF0aCBkPSJNNjE2IDBIMFY2MTZINjE2VjBaIiBmaWxsPSIjNkYzREZBIi8+CjxwYXRoIGQ9Ik04MyAzNjUuNTY3SDExM0MxMTMgMzczLjgwNSAxMTYgMzgwLjM3MyAxMjIgMzg1LjI3MkMxMjggMzg5Ljk0OCAxMzYuMTExIDM5Mi4yODUgMTQ2LjMzMyAzOTIuMjg1QzE1Ny40NDQgMzkyLjI4NSAxNjYgMzkwLjE3MSAxNzIgMzg1LjkzOUMxNzcuOTk5IDM4MS40ODcgMTgxIDM3NS41ODYgMTgxIDM2OC4yMzlDMTgxIDM2Mi44OTUgMTc5LjMzMyAzNTguNDQyIDE3NiAzNTQuODhDMTcyLjg4OSAzNTEuMzE4IDE2Ny4xMTEgMzQ4LjQyMiAxNTguNjY3IDM0Ni4xOTZMMTMwIDMzOS41MTdDMTE1LjU1NSAzMzUuOTU1IDEwNC43NzggMzMwLjQ5OSA5Ny42NjY1IDMyMy4xNTFDOTAuNzc3NSAzMTUuODA0IDg3LjMzMzQgMzA2LjExOSA4Ny4zMzM0IDI5NC4wOTZDODcuMzMzNCAyODQuMDc2IDg5Ljg4OSAyNzUuMzkyIDk0Ljk5OTYgMjY4LjA0NUMxMDAuMzMzIDI2MC42OTcgMTA3LjU1NSAyNTUuMDIgMTE2LjY2NiAyNTEuMDEyQzEyNiAyNDcuMDA0IDEzNi42NjcgMjQ1IDE0OC42NjYgMjQ1QzE2MC42NjcgMjQ1IDE3MSAyNDcuMTE2IDE3OS42NjcgMjUxLjM0NkMxODguNTU1IDI1NS41NzYgMTk1LjQ0NCAyNjEuNDc3IDIwMC4zMzMgMjY5LjA0N0MyMDUuNDQ0IDI3Ni42MTcgMjA4LjExMSAyODUuNjM0IDIwOC4zMzMgMjk2LjA5OUgxNzguMzMzQzE3OC4xMTEgMjg3LjYzOCAxNzUuMzMzIDI4MS4wNyAxNjkuOTk5IDI3Ni4zOTRDMTY0LjY2NiAyNzEuNzE5IDE1Ny4yMjIgMjY5LjM4MSAxNDcuNjY3IDI2OS4zODFDMTM3Ljg4OSAyNjkuMzgxIDEzMC4zMzMgMjcxLjQ5NiAxMjUgMjc1LjcyNkMxMTkuNjY2IDI3OS45NTcgMTE3IDI4NS43NDYgMTE3IDI5My4wOTNDMTE3IDMwNC4wMDMgMTI1IDMxMS40NjIgMTQxIDMxNS40N0wxNjkuNjY3IDMyMi40ODNDMTgzLjQ0NSAzMjUuNiAxOTMuNzc4IDMzMC43MjIgMjAwLjY2NyAzMzcuODQ3QzIwNy41NTUgMzQ0Ljc0OSAyMTEgMzU0LjIxMiAyMTEgMzY2LjIzNUMyMTEgMzc2LjQ3NyAyMDguMjIyIDM4NS40OTQgMjAyLjY2NiAzOTMuMjg3QzE5Ny4xMTEgNDAwLjg1NyAxODkuNDQ0IDQwNi43NTggMTc5LjY2NyA0MTAuOTg5QzE3MC4xMTEgNDE0Ljk5NiAxNTguNzc4IDQxNyAxNDUuNjY3IDQxN0MxMjYuNTU1IDQxNyAxMTEuMzMzIDQxMi4zMjUgOTkuOTk5NyA0MDIuOTczQzg4LjY2NjggMzkzLjYyMSA4MyAzODEuMTUzIDgzIDM2NS41NjdaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBkPSJNMjMyLjI5MSA0MTNWMjUwLjA4MkMyNDQuNjg0IDI1NC42MTQgMjUwLjE0OCAyNTQuNjE0IDI2My4zNzEgMjUwLjA4MlY0MTNIMjMyLjI5MVpNMjQ3LjUgMjM5LjMxM0MyNDEuOTkgMjM5LjMxMyAyMzcuMTQgMjM3LjMxMyAyMzIuOTUyIDIzMy4zMTZDMjI4Ljk4NCAyMjkuMDk1IDIyNyAyMjQuMjA5IDIyNyAyMTguNjU2QzIyNyAyMTIuODgyIDIyOC45ODQgMjA3Ljk5NSAyMzIuOTUyIDIwMy45OTdDMjM3LjE0IDE5OS45OTkgMjQxLjk5IDE5OCAyNDcuNSAxOThDMjUzLjIzMSAxOTggMjU4LjA4IDE5OS45OTkgMjYyLjA0OSAyMDMuOTk3QzI2Ni4wMTYgMjA3Ljk5NSAyNjggMjEyLjg4MiAyNjggMjE4LjY1NkMyNjggMjI0LjIwOSAyNjYuMDE2IDIyOS4wOTUgMjYyLjA0OSAyMzMuMzE2QzI1OC4wOCAyMzcuMzEzIDI1My4yMzEgMjM5LjMxMyAyNDcuNSAyMzkuMzEzWiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZD0iTTMxOS4zMzMgNDEzSDI4OFYyNDkuNjc2SDMxNlYyNzcuMjMzQzMxOS4zMzMgMjY4LjEwNCAzMjUuNzc4IDI2MC4zNjQgMzM0LjY2NyAyNTQuMzUyQzM0My43NzggMjQ4LjExNyAzNTQuNzc4IDI0NSAzNjcuNjY3IDI0NUMzODIuMTExIDI0NSAzOTQuMTEyIDI0OC44OTcgNDAzLjY2NyAyNTYuNjlDNDEzLjIyMiAyNjQuNDg0IDQxOS40NDQgMjc0LjgzNyA0MjIuMzM0IDI4Ny43NTJINDE2LjY2N0M0MTguODg5IDI3NC44MzcgNDI1IDI2NC40ODQgNDM1IDI1Ni42OUM0NDUgMjQ4Ljg5NyA0NTcuMzM0IDI0NSA0NzIgMjQ1QzQ5MC42NjYgMjQ1IDUwNS4zMzQgMjUwLjQ1NSA1MTYgMjYxLjM2NkM1MjYuNjY3IDI3Mi4yNzYgNTMyIDI4Ny4xOTUgNTMyIDMwNi4xMjFWNDEzSDUwMS4zMzNWMzEzLjgwNEM1MDEuMzMzIDMwMC44ODkgNDk4IDI5MC45ODEgNDkxLjMzMyAyODQuMDc4QzQ4NC44ODkgMjc2Ljk1MiA0NzYuMTExIDI3My4zOSA0NjUgMjczLjM5QzQ1Ny4yMjIgMjczLjM5IDQ1MC4zMzMgMjc1LjE3MSA0NDQuMzM0IDI3OC43MzRDNDM4LjU1NiAyODIuMDc0IDQzNCAyODYuOTcyIDQzMC42NjcgMjkzLjQzQzQyNy4zMzMgMjk5Ljg4NyA0MjUuNjY3IDMwNy40NTcgNDI1LjY2NyAzMTYuMTQxVjQxM0gzOTQuNjY3VjMxMy40NjlDMzk0LjY2NyAzMDAuNTU1IDM5MS40NDUgMjkwLjc1OCAzODUgMjg0LjA3OEMzNzguNTU2IDI3Ny4xNzUgMzY5Ljc3OCAyNzMuNzI0IDM1OC42NjcgMjczLjcyNEMzNTAuODg5IDI3My43MjQgMzQ0IDI3NS41MDUgMzM4IDI3OS4wNjhDMzMyLjIyMiAyODIuNDA4IDMyNy42NjcgMjg3LjMwNyAzMjQuMzMzIDI5My43NjNDMzIxIDI5OS45OTggMzE5LjMzMyAzMDcuNDU3IDMxOS4zMzMgMzE2LjE0MVY0MTNaIiBmaWxsPSJ3aGl0ZSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzExNTlfMzEzIj4KPHJlY3Qgd2lkdGg9IjYxNiIgaGVpZ2h0PSI2MTYiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+Cg==&logoColor=white" alt="Sim.ai"></a>
2725
28- ### Option 1: NPM Package (Simplest)
29-
30- The easiest way to run Sim locally is using our [ NPM package] ( https://www.npmjs.com/package/simstudio?activeTab=readme ) :
26+ ### Self-hosted: NPM Package
3127
3228``` bash
3329npx simstudio
3430```
31+ → http://localhost:3000
3532
36- After running these commands, open [ http://localhost:3000/ ] ( http://localhost:3000/ ) in your browser.
33+ #### Note
34+ Docker must be installed and running on your machine.
3735
3836#### Options
3937
40- - ` -p, --port <port> ` : Specify the port to run Sim on (default: 3000)
41- - ` --no-pull ` : Skip pulling the latest Docker images
42-
43- #### Requirements
38+ | Flag | Description |
39+ | ------ | ------------- |
40+ | ` -p, --port <port> ` | Port to run Sim on (default ` 3000 ` ) |
41+ | ` --no-pull ` | Skip pulling latest Docker images |
4442
45- - Docker must be installed and running on your machine
46-
47- ### Option 2: Docker Compose
43+ ### Self-hosted: Docker Compose
4844
4945``` bash
5046# Clone the repository
@@ -76,14 +72,14 @@ Wait for the model to download, then visit [http://localhost:3000](http://localh
7672docker compose -f docker-compose.ollama.yml exec ollama ollama pull llama3.1:8b
7773```
7874
79- ### Option 3 : Dev Containers
75+ ### Self-hosted : Dev Containers
8076
81771 . Open VS Code with the [ Remote - Containers extension] ( https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers )
82782 . Open the project and click "Reopen in Container" when prompted
83793 . Run ` bun run dev:full ` in the terminal or use the ` sim-start ` alias
8480 - This starts both the main application and the realtime socket server
8581
86- ### Option 4 : Manual Setup
82+ ### Self-hosted : Manual Setup
8783
8884** Requirements:**
8985- [ Bun] ( https://bun.sh/ ) runtime
@@ -158,6 +154,13 @@ cd apps/sim
158154bun run dev:sockets
159155```
160156
157+ ## Copilot API Keys
158+
159+ Copilot is a Sim-managed service. To use Copilot on a self-hosted instance:
160+
161+ - Go to https://sim.ai → Settings → Copilot and generate a Copilot API key
162+ - Set ` COPILOT_API_KEY ` in your self-hosted environment to that value
163+
161164## Tech Stack
162165
163166- ** Framework** : [ Next.js] ( https://nextjs.org/ ) (App Router)
@@ -180,4 +183,4 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI
180183
181184This project is licensed under the Apache License 2.0 - see the [ LICENSE] ( LICENSE ) file for details.
182185
183- <p align =" center " >Made with ❤️ by the Sim Team</p >
186+ <p align =" center " >Made with ❤️ by the Sim Team</p >
0 commit comments