## 新闻
- 📌 **置顶 · 2026-07-15**：StaffDeck 现已开源！欢迎反馈与 Star 支持。
# 💡 关于 StaffDeck
StaffDeck 是一个用于构建和管理数字员工的企业级平台。它帮助专业人士将他们的工作经验、业务流程和决策标准转化为可以持续运行、接管重复性任务，并将个人专业知识保留为可重用、可演进、可追溯的组织资产的数字员工。StaffDeck 由 [ModelBest](https://modelbest.cn/)、[NEU-ModelBest 数据智能联合实验室](https://neuir.github.io/)、[THUNLP](https://nlp.csai.tsinghua.edu.cn/)、[OpenBMB](https://www.openbmb.cn/home) 和 [AI9Stars](https://github.com/AI9Stars) 联合开发，面向希望将 AI 从个人生产力工具提升为组织能力的企业和机构。
## 核心功能
- 🧑💼 **构建和管理数字员工**：将专业经验、流程和决策标准转化为具备职位、员工 ID、能力画像和工作记录的数字员工。支持能力成长、权限隔离、发布和复用。
- 🧩 **状态机驱动的流程技能**：从自然语言生成结构化的 SOP，并利用状态机准确执行复杂流程。支持在多个流程之间实时切换、上下文保留、可视化编辑、版本管理和分支演进。
- 📚 **感知文档结构的知识检索**：跨文档、章节、页面、摘要等层级构建可导航的索引，使数字员工能够先估计信息可能所在的位置，然后逐步定位到原文。支持知识库、定向检索、来源引用和检索调试。
- 🔌 **自主执行与持续改进**：通过 HTTP API、MCP 和定时任务执行真实的业务操作，然后通过长期记忆、完整 trace、人工接管、用户反馈和反馈分析形成闭环改进。
## 桌面版下载
访问 [StaffDeck 官网](https://staffdeck.openbmb.cn/) 或直接下载最新的桌面版发布包：
| 平台 | 架构 | 下载 |
| --- | --- | --- |
| macOS | Apple Silicon (arm64) | [下载 `.dmg`](https://github.com/OpenBMB/StaffDeck/releases/latest/download/StaffDeck-macos-arm64.dmg) |
| Windows | x64 | [下载安装程序 `.exe`](https://github.com/OpenBMB/StaffDeck/releases/latest/download/StaffDeck-windows-x64-setup.exe) |
| Linux | x86_64 (Debian/Ubuntu) | [下载 `.deb`](https://github.com/OpenBMB/StaffDeck/releases/latest/download/StaffDeck-linux-x86_64.deb) |
## 对 Agent 友好的快速部署
将以下 prompt 粘贴到 Cursor、Claude Code 或 Codex 中：
```
Read https://raw.githubusercontent.com/OpenBMB/StaffDeck/main/README.md.
Clone the OpenBMB/StaffDeck repository, prepare Python 3.11 and Node.js 20,
create backend/.venv, install the backend and frontend dependencies, copy
backend/.env.example to backend/.env, ask me for the OpenAI-compatible model
endpoint and API key if they are missing, run DETACH=1 scripts/dev_up.sh, and
verify /api/health plus /workspace/gallery before reporting success.
```
## 目录
- [💡 关于 StaffDeck](#-about-staffdeck)
- [核心功能](#core-features)
- [桌面版下载](#desktop-downloads)
- [对 Agent 友好的快速部署](#agent-friendly-quick-deploy)
- [目录](#table-of-contents)
- [快速开始](#quick-start)
- [环境要求](#requirements)
- [1. 克隆并安装](#1-clone-and-install)
- [2. 配置模型](#2-configure-a-model)
- [3. 启动 Web Demo](#3-launch-the-web-demo)
- [4. 验证安装](#4-verify-the-installation)
- [常用命令](#useful-commands)
- [核心工作流](#core-workflows)
- [项目结构](#project-structure)
- [常见问题](#faq)
- [路线图](#roadmap)
- [💬 社区](#-community)
- [贡献](#contributing)
- [风险与限制](#risks-and-limitations)
- [引用](#citation)
- [许可证](#license)
- [致谢](#acknowledgments)
## 快速开始
### 环境要求
- 使用开发脚本时需具备 macOS、Linux 或 WSL
- Python **3.11+**
- Node.js **20+** 和 npm
- 一个兼容 OpenAI 的 Chat Completions endpoint 和 API key
- 应用本身不需要 CUDA；硬件要求取决于所选的模型服务
### 1. 克隆并安装
```
git clone https://github.com/OpenBMB/StaffDeck.git
cd StaffDeck
python3 -m venv backend/.venv
backend/.venv/bin/python -m pip install -e "backend[dev]"
npm --prefix frontend-enterprise ci
cp backend/.env.example backend/.env
```
### 2. 配置模型
首次启动前请编辑 `backend/.env`：
```
APP_SECRET="replace-with-a-long-random-secret"
DEMO_MODEL_BASE_URL="https://your-openai-compatible-endpoint/v1"
DEMO_MODEL_NAME="your-model-name"
DEMO_MODEL_API_KEY="your-api-key"
```
API key 用于创建初始模型配置，并在存入数据库前进行加密。请勿提交 `backend/.env`。启动后，也可以从 **管理 → 模型配置** 中管理模型服务。
### 3. 启动 Web Demo
```
DETACH=1 scripts/dev_up.sh
```
该脚本会构建 StaffDeck 前端，并通过一个运行在 `5173` 端口的 FastAPI 进程提供 UI、API 和 Swagger 文档服务。
初始管理员凭据：用户名 `admin`，密码 `admin`。请在首次登录后修改密码。
### 4. 验证安装
```
curl http://127.0.0.1:5173/api/health
```
预期输出：
```
{"status":"ok"}
```
打开 [http://127.0.0.1:5173/workspace/gallery](http://127.0.0.1:5173/workspace/gallery)，选择一个数字员工，并发送第一条消息。答案及其执行记录应流入同一对话轮次。
### 常用命令
```
scripts/dev_status.sh # inspect service status
scripts/dev_down.sh # stop the local service
scripts/dev_up.sh # run in the foreground
```
## 核心工作流
1. **创建数字员工**：定义职位、角色边界、服务风格、创建者和访问范围。
2. **配置员工能力**：从市场复制或创建知识库、通用技能、SOP 和工具，而无需修改市场原件。
3. **开启会话**：从数字员工市场或员工列表进入；正式会话将在发送第一条消息后被持久化。
4. **执行与观察**：在执行记录中检查流式传输的 intent、检索、技能、工具、审查和响应事件。
5. **在必要时介入**：继续处理排队的请求、取消运行、将工作转交给人工，或处理待处理的答案。
6. **持续运营**：通过记忆、反馈、对话日志和定时任务，随着时间的推移提升员工能力。
## 项目结构
```
StaffDeck/
├── backend/ # FastAPI APIs, agent runtime, storage, and task workers
├── frontend-enterprise/ # React/TypeScript StaffDeck workspace
├── docs/ # Tutorials, APIs, schemas, and example flows
├── scripts/ # Single-port service lifecycle and validation scripts
├── packaging/ # macOS, Linux, and Windows packaging assets
├── README.md # English
└── README.zh.md # Simplified Chinese
```
## 常见问题
页面打开了，但数字员工不回答。
请检查选中的模型配置、API key、模型名称和模型服务网络。然后检查执行记录和 `.dev/logs/app.log`，以识别模型服务返回的确切错误。
StaffDeck 可以在没有本地 GPU 的情况下运行吗？
可以。该应用程序调用兼容 OpenAI 的模型 endpoint，因此 GPU 要求取决于您部署或使用的模型服务。
为什么普通用户可以使用市场资源却不能编辑？
市场资源是可重用的模板。普通用户可以复制或授权绑定资源到自己的员工，而原始资源仍受创建者和管理员权限的保护。
## 路线图
- [ ] 群聊、多数字员工通信与任务分工
- [ ] 更多企业连接器和经过审核的市场资源
- [ ] 针对高风险工具操作的细粒度审批策略
路线图优先级由实际部署需求驱动。请提出一个 [Issue](https://github.com/OpenBMB/StaffDeck/issues)，并附上可重现的场景和预期行为。
## 风险与限制
- 模型的回答可能是不正确、不完整或不一致的。执行记录提高了可审计性，但并不保证正确性。
- 知识检索质量取决于源文档质量、解析、索引、权限和模型能力。
- 外部工具和生成的运行程序可能会产生实际的副作用。请使用最小权限凭据，并为高风险操作配置人工审批。
- 定时任务依赖于持续运行的 worker 和正确的用户时区设置。
- 本项目不能替代法律、医疗、金融、安全或其他受监管领域的专业审查。
- 在没有适当授权、隐私保护和人工监督的情况下，请勿使用此平台处理数据或自动执行重要决策。
## 引用
在内部研究或授权的公开材料中使用 StaffDeck 时，请引用：
```
@software{StaffDeck2026,
title = {StaffDeck: Build, Run, and Govern Enterprise Digital Employees},
author = {OpenBMB},
year = {2026},
url = {https://github.com/OpenBMB/StaffDeck}
}
```
## 许可证
本项目基于 GNU Affero General Public License v3.0 开源。
## 致谢
StaffDeck 由 [OpenBMB](https://www.openbmb.cn/) 生态系统孵化。
