sim README

The project's README from github.com/simstudioai/sim. As one markdown file: README.md.

Sim.ai Documentation Slack X

Ask DeepWiki Set Up with Cursor

Sim — Integrate, Context, Build, and Monitor AI agents

A workspace to build, deploy and manage AI agents and workflows.

Quickstart

Cloud-hosted: sim.ai

Open sim.ai

Self-hosted

npx sim-setup

Open http://localhost:3000

Desktop: macOS

Download Sim for macOS

macOS 12+, Apple Silicon and Intel. See the desktop docs to point it at a self-hosted deployment.

The Sim platform — chat on the left, the visual workflow builder on the right

Capabilities

One workspace, every surface

Chat and workflows are just the start — tables, files, and knowledge all live in the same workspace, in the browser or on your desktop.

Tables in Sim — structured data your agents can query

Tables — a database, built in

Files in Sim — documents for your team and every agent

Files — one store for your team and every agent

Knowledge bases in Sim — synced docs your agents can search

Knowledge — your agents' memory

Sim Desktop — Chat on the left, the built-in browser on the right

Desktop — Sim on your Mac, browser and terminal included

Self-hosting

Requirements: Node.js 20+ and Docker.

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.

When it finishes, open http://localhost:3000.

Inside a cloned Sim repository, run bun run sim-setup to unlock the source-only local development and Kubernetes modes.

Reconfigure an optional capability without rerunning the full wizard:

npx sim-setup config
npx sim-setup add email
npx sim-setup add storage
npx sim-setup add sandbox
npx sim-setup add jobs
npx sim-setup add cache
npx sim-setup add knowledge
npx sim-setup add chat
npx sim-setup add llm
npx sim-setup add integration slack

npx sim-setup config detects the effective local-dev, Docker Compose, or current-context Helm configuration and reports configured, missing, or invalid capabilities and OAuth integrations without printing credential values. This is separate from npx sim-setup status, which reports whether installed services are running and healthy.

Manage your install from its directory:

npx sim-setup start | stop | restart   # bring your install up / down / cycle
npx sim-setup update                   # pull and apply Compose images
npx sim-setup status                   # what's installed and healthy
npx sim-setup logs                     # follow logs
npx sim-setup doctor                   # diagnose configuration problems
npx sim-setup down                     # remove containers (data kept)
npx sim-setup reset                    # archive .env and wipe managed data

The setup package detects how you're running and acts accordingly. Use --dir <path> to create or manage a deployment somewhere other than ./sim.

Sim also supports local models via Ollama and vLLM. See the self-hosting docs for details.

Chat API Keys

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.

Environment Variables

See the environment variables reference for the full list, or apps/sim/.env.example for defaults.

Tech Stack

Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Built by the Sim team in San Francisco

sim (simstudioai/sim)

Searching Database…

29.8K ·GitHub
Что это такое?Sim — это общее рабочее пространство для создания, развёртывания и мониторинга AI-агентов и рабочих процессов, которым пользуются более 100 000 разработчиков. Агентов можно собирать визуально, в чате или с помощью кода.
Это сайт, десктопное приложение или что-то, что я запускаю сам?И то, и другое, и третье. Есть облачная версия на sim.ai, open-source-развёртывание на своём сервере и десктопное приложение для macOS (12+, Apple Silicon и Intel), которое может работать с вашим собственным self-hosted-инстансом.
Как развернуть его на своём сервере?Установите Node.js 20+ и Docker, затем запустите 'npx sim-setup'. Мастер установки создаст папку sim/, подготовит базу данных, сгенерирует секреты, запишет .env и запустит всё через Docker Compose — клонировать репозиторий не нужно.
Мне нужны платные API-ключи или можно подключить локальные модели?Подходит и то, и другое. Поддерживаются все крупные провайдеры LLM, а при развёртывании на своём сервере можно запускать и локальные модели через Ollama и vLLM.
Если я разверну его у себя, чат всё равно будет работать на серверах Sim?Да — Chat это сервис, управляемый Sim. Мастер установки сам подключит API-ключ для Chat (нужно просто войти в аккаунт, когда он откроет браузер); ключи можно посмотреть, создать или отозвать на sim.ai/selfhost/settings/chat-keys.
С чем агенты могут работать из коробки?Более 1 000 интеграций и все крупные LLM — Slack, Notion, HubSpot, Salesforce, базы данных и не только. Агенты также могут использовать файлы, базы знаний и данные из структурированных таблиц в качестве контекста.
Агент собирается перетаскиванием мышкой или написанием кода?Как вам удобнее: в README перечислены три способа — визуально, в диалоге или с помощью кода. В основе редактора сценариев лежит ReactFlow, поэтому визуальная сборка происходит на холсте с узлами.
Что ещё есть в рабочем пространстве, кроме чата и рабочих процессов?Таблицы (встроенная база данных, общая для вашей команды и всех агентов), Files (единое хранилище для всего) и Knowledge — память ваших агентов. Всё это доступно из браузера или десктопного приложения для Mac.
Могу ли я посмотреть, что сделали мои агенты после запуска?Да — рабочее пространство отслеживает запуски, логи, расписания и активность рабочих процессов, так что наблюдать за поведением и отлаживать можно там же, где вы собираете агентов.
What are similar projects?Flowise, ruflo, LangBot, dify, brigade, trueforge, LibreChat, bytebot
Size
699.7 MB
Stars
29.8K
Age
1y
Commits · 90 Days