From ec0661d4d358d29d270dc91747660732ba8ed67d Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:31:08 +0000 Subject: [PATCH] docs: make Chinese README the default --- README.md | 139 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 73 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 40118f75..80d4cf14 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,85 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/simstudioai/sim) · [上游 README](https://github.com/simstudioai/sim/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

Sim.ai - Documentation + 文档 Discord X

Ask DeepWiki - Set Up with Cursor + 使用 Cursor 配置

- Sim — Integrate, Context, Build, and Monitor AI agents + Sim — 集成、上下文、构建并监控 AI 智能体

-

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

+

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

-## Quickstart +## 快速开始 -### Cloud-hosted: [sim.ai](https://sim.ai) +### 云端托管：[sim.ai](https://sim.ai) -Open sim.ai +打开 sim.ai -### Self-hosted +### 自托管 ```bash npx simstudio ``` -Open [http://localhost:3000](http://localhost:3000) +打开 [http://localhost:3000](http://localhost:3000) -Docker must be installed and running. Use `-p, --port ` to run Sim on a different port, or `--no-pull` to skip pulling the latest Docker images. +必须安装并运行 Docker。使用 `-p, --port ` 在其他端口运行 Sim，或使用 `--no-pull` 跳过拉取最新 Docker 镜像。

- The Sim platform — chat on the left, the visual workflow builder on the right + Sim 平台 — 左侧为聊天，右侧为可视化工作流构建器

-## Capabilities +## 功能特性 -- Connect 1,000+ integrations and every major LLM -- Add Slack, Notion, HubSpot, Salesforce, databases, and more -- Build agents visually, conversationally, or with code -- Ingest files, knowledge bases, and structured table data -- Monitor runs, logs, schedules, and workflow activity +- 连接 1,000+ 集成与所有主流 LLM +- 接入 Slack、Notion、HubSpot、Salesforce、数据库等 +- 通过可视化界面、对话或代码构建智能体 +- 摄取文件、知识库和结构化表格数据 +- 监控运行、日志、调度与工作流活动 -## One workspace, every surface +## 一个工作空间，覆盖所有场景 -

Chat and workflows are just the start — tables, files, knowledge, and scheduled tasks all live in the same workspace.

+

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

- Tables in Sim — structured data your agents can query -

Tables — a database, built in

+ Sim 中的表格 — 智能体可查询的结构化数据 +

Tables — 内置数据库

 - Files in Sim — documents for your team and every agent -

Files — one store for your team and every agent

+ Sim 中的文件 — 供团队与各智能体使用的文档 +

Files — 团队与各智能体共享的统一存储
- Knowledge bases in Sim — synced docs your agents can search -

Knowledge — your agents' memory

+ Sim 中的知识库 — 智能体可搜索的同步文档 +

Knowledge — 智能体的记忆

 - Scheduled tasks in Sim — recurring agent runs on a calendar -

Scheduled tasks — runs on your schedule

+ Sim 中的定时任务 — 按日历周期性运行的智能体 +

Scheduled tasks — 按你的计划运行
-## Self-hosting +## 自托管 ### Docker Compose @@ -82,15 +88,15 @@ git clone https://github.com/simstudioai/sim.git && cd sim docker compose -f docker-compose.prod.yml up -d ``` -Open [http://localhost:3000](http://localhost:3000) +打开 [http://localhost:3000](http://localhost:3000) -Sim also supports local models via [Ollama](https://ollama.ai) and [vLLM](https://docs.vllm.ai/). See the [Docker self-hosting docs](https://docs.sim.ai/self-hosting/docker) for setup details. +Sim 还支持通过 [Ollama](https://ollama.ai) 和 [vLLM](https://docs.vllm.ai/). 使用本地模型。详见 [Docker 自托管文档](https://docs.sim.ai/self-hosting/docker) 了解配置详情。 -### Manual Setup +### 手动配置 -**Requirements:** [Bun](https://bun.sh/), [Node.js](https://nodejs.org/) v20+, PostgreSQL 12+ with [pgvector](https://github.com/pgvector/pgvector) +**环境要求：** [Bun](https://bun.sh/), [Node.js](https://nodejs.org/) v20+、PostgreSQL 12+ 及 [pgvector](https://github.com/pgvector/pgvector) -1. Clone and install: +1. 克隆并安装： ```bash git clone https://github.com/simstudioai/sim.git @@ -99,15 +105,15 @@ bun install bun run prepare # Set up pre-commit hooks ``` -2. Set up PostgreSQL with pgvector: +2. 配置带 pgvector 的 PostgreSQL： ```bash docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17 ``` -Or install manually via the [pgvector guide](https://github.com/pgvector/pgvector#installation). +或通过 [pgvector 指南](https://github.com/pgvector/pgvector#installation). 手动安装 -3. Configure environment: +3. 配置环境： ```bash cp apps/sim/.env.example apps/sim/.env @@ -120,62 +126,63 @@ cp packages/db/.env.example packages/db/.env # Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio" ``` -4. Run migrations: +4. 运行迁移： ```bash cd packages/db && bun run db:migrate ``` -5. Start development servers: +5. 启动开发服务器： ```bash bun run dev:full # Starts Next.js app and realtime socket server ``` -Or run separately: `bun run dev` (Next.js) and `cd apps/sim && bun run dev:sockets` (realtime). +或分别运行：`bun run dev`（Next.js）和 `cd apps/sim && bun run dev:sockets`（realtime）。 -## Chat API Keys +## Chat API 密钥 -Chat is a Sim-managed service. To use Chat on a self-hosted instance: +Chat 是 Sim 托管的服务。在自托管实例上使用 Chat： -- Go to https://sim.ai → Settings → Chat keys and generate a Chat API key -- Set `COPILOT_API_KEY` environment variable in your self-hosted apps/sim/.env file to that value +- 前往 https://sim.ai → Settings → Chat keys，生成 Chat API 密钥 +- 在自托管环境的 apps/sim/.env 文件中将 `COPILOT_API_KEY` 环境变量设置为该值 -## Environment Variables +## 环境变量 -See the [environment variables reference](https://docs.sim.ai/self-hosting/environment-variables) for the full list, or [`apps/sim/.env.example`](apps/sim/.env.example) for defaults. +完整列表见[环境变量参考](https://docs.sim.ai/self-hosting/environment-variables)，默认值见 [`apps/sim/.env.example`](apps/sim/.env.example)。 -## Tech Stack +## 技术栈
-Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — and the rest of the stack +Next.js · Bun · PostgreSQL · Drizzle · Better Auth · Tailwind — 以及技术栈的其他部分 -- **Framework**: [Next.js](https://nextjs.org/) (App Router) -- **Runtime**: [Bun](https://bun.sh/) -- **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team) -- **Authentication**: [Better Auth](https://better-auth.com) -- **Schema Validation**: [Zod](https://zod.dev) +- **Framework（框架）**: [Next.js](https://nextjs.org/) (App Router) +- **Runtime（运行时）**: [Bun](https://bun.sh/) +- **Database（数据库）**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team) +- **Authentication（认证）**: [Better Auth](https://better-auth.com) +- **Schema Validation（模式验证）**: [Zod](https://zod.dev) - **UI**: [Shadcn](https://ui.shadcn.com/), [Tailwind CSS](https://tailwindcss.com) -- **Streaming Markdown**: [Streamdown](https://github.com/vercel/streamdown) -- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/), [TanStack Query](https://tanstack.com/query) -- **Flow Editor**: [ReactFlow](https://reactflow.dev/) -- **Docs**: [Fumadocs](https://fumadocs.vercel.app/) -- **Monorepo**: [Turborepo](https://turborepo.org/) -- **Realtime**: [Socket.io](https://socket.io/) -- **Background Jobs**: [Trigger.dev](https://trigger.dev/) -- **Remote Code Execution**: [E2B](https://www.e2b.dev/) -- **Isolated Code Execution**: [isolated-vm](https://github.com/laverdet/isolated-vm) +- **Streaming Markdown（流式 Markdown）**: [Streamdown](https://github.com/vercel/streamdown) +- **State Management（状态管理）**: [Zustand](https://zustand-demo.pmnd.rs/), [TanStack Query](https://tanstack.com/query) +- **Flow Editor（流程编辑器）**: [ReactFlow](https://reactflow.dev/) +- **Docs（文档）**: [Fumadocs](https://fumadocs.vercel.app/) +- **Monorepo（单体仓库）**: [Turborepo](https://turborepo.org/) +- **Realtime（实时通信）**: [Socket.io](https://socket.io/) +- **Background Jobs（后台任务）**: [Trigger.dev](https://trigger.dev/) +- **Remote Code Execution（远程代码执行）**: [E2B](https://www.e2b.dev/) +- **Isolated Code Execution（隔离代码执行）**: [isolated-vm](https://github.com/laverdet/isolated-vm) +
-## Contributing +## 贡献 -We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTING.md) for details. +我们欢迎贡献！详情请参阅我们的[贡献指南](.github/CONTRIBUTING.md)。 -## License +## 许可证 -This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. +本项目采用 Apache License 2.0 许可证 — 详情请参阅 [LICENSE](LICENSE) 文件。

- Built by the Sim team in San Francisco + 由旧金山的 Sim 团队打造