simstudioai--sim/README.md

Note

本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
English · 原始项目 · 上游 README
原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

用于构建、部署和管理 AI 智能体与工作流的工作空间。

快速开始

云端托管：sim.ai

自托管

npx simstudio

打开 http://localhost:3000

必须安装并运行 Docker。使用 -p, --port <port> 在其他端口运行 Sim，或使用 --no-pull 跳过拉取最新 Docker 镜像。

功能特性

• 连接 1,000+ 集成与所有主流 LLM
• 接入 Slack、Notion、HubSpot、Salesforce、数据库等
• 通过可视化界面、对话或代码构建智能体
• 摄取文件、知识库和结构化表格数据
• 监控运行、日志、调度与工作流活动

一个工作空间，覆盖所有场景

聊天和工作流只是开始 — 表格、文件、知识库和定时任务都在同一工作空间中。

Tables — 内置数据库	Files — 团队与各智能体共享的统一存储
Knowledge — 智能体的记忆	Scheduled tasks — 按你的计划运行

自托管

Docker Compose

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

打开 http://localhost:3000

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  # Set up pre-commit hooks

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
# Create your secrets
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
# DB configs for migration
cp packages/db/.env.example packages/db/.env
# Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"

4. 运行迁移：

cd packages/db && bun run db:migrate

5. 启动开发服务器：

bun run dev:full  # Starts Next.js app and realtime socket server

或分别运行：bun run dev（Next.js）和 cd apps/sim && bun run dev:sockets（realtime）。

Chat API 密钥

Chat 是 Sim 托管的服务。在自托管实例上使用 Chat：

• 前往 https://sim.ai → Settings → Chat keys，生成 Chat API 密钥
• 在自托管环境的 apps/sim/.env 文件中将 COPILOT_API_KEY 环境变量设置为该值

环境变量

完整列表见环境变量参考，默认值见 apps/sim/.env.example。

技术栈

Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — 以及技术栈的其他部分

• Framework（框架）: Next.js (App Router)
• Runtime（运行时）: Bun
• Database（数据库）: PostgreSQL with Drizzle ORM
• Authentication（认证）: Better Auth
• Schema Validation（模式验证）: Zod
• UI: Shadcn, Tailwind CSS
• Streaming Markdown（流式 Markdown）: Streamdown
• State Management（状态管理）: Zustand, TanStack Query
• Flow Editor（流程编辑器）: ReactFlow
• Docs（文档）: Fumadocs
• Monorepo（单体仓库）: Turborepo
• Realtime（实时通信）: Socket.io
• Background Jobs（后台任务）: Trigger.dev
• Remote Code Execution（远程代码执行）: E2B
• Isolated Code Execution（隔离代码执行）: isolated-vm

贡献

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

许可证

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