用于构建AI智能体并运行智能体团队的开源平台。连接1,000多种集成和大语言模型，以编排智能体工作流。

轻松构建工作流

在画布上以可视化方式设计智能体工作流——连接智能体、工具和模块，然后立即运行。

使用Copilot增强功能

借助Copilot，您可以直接从自然语言生成节点、修复错误并迭代流程。

集成向量数据库

将文档上传到向量存储中，让智能体基于您的特定内容回答问题。

快速入门

云端托管：sim.ai

自行部署：NPM 包

npx simstudio

→ http://localhost:3000

注意事项

您的机器上必须安装并运行 Docker。

选项

标志	描述
-p, --port <端口>	运行 Sim 的端口（默认为 3000）
--no-pull	跳过拉取最新 Docker 镜像

自行部署：Docker Compose

git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d

打开 http://localhost:3000

后台工作进程说明

Docker Compose 堆栈默认会启动一个专用的工作容器。如果未配置 REDIS_URL，该工作进程将启动并记录为空闲状态，不会进行任何队列处理。这是预期行为。基于队列的 API、Webhook 和计划任务执行需要 Redis；未配置 Redis 的安装将继续使用内联执行路径。

Sim 还支持通过 Ollama 和 vLLM 使用本地模型——有关设置详情，请参阅 Docker 自行部署文档。

自行部署：手动设置

要求： Bun、Node.js v20+、PostgreSQL 12+ 及 pgvector

1. 克隆并安装：

git clone https://github.com/simstudioai/sim.git
cd sim
bun install
bun run prepare  # 设置预提交钩子

2. 设置带有 pgvector 的 PostgreSQL：

docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17

或者按照 pgvector 安装指南 手动安装。

3. 配置环境变量：

cp apps/sim/.env.example apps/sim/.env
# 创建您的密钥
perl -i -pe "s/your_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_internal_api_secret/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_api_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
# 数据库迁移配置
cp packages/db/.env.example packages/db/.env
# 编辑两个 .env 文件，设置 DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"

4. 运行数据库迁移：

cd packages/db && bun run db:migrate

5. 启动开发服务器：

bun run dev:full  # 启动 Next.js 应用、实时套接字服务器和 BullMQ 工作进程

如果未配置 REDIS_URL，工作进程将保持空闲状态，执行将继续以内联方式进行。

您也可以分别运行：bun run dev（Next.js）、cd apps/sim && bun run dev:sockets（实时服务）以及 cd apps/sim && bun run worker（BullMQ 工作进程）。

Copilot API 密钥

Copilot 是由 Sim 管理的服务。要在自部署实例中使用 Copilot：

• 访问 https://sim.ai → 设置 → Copilot，生成 Copilot API 密钥
• 将该值设置为您的自部署应用 apps/sim/.env 文件中的 COPILOT_API_KEY 环境变量

环境变量

完整列表请参阅环境变量参考文档，默认配置可查看apps/sim/.env.example。

技术栈

• 框架: Next.js（App Router）
• 运行时: Bun
• 数据库: PostgreSQL 结合 Drizzle ORM
• 认证: Better Auth
• UI: Shadcn、Tailwind CSS
• 状态管理: Zustand
• 流程编辑器: ReactFlow
• 文档: Fumadocs
• 单仓库多包管理: Turborepo
• 实时通信: Socket.io
• 后台任务: Trigger.dev
• 远程代码执行: E2B

贡献

我们欢迎各类贡献！详情请参阅我们的贡献指南。

许可证

本项目采用 Apache License 2.0 许可证——详细信息请参阅LICENSE文件。

由 Sim 团队用心打造

Sim 快速上手指南

Sim 是一个开源平台，用于构建 AI 智能体（Agents）并编排代理工作流。它支持可视化画布设计、自然语言辅助开发（Copilot）以及向量数据库集成，可连接 1000+ 种工具和 LLM。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux, macOS, 或 Windows (需安装 WSL2)
• 核心依赖：
  • Docker 和 Docker Compose（推荐方式，必须安装并运行）
  • 或者：Node.js (v20+), Bun, PostgreSQL 12+ (需启用 pgvector 扩展)
• 内存建议：本地运行建议至少 12GB RAM，特别是使用本地 AI 模型时。

安装步骤

您可以选择以下任意一种方式进行安装：

方式一：使用 NPM 快速启动（推荐）

这是最简单的自托管方式，底层会自动调用 Docker。

npx simstudio

启动成功后，访问 http://localhost:3000。

注意：此方法要求本地已安装并运行 Docker。 可选参数：

• -p, --port <port>：指定运行端口（默认 3000）
• --no-pull：跳过拉取最新 Docker 镜像

方式二：使用 Docker Compose

适合需要完全控制容器配置的用户。

git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d

启动后访问 http://localhost:3000。

提示：若需使用本地模型（如 Ollama），请使用 docker-compose.ollama.yml 配置文件。

方式三：手动源码部署（开发者模式）

适合需要修改源码或深度定制的用户。

1. 克隆与安装依赖

   git clone https://github.com/simstudioai/sim.git
   cd sim
   bun install
   bun run prepare
   

2. 设置数据库 (PostgreSQL + pgvector)

   docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17
   

3. 配置环境变量

   cp apps/sim/.env.example apps/sim/.env
   # 生成随机密钥替换占位符
   perl -i -pe "s/your_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
   perl -i -pe "s/your_internal_api_secret/$(openssl rand -hex 32)/" apps/sim/.env
   perl -i -pe "s/your_api_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
   
   # 配置数据库连接
   cp packages/db/.env.example packages/db/.env
   # 请编辑 apps/sim/.env 和 packages/db/.env，将 DATABASE_URL 设置为：
   # DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"
   

4. 执行数据库迁移

   cd packages/db && bun run db:migrate
   

5. 启动开发服务

   bun run dev:full
   

   该命令将同时启动 Next.js 应用、实时 Socket 服务和后台任务队列。

基本使用

安装完成后，打开浏览器访问 http://localhost:3000 即可进入工作台。

1. 构建工作流 (Build Workflows)

• 进入画布界面，从左侧面板拖拽 Agents（智能体）、Tools（工具）或 Blocks（逻辑块）。
• 通过连线将它们连接起来，定义数据流向。
• 点击运行按钮，即时预览工作流效果。

2. 使用 Copilot 辅助开发

• 在画布中激活 Copilot 功能。
• 输入自然语言指令（例如：“创建一个抓取新闻并总结的节点”），AI 将自动生成对应的节点代码或修复流程错误。

3. 集成知识库 (Vector Database)

• 上传文档（PDF, TXT 等）到向量存储区。
• 在工作流中调用知识库节点，让智能体基于您上传的特定内容进行问答。

4. 配置 Copilot API (仅限自托管)

如果您使用的是自托管版本并希望使用 Copilot 功能：

1. 访问 sim.ai -> Settings -> Copilot 生成 API Key。
2. 在本地 .env 文件中设置：

   COPILOT_API_KEY=您的_API_Key