Reading the repo

Opening the box…

How to install on Linux

simstudioai/sim

Sim is the collaborative workspace to build, deploy, and monitor AI agents and workflows. Used by 100,000+ builders.

Node.js#agent-workflow#agentic-workflow#agents#ai

Difficulty: Involved
Time: 30 min or more
Stars: ★ 30,050
Activity: Updated this month
License: Apache-2.0
Open issues: 354
Got it running: 2 people
Looked up: 35 min ago

Saved setup from 35 min ago

Start here

Website ↗sim.aiThe project's own site.Docs ↗docs.sim.aiLinked from the README.

Will it work on my device?

Yes, it runs on Linux

Apps are only published for macOS.
You'll build it yourself with Node.js, Bun.
It also needs PostgreSQL running (Docker handles this).

Checking for

macOS Windows Linux

No Linux app in the box

No ready-made Linux app or install command in v0.9.44. There are apps for macOS.

Did you get it running?

No reports for Linux yet.

Still stuck? Ask an AI

Opens a chat with this manual already filled in, for Linux. It uses your own account; gitmanual sends nothing.

Ask Claude Ask ChatGPT

Parts list

1×Node.js 24runtime
1×Bun runtime
1×bun bun@1.4.4package manager
1×PostgreSQL service

10× settings in .env

NODE_ENV
PORT
DATABASE_URL
BETTER_AUTH_URL
BETTER_AUTH_SECRETsecret
INTERNAL_API_SECRETsecret
NEXT_PUBLIC_APP_URL
ENCRYPTION_KEYsecret
API_ENCRYPTION_KEYsecret
CRON_SECRETsecret

Featured in Zain Finds

See the poster ↗Wait... you can build AI agents like a team doc? 😳

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/simstudioai/sim/badge.svg)](https://gitmanual.com/simstudioai/sim)

Good to know

Monorepo (workspaces) — install from the repo root.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: apps/desktop/package.json, apps/docs/package.json, apps/extension/package.json, apps/pii/package.json and 11 more

package.json scripts (126)

buildturbo run build
devturbo run dev
dev:socketscd apps/realtime && bun run dev
dev:fullbunx concurrently -n "App,Realtime" -c "cyan,magenta" "cd apps/sim && bun run dev" "cd apps/realtime && bun run dev"
dev:full:cappedbunx concurrently -n "App,Realtime" -c "cyan,magenta" "cd apps/sim && bun run dev:capped" "cd apps/realtime && bun run dev"
testbun run test:scripts && turbo run test
test:setupbun run --cwd packages/sim-setup test
test:integrationbun --no-env-file scripts/test-integration.ts
test:search-performanceKNOWLEDGE_SEARCH_PERFORMANCE_TEST=true bun --no-env-file scripts/test-integration.ts search-latency
formatbiome format --write scripts && turbo run format
format:checkbiome format scripts && turbo run format:check
lintbiome check --write --unsafe scripts && turbo run lint
lint:checkbiome check scripts && turbo run lint:check
lint:helmhelm lint helm/sim --strict --values helm/sim/ci/default-values.yaml
lint:allbun run lint && bun run lint:helm
checkbun run format:check
check:egress-boundarybun run scripts/check-egress-boundary.ts
check:boundariesbun run scripts/check-monorepo-boundaries.ts
check:api-validationbun run scripts/check-api-validation-contracts.ts --check
check:api-contract-routesbun run scripts/check-api-contract-routes.ts
check:fork-dependent-coveragebun run scripts/check-fork-dependent-coverage.ts
generate:openapibun run scripts/generate-openapi.ts
check:openapibun run scripts/check-openapi.ts
generate:cli-apibun run scripts/generate-v2-cli-api.ts
check:cli-apibun run scripts/generate-v2-cli-api.ts --check

Files we read (12)

.github/CONTRIBUTING.md

.github/workflows/browser-extension.yml

.github/workflows/cache-cleanup.yml

.github/workflows/checks.yml

.github/workflows/ci.yml

.github/workflows/codeql.yml

.github/workflows/companion.yml

README.md

apps/realtime/.env.example

apps/sim/.env.example

package.json

packages/db/.env.example

Branch main · 25,075 files in the repo