docs: make Chinese README the default
This commit is contained in:
wehub-resource-sync
@@ -1,3 +1,9 @@
|
||||
<!-- WEHUB_ZH_README -->
|
||||
> [!NOTE]
|
||||
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
|
||||
> [English](./README.en.md) · [原始项目](https://github.com/OpenBMB/ChatDev) · [上游 README](https://github.com/OpenBMB/ChatDev/blob/HEAD/README.md)
|
||||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||||
|
||||
# ChatDev 2.0 - DevAll
|
||||
|
||||
<p align="center">
|
||||
@@ -6,315 +12,314 @@
|
||||
|
||||
|
||||
<p align="center">
|
||||
<strong>A Zero-Code Multi-Agent Platform for Developing Everything</strong>
|
||||
<strong>用于开发一切的零代码多智能体平台</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
【<a href="./README.md">English</a> | <a href="./README-zh.md">简体中文</a>】
|
||||
</p>
|
||||
<p align="center">
|
||||
【📚 <a href="#developers">Developers</a> | 👥 <a href="#primary-contributors">Contributors</a>｜⭐️ <a href="https://github.com/OpenBMB/ChatDev/tree/chatdev1.0">ChatDev 1.0 (Legacy)</a>】
|
||||
【📚 <a href="#开发者">开发者</a> | 👥 <a href="#主要贡献者">贡献者</a>｜⭐️ <a href="https://github.com/OpenBMB/ChatDev/tree/chatdev1.0">ChatDev 1.0 (Legacy)</a>】
|
||||
</p>
|
||||
|
||||
## 📖 Overview
|
||||
ChatDev has evolved from a specialized software development multi-agent system into a comprehensive multi-agent orchestration platform.
|
||||
## 📖 概览
|
||||
ChatDev 已从一个专门的软件开发多智能体系统演变为一个全面的多智能体编排平台。
|
||||
|
||||
- <a href="https://github.com/OpenBMB/ChatDev/tree/main">**ChatDev 2.0 (DevAll)**</a> is a **Zero-Code Multi-Agent Platform** for "Developing Everything". It empowers users to rapidly build and execute customized multi-agent systems through simple configuration. No coding is required—users can define agents, workflows, and tasks to orchestrate complex scenarios such as data visualization, 3D generation, and deep research.
|
||||
- <a href="https://github.com/OpenBMB/ChatDev/tree/chatdev1.0">**ChatDev 1.0 (Legacy)**</a> operates as a **Virtual Software Company**. It utilizes various intelligent agents (e.g., CEO, CTO, Programmer) participating in specialized functional seminars to automate the entire software development life cycle—including designing, coding, testing, and documenting. It serves as the foundational paradigm for communicative agent collaboration.
|
||||
- <a href="https://github.com/OpenBMB/ChatDev/tree/main">**ChatDev 2.0 (DevAll)**</a> 是一个用于“开发一切”的**零代码多智能体平台**。它通过简单的配置，赋能用户快速构建并执行定制化的多智能体系统。无需编写代码，用户即可定义智能体、工作流和任务，以编排如数据可视化、3D 生成和深度调研等复杂场景。
|
||||
- <a href="https://github.com/OpenBMB/ChatDev/tree/chatdev1.0">**ChatDev 1.0 (经典版)**</a> 以**虚拟软件公司**模式运行。它通过各种智能体（如 CEO、CTO、程序员）参与专门的功能研讨会，实现整个软件开发生命周期的自动化——包括设计、编码、测试和文档编写。它是沟通型智能体协作的基石范式。
|
||||
|
||||
## 🎉 News
|
||||
• **Jan 07, 2026: 🚀 We are excited to announce the official release of ChatDev 2.0 (DevAll)!** This version introduces a zero-code multi-agent orchestration platform. The classic ChatDev (v1.x) has been moved to the [`chatdev1.0`](https://github.com/OpenBMB/ChatDev/tree/chatdev1.0) branch for maintenance. More details about ChatDev 2.0 can be found on [our official post](https://x.com/OpenBMB/status/2008916790399701335).
|
||||
## 🎉 新闻
|
||||
• **2026年1月7日：🚀 我们非常高兴地宣布 ChatDev 2.0 (DevAll) 正式发布！** 该版本引入了全新的零代码多智能体编排平台。经典的 ChatDev (v1.x) 已移至 [`chatdev1.0`](https://github.com/OpenBMB/ChatDev/tree/chatdev1.0) 分支进行维护。
|
||||
|
||||
<details>
|
||||
<summary>Old News</summary>
|
||||
<summary>历史新闻</summary>
|
||||
|
||||
•Sep 24, 2025: 🎉 Our paper [Multi-Agent Collaboration via Evolving Orchestration](https://arxiv.org/abs/2505.19591) has been accepted to NeurIPS 2025. The implementation is available in the `puppeteer` branch of this repository.
|
||||
•2025年9月24日：🎉 我们的论文 [Multi-Agent Collaboration via Evolving Orchestration](https://arxiv.org/abs/2505.19591) 已被 NeurIPS 2025 接收。其实现可在本仓库的 `puppeteer` 分支中找到。
|
||||
|
||||
•May 26, 2025: 🎉 We propose a novel puppeteer-style paradigm for multi-agent collaboration among large language model based agents. By leveraging a learnable central orchestrator optimized with reinforcement learning, our method dynamically activates and sequences agents to construct efficient, context-aware reasoning paths. This approach not only improves reasoning quality but also reduces computational costs, enabling scalable and adaptable multi-agent cooperation in complex tasks.
|
||||
See our paper in [Multi-Agent Collaboration via Evolving Orchestration](https://arxiv.org/abs/2505.19591).
|
||||
•2025年5月26日：🎉 我们提出了一种新型的“木偶戏”式范式，用于大语言模型智能体之间的多智能体协作。通过利用强化学习优化的可学习中央编排器，我们的方法动态地激活并排列智能体，以构建高效、情境感知的推理路径。这种方法不仅提高了推理质量，还降低了计算成本，使多智能体协作在复杂任务中具有可扩展性和适应性。详见论文：[Multi-Agent Collaboration via Evolving Orchestration](https://arxiv.org/abs/2505.19591)。
|
||||
<p align="center">
|
||||
<img src='./assets/puppeteer.png' width=800>
|
||||
</p>
|
||||
|
||||
•June 25, 2024: 🎉To foster development in LLM-powered multi-agent collaboration🤖🤖 and related fields, the ChatDev team has curated a collection of seminal papers📄 presented in a [open-source](https://github.com/OpenBMB/ChatDev/tree/main/MultiAgentEbook) interactive e-book📚 format. Now you can explore the latest advancements on the [Ebook Website](https://thinkwee.top/multiagent_ebook) and download the [paper list](https://github.com/OpenBMB/ChatDev/blob/main/MultiAgentEbook/papers.csv).
|
||||
•2024年6月25日：🎉 为了促进 LLM 驱动的多智能体协作🤖🤖及相关领域的发展，ChatDev 团队策划了一系列开创性的论文📄，并以[开源](https://github.com/OpenBMB/ChatDev/tree/main/MultiAgentEbook)交互式电子书📚的形式呈现。现在您可以在 [电子书网站](https://thinkwee.top/multiagent_ebook) 探索最新进展，并下载 [论文列表](https://github.com/OpenBMB/ChatDev/blob/main/MultiAgentEbook/papers.csv)。
|
||||
<p align="center">
|
||||
<img src='./assets/ebook.png' width=800>
|
||||
</p>
|
||||
|
||||
•June 12, 2024: We introduced Multi-Agent Collaboration Networks (MacNet) 🎉, which utilize directed acyclic graphs to facilitate effective task-oriented collaboration among agents through linguistic interactions 🤖🤖. MacNet supports co-operation across various topologies and among more than a thousand agents without exceeding context limits. More versatile and scalable, MacNet can be considered as a more advanced version of ChatDev's chain-shaped topology. Our preprint paper is available at [https://arxiv.org/abs/2406.07155](https://arxiv.org/abs/2406.07155). This technique has been incorporated into the [macnet](https://github.com/OpenBMB/ChatDev/tree/macnet) branch, enhancing support for diverse organizational structures and offering richer solutions beyond software development (e.g., logical reasoning, data analysis, story generation, and more).
|
||||
•2024年6月12日：我们推出了多智能体协作网络 (MacNet) 🎉，它利用有向无环图 (DAG) 通过语言交互促进智能体之间有效的面向任务的协作 🤖🤖。MacNet 支持跨各种拓扑结构以及在超过一千个智能体之间进行协作，且不超出上下文限制。MacNet 更加通用和可扩展，可以被视为 ChatDev 链式拓扑的更高级版本。我们的预印本论文可在 [https://arxiv.org/abs/2406.07155](https://arxiv.org/abs/2406.07155) 获取。该技术已整合到 [macnet](https://github.com/OpenBMB/ChatDev/tree/macnet) 分支，增强了对多样化组织结构的支持，并提供了除软件开发之外的更丰富解决方案（例如，逻辑推理、数据分析、故事生成等）。
|
||||
<p align="center">
|
||||
<img src='./assets/macnet.png' width=500>
|
||||
</p>
|
||||
|
||||
• May 07, 2024, we introduced "Iterative Experience Refinement" (IER), a novel method where instructor and assistant agents enhance shortcut-oriented experiences to efficiently adapt to new tasks. This approach encompasses experience acquisition, utilization, propagation and elimination across a series of tasks and making the pricess shorter and efficient. Our preprint paper is available at https://arxiv.org/abs/2405.04219, and this technique will soon be incorporated into ChatDev.
|
||||
• 2024年5月7日，我们推出了“迭代经验提炼”（IER），这是一种新方法，指导者智能体和助手智能体通过增强捷径导向的经验来高效适应新任务。这种方法涵盖了在一系列任务中获取、利用、传播和消除经验的过程，使过程更加简短高效。我们的预印本论文可在 https://arxiv.org/abs/2405.04219 获取，该技术将很快整合到 ChatDev 中。
|
||||
<p align="center">
|
||||
<img src='./assets/ier.png' width=220>
|
||||
</p>
|
||||
|
||||
• January 25, 2024: We have integrated Experiential Co-Learning Module into ChatDev. Please see the [Experiential Co-Learning Guide](wiki.md#co-tracking).
|
||||
• 2024年1月25日：我们已在 ChatDev 中集成了体验式共同学习模块。请参阅 [体验式共同学习指南](wiki.md#co-tracking)。
|
||||
|
||||
• December 28, 2023: We present Experiential Co-Learning, an innovative approach where instructor and assistant agents accumulate shortcut-oriented experiences to effectively solve new tasks, reducing repetitive errors and enhancing efficiency. Check out our preprint paper at https://arxiv.org/abs/2312.17025 and this technique will soon be integrated into ChatDev.
|
||||
• 2023年12月28日：我们提出了体验式共同学习，这是一种创新方法，指导者智能体和助手智能体积累捷径导向的经验，以有效地解决新任务，减少重复错误并提高效率。请查看我们的预印本论文 https://arxiv.org/abs/2312.17025，该技术将很快集成到 ChatDev 中。
|
||||
<p align="center">
|
||||
<img src='./assets/ecl.png' width=860>
|
||||
</p>
|
||||
• November 15, 2023: We launched ChatDev as a SaaS platform that enables software developers and innovative entrepreneurs to build software efficiently at a very low cost and remove the barrier to entry. Try it out at https://chatdev.modelbest.cn/.
|
||||
• 2023年11月15日：我们推出了 ChatDev SaaS 平台，使软件开发人员和创新创业者能够以极低的成本高效构建软件，并消除准入门槛。请访问 https://chatdev.modelbest.cn/ 试用。
|
||||
<p align="center">
|
||||
<img src='./assets/saas.png' width=560>
|
||||
</p>
|
||||
|
||||
• November 2, 2023: ChatDev is now supported with a new feature: incremental development, which allows agents to develop upon existing codes. Try ```--config "incremental" --path "[source_code_directory_path]"``` to start it.
|
||||
• 2023年11月2日：ChatDev 现在支持一项新功能：增量开发，允许智能体在现有代码基础上进行开发。尝试 ```--config "incremental" --path "[source_code_directory_path]"``` 开始使用。
|
||||
<p align="center">
|
||||
<img src='./assets/increment.png' width=700>
|
||||
</p>
|
||||
|
||||
• October 26, 2023: ChatDev is now supported with Docker for safe execution (thanks to contribution from [ManindraDeMel](https://github.com/ManindraDeMel)). Please see [Docker Start Guide](wiki.md#docker-start).
|
||||
• 2023年10月26日：ChatDev 现在支持 Docker 安全运行（感谢 [ManindraDeMel](https://github.com/ManindraDeMel) 的贡献）。请参阅 [Docker 快速开始指南](wiki.md#docker-start)。
|
||||
<p align="center">
|
||||
<img src='./assets/docker.png' width=400>
|
||||
</p>
|
||||
|
||||
• September 25, 2023: The **Git** mode is now available, enabling the programmer <img src='visualizer/static/figures/programmer.png' height=20> to utilize Git for version control. To enable this feature, simply set ``"git_management"`` to ``"True"`` in ``ChatChainConfig.json``. See [guide](wiki.md#git-mode).
|
||||
|
||||
• 2023年9月25日：**Git** 模式现已上线，允许程序员 <img src='visualizer/static/figures/programmer.png' height=20> 利用 Git 进行版本控制。要启用此功能，只需在 ``ChatChainConfig.json`` 中将 ``"git_management"`` 设置为 ``"True"``。参见 [指南](wiki.md#git-mode)。
|
||||
<p align="center">
|
||||
<img src='./assets/github.png' width=600>
|
||||
</p>
|
||||
|
||||
• September 20, 2023: The **Human-Agent-Interaction** mode is now available! You can get involved with the ChatDev team by playing the role of reviewer <img src='visualizer/static/figures/reviewer.png' height=20> and making suggestions to the programmer <img src='visualizer/static/figures/programmer.png' height=20>;
|
||||
try ``python3 run.py --task [description_of_your_idea] --config "Human"``. See [guide](wiki.md#human-agent-interaction) and [example](WareHouse/Gomoku_HumanAgentInteraction_20230920135038).
|
||||
• 2023年9月20日：**人机交互**模式现已上线！您可以通过扮演评论员的角色 <img src='visualizer/static/figures/reviewer.png' height=20> 并向程序员 <img src='visualizer/static/figures/programmer.png' height=20> 提出建议来参与到 ChatDev 团队中；
|
||||
尝试 ``python3 run.py --task [description_of_your_idea] --config "Human"``。参见 [指南](wiki.md#human-agent-interaction) 和 [示例](WareHouse/Gomoku_HumanAgentInteraction_20230920135038)。
|
||||
<p align="center">
|
||||
<img src='./assets/Human_intro.png' width=600>
|
||||
</p>
|
||||
|
||||
• September 1, 2023: The **Art** mode is available now! You can activate the designer agent <img src='visualizer/static/figures/designer.png' height=20> to generate images used in the software;
|
||||
try ``python3 run.py --task [description_of_your_idea] --config "Art"``. See [guide](wiki.md#art) and [example](WareHouse/gomokugameArtExample_THUNLP_20230831122822).
|
||||
|
||||
• August 28, 2023: The system is publicly available.
|
||||
• 2023年9月1日：**艺术**模式现已上线！您可以激活设计师智能体 <img src='visualizer/static/figures/designer.png' height=20> 来生成软件中使用的图像；
|
||||
尝试 ``python3 run.py --task [description_of_your_idea] --config "Art"``。参见 [指南](wiki.md#art) 和 [示例](WareHouse/gomokugameArtExample_THUNLP_20230831122822)。
|
||||
|
||||
• August 17, 2023: The v1.0.0 version was ready for release.
|
||||
• 2023年8月28日：系统公开发布。
|
||||
|
||||
• July 30, 2023: Users can customize ChatChain, Phasea and Role settings. Additionally, both online Log mode and replay
|
||||
mode are now supported.
|
||||
• 2023年8月17日：v1.0.0 版本准备发布。
|
||||
|
||||
• July 16, 2023: The [preprint paper](https://arxiv.org/abs/2307.07924) associated with this project was published.
|
||||
• 2023年7月30日：用户可以自定义 ChatChain、Phase 和 Role 设置。此外，现在已支持在线日志模式和回放模式。
|
||||
|
||||
• June 30, 2023: The initial version of the ChatDev repository was released.
|
||||
• 2023年7月16日：该项目相关的 [预印本论文](https://arxiv.org/abs/2307.07924) 发表。
|
||||
|
||||
• 2023年6月30日：ChatDev 仓库的初始版本发布。
|
||||
</details>
|
||||
|
||||
|
||||
## 🚀 Quick Start
|
||||
## 🚀 快速开始
|
||||
|
||||
### 📋 Prerequisites
|
||||
### 📋 环境要求
|
||||
|
||||
* **OS**: macOS / Linux / WSL / Windows
|
||||
* **操作系统**: macOS / Linux / WSL / Windows
|
||||
* **Python**: 3.12+
|
||||
* **Node.js**: 18+
|
||||
* **Package Manager**: [uv](https://docs.astral.sh/uv/)
|
||||
* **包管理器**: [uv](https://docs.astral.sh/uv/)
|
||||
|
||||
### 📦 Installation
|
||||
### 📦 安装
|
||||
|
||||
1. **Backend Dependencies** (Python managed by `uv`):
|
||||
1. **后端依赖**（由 `uv` 管理 Python）：
|
||||
```bash
|
||||
uv sync
|
||||
```
|
||||
|
||||
2. **Frontend Dependencies** (Vite + Vue 3):
|
||||
2. **前端依赖**（Vite + Vue 3）：
|
||||
```bash
|
||||
cd frontend && npm install
|
||||
```
|
||||
|
||||
### 🔑 Configuration
|
||||
### ⚡️ 运行应用（本地）
|
||||
|
||||
* **Environment Variables**:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
* **Model Keys**: Set `API_KEY` and `BASE_URL` in `.env` for your LLM provider.
|
||||
* **YAML placeholders**: Use `${VAR}`（e.g., `${API_KEY}`）in configuration files to reference these variables.
|
||||
#### 使用 Makefile（推荐）
|
||||
|
||||
### ⚡️ Run the Application
|
||||
|
||||
#### Using Makefile (Recommended)
|
||||
|
||||
**Start both Backend and Frontent**:
|
||||
**同时启动后端与前端**：
|
||||
```bash
|
||||
make dev
|
||||
```
|
||||
|
||||
> Then access the Web Console at **[http://localhost:5173](http://localhost:5173)**.
|
||||
> 然后访问 Web 控制台：**[http://localhost:5173](http://localhost:5173)**。
|
||||
|
||||
#### Manual Commands
|
||||
#### 手动命令
|
||||
|
||||
1. **Start Backend**:
|
||||
1. **启动后端**：
|
||||
```bash
|
||||
# Run from the project root
|
||||
# 从项目根目录运行
|
||||
uv run python server_main.py --port 6400 --reload
|
||||
```
|
||||
> `--reload` watches the server's Python source folders only; agent-generated files under `WareHouse/` no longer trigger restarts. Pass `--reload-dir` or `--reload-exclude` (repeatable) to customise.
|
||||
> `--reload` 仅监听服务端 Python 源代码目录，`WareHouse/` 下的智能体生成文件不会再触发重启。可通过 `--reload-dir` / `--reload-exclude`（可多次指定）自定义。
|
||||
|
||||
2. **Start Frontend**:
|
||||
2. **启动前端**：
|
||||
```bash
|
||||
cd frontend
|
||||
VITE_API_BASE_URL=http://localhost:6400 npm run dev
|
||||
```
|
||||
> Then access the Web Console at **[http://localhost:5173](http://localhost:5173)**.
|
||||
|
||||
|
||||
> **💡 Tip**: If the frontend fails to connect to the backend, the default port `6400` may already be occupied.
|
||||
> Please switch both services to an available port, for example:
|
||||
> 然后访问 Web 控制台：**[http://localhost:5173](http://localhost:5173)**。
|
||||
|
||||
> **💡 提示**：如果前端无法连接后端，可能是默认端口 `6400` 已被占用。
|
||||
> 请将前后端同时切换到一个空闲端口，例如：
|
||||
>
|
||||
> * **Backend**: start with `--port 6401`
|
||||
> * **Frontend**: set `VITE_API_BASE_URL=http://localhost:6401`
|
||||
> * **后端**：启动时指定 `--port 6401`
|
||||
> * **前端**：设置 `VITE_API_BASE_URL=http://localhost:6401`
|
||||
|
||||
#### Utility Commands
|
||||
#### 常用命令
|
||||
|
||||
* **Help command**:
|
||||
* **帮助命令**：
|
||||
```bash
|
||||
make help
|
||||
```
|
||||
|
||||
* **Sync YAML workflows to frontend**:
|
||||
* **同步 YAML 工作流到前端**：
|
||||
```bash
|
||||
make sync
|
||||
```
|
||||
Uploads all workflow files from `yaml_instance/` to the database.
|
||||
将 `yaml_instance/` 中的所有工作流文件上传到数据库。
|
||||
|
||||
* **Validate all YAML workflows**:
|
||||
* **校验所有 YAML 工作流**：
|
||||
```bash
|
||||
make validate-yamls
|
||||
```
|
||||
Checks all YAML files for syntax and schema errors.
|
||||
检查所有 YAML 文件的语法与 schema 错误。
|
||||
|
||||
### 🦞 使用 OpenClaw 运行
|
||||
|
||||
OpenClaw 可以与 ChatDev 集成，通过 **调用已有的 agent 团队**，或在 ChatDev 中 **动态创建新的 agent 团队** 来完成任务。
|
||||
|
||||
开始使用：
|
||||
|
||||
1. 启动 ChatDev 2.0 后端。
|
||||
2. 为你的 OpenClaw 实例安装所需的技能：
|
||||
|
||||
### 🦞 Run with OpenClaw
|
||||
OpenClaw can integrate with ChatDev by invoking existing agent teams or dynamically creating new agent teams within ChatDev.
|
||||
To get started:
|
||||
1. Start the ChatDev 2.0 backend.
|
||||
2. Install the required skills for your OpenClaw instance:
|
||||
```bash
|
||||
clawdhub install chatdev
|
||||
```
|
||||
|
||||
3. Ask your OpenClaw to create a ChatDev workflow. For example:
|
||||
3. 让 OpenClaw 创建一个 ChatDev 工作流。例如：
|
||||
|
||||
* **Automated information collection and content publishing**
|
||||
* **自动化信息收集与内容发布**
|
||||
|
||||
```
|
||||
Create a ChatDev workflow to automatically collect trending information, generate a Xiaohongshu post, and publish it.
|
||||
```
|
||||
```
|
||||
创建一个 ChatDev 工作流，用于自动收集热点信息，生成一篇小红书文案，并发布该内容
|
||||
```
|
||||
|
||||
* **Multi-agent geopolitical simulation**
|
||||
```
|
||||
Create a ChatDev workflow with multiple agents to simulate possible future developments of the Middle East situation.
|
||||
```
|
||||
* **多智能体地缘政治模拟**
|
||||
|
||||
```
|
||||
创建一个 ChatDev 工作流，构建多个 agent，用于模拟中东局势未来可能的发展
|
||||
```
|
||||
|
||||
|
||||
### 🐳 Run with Docker
|
||||
Alternatively, you can run the entire application using Docker Compose. This method simplifies dependency management and provides a consistent environment.
|
||||
### 🐳 使用 Docker 运行
|
||||
你也可以通过 Docker Compose 运行整个应用。该方式可简化依赖管理，并提供一致的运行环境。
|
||||
|
||||
1. **Prerequisites**:
|
||||
* [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed.
|
||||
* Ensure you have a `.env` file in the project root for your API keys.
|
||||
1. **前置条件**：
|
||||
* 已安装 [Docker](https://docs.docker.com/get-docker/) 和 [Docker Compose](https://docs.docker.com/compose/install/)。
|
||||
* 请确保在项目根目录中存在用于配置 API Key 的 `.env` 文件。
|
||||
|
||||
2. **Build and Run**:
|
||||
2. **构建并运行**：
|
||||
```bash
|
||||
# From the project root
|
||||
# 在项目根目录执行
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
3. **Access**:
|
||||
* **Backend**: `http://localhost:6400`
|
||||
* **Frontend**: `http://localhost:5173`
|
||||
3. **访问地址**：
|
||||
* **后端**：`http://localhost:6400`
|
||||
* **前端**：`http://localhost:5173`
|
||||
|
||||
> The services will automatically restart if they crash, and local file changes will be reflected inside the containers for live development.
|
||||
> 服务在异常退出后会自动重启，本地文件的修改会同步映射到容器中，便于实时开发。
|
||||
|
||||
### 🔑 配置
|
||||
|
||||
* **环境变量**：在项目根目录创建一个 `.env` 文件。
|
||||
* **模型密钥**：在 `.env` 中设置 `API_KEY` 和 `BASE_URL` 对应您的 LLM 提供商。
|
||||
* **YAML 占位符**：在配置文件中使用 `${VAR}`（如 `${API_KEY}`）来引用这些变量。
|
||||
|
||||
---
|
||||
|
||||
## 💡 How to Use
|
||||
## 💡 如何使用
|
||||
|
||||
### 🖥️ Web Console
|
||||
### 🖥️ Web 控制台
|
||||
|
||||
The DevAll interface provides a seamless experience for both construction and execution
|
||||
DevAll 界面为构建和执行提供了无缝体验：
|
||||
|
||||
* **Tutorial**: Comprehensive step-by-step guides and documentation integrated directly into the platform to help you get started quickly.
|
||||
* **教程 (Tutorial)**：平台内置了全面的分步指南和文档，帮助您快速上手。
|
||||
<img src="assets/tutorial-en.png"/>
|
||||
|
||||
* **Workflow**: A visual canvas to design your multi-agent systems. Configure node parameters, define context flows, and orchestrate complex agent interactions with drag-and-drop ease.
|
||||
* **工作流 (Workflow)**：可视化画布，用于设计您的多智能体系统。通过轻松的拖拽来配置节点参数、定义上下文流并编排复杂的智能体交互。
|
||||
<img src="assets/workflow.gif"/>
|
||||
|
||||
* **Launch**: Initiate workflows, monitor real-time logs, inspect intermediate artifacts, and provide human-in-the-loop feedback.
|
||||
* **运行 (Launch)**：启动工作流、监控实时日志、检查中间产物，并提供人机协同反馈。
|
||||
<img src="assets/launch.gif"/>
|
||||
|
||||
### 🧰 Python SDK
|
||||
For automation and batch processing, use our lightweight Python SDK to execute workflows programmatically and retrieve results directly.
|
||||
对于自动化和批量处理，使用我们轻量级的 Python SDK 编排任务并直接获取结果。
|
||||
|
||||
```python
|
||||
from runtime.sdk import run_workflow
|
||||
|
||||
# Execute a workflow and get the final node message
|
||||
# 执行工作流并获取最后一条节点消息
|
||||
result = run_workflow(
|
||||
yaml_file="yaml_instance/demo.yaml",
|
||||
task_prompt="Summarize the attached document in one sentence.",
|
||||
task_prompt="用一句话总结附件文档。",
|
||||
attachments=["/path/to/document.pdf"],
|
||||
variables={"API_KEY": "sk-xxxx"} # Override .env variables if needed
|
||||
variables={"API_KEY": "sk-xxxx"} # 如果需要，可覆盖 .env 中的变量
|
||||
)
|
||||
|
||||
if result.final_message:
|
||||
print(f"Output: {result.final_message.text_content()}")
|
||||
```
|
||||
|
||||
**We have released the ChatDev Python SDK (PyPI package `chatdev`)**, so you can also run YAML workflow and multi-agent tasks directly in Python. For installation and version details, see [PyPI: chatdev 0.1.0](https://pypi.org/project/chatdev/0.1.0/).
|
||||
**我们也发布了 ChatDev Python SDK（PyPI 包 `chatdev`）**，便于在 Python 中直接运行 YAML 工作流编排并执行多智能体任务。安装详情与版本说明见 [PyPI：chatdev 0.1.0](https://pypi.org/project/chatdev/0.1.0/)。
|
||||
|
||||
---
|
||||
|
||||
<a id="developers"></a>
|
||||
## ⚙️ For Developers
|
||||
<a id="开发者"></a>
|
||||
## ⚙️ 给开发者
|
||||
|
||||
**For secondary development and extensions, please proceed with this section.**
|
||||
**如果您打算进行二次开发和扩展，请参阅本章节。**
|
||||
|
||||
Extend DevAll with new nodes, providers, and tools.
|
||||
The project is organized into a modular structure:
|
||||
* **Core Systems**: `server/` hosts the FastAPI backend, while `runtime/` manages agent abstraction and tool execution.
|
||||
* **Orchestration**: `workflow/` handles the multi-agent logic, driven by configurations in `entity/`.
|
||||
* **Frontend**: `frontend/` contains the Vue 3 Web Console.
|
||||
* **Extensibility**: `functions/` is the place for custom Python tools.
|
||||
您可以通过扩展节点、Provider 与工具来增强 DevAll。
|
||||
项目采用模块化结构：
|
||||
* **核心系统**：`server/` 承载 FastAPI 后端，`runtime/` 负责智能体抽象与工具执行。
|
||||
* **编排层**：`workflow/` 负责多智能体逻辑，配置位于 `entity/`。
|
||||
* **前端**：`frontend/` 是 Vue 3 Web 控制台。
|
||||
* **可扩展性**：`functions/` 用于自定义 Python 工具。
|
||||
|
||||
Relevant reference documentation:
|
||||
* **Getting Started**: [Start Guide](./docs/user_guide/en/index.md)
|
||||
* **Core Modules**: [Workflow Authoring](./docs/user_guide/en/workflow_authoring.md), [Memory](./docs/user_guide/en/modules/memory.md), and [Tooling](./docs/user_guide/en/modules/tooling/index.md)
|
||||
相关参考文档：
|
||||
* **快速开始**：[Start Guide](./docs/user_guide/zh/index.md)
|
||||
* **核心模块**：[Workflow Authoring](./docs/user_guide/zh/workflow_authoring.md)、[Memory](./docs/user_guide/zh/modules/memory.md) 和 [Tooling](./docs/user_guide/zh/modules/tooling/index.md)
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Featured Workflows
|
||||
We provide robust, out-of-the-box templates for common scenarios. All runnable workflow configs are located in `yaml_instance/`.
|
||||
* **Demos**: Files named `demo_*.yaml` showcase specific features or modules.
|
||||
* **Implementations**: Files named directly (e.g., `ChatDev_v1.yaml`) are full in-house or recreated workflows. As follows:
|
||||
## 🌟 推荐工作流
|
||||
我们为常见场景提供了开箱即用的强大模板。所有可运行的工作流配置均位于 `yaml_instance/` 目录下。
|
||||
* **示例 (Demos)**：以 `demo_*.yaml` 命名的文件展示了特定功能或模块。
|
||||
* **实现 (Implementations)**：直接命名的文件（如 `ChatDev_v1.yaml`）是完整的自研或复刻流程。如下所示：
|
||||
|
||||
### 📋 Workflow Collection
|
||||
### 📋 工作流合集
|
||||
|
||||
| Category | Workflow | Case |
|
||||
| 类别 | 工作流 | 案例 |
|
||||
| :--- |:------------------------------------------------------------------------------------------------------------| :--- |
|
||||
| **📈 Data Visualization** | `data_visualization_basic.yaml`<br>`data_visualization_enhanced.yaml` | <img src="assets/cases/data_analysis/data_analysis.gif" width="100%"><br>Prompt: *"Create 4–6 high-quality PNG charts for my large real-estate transactions dataset."* |
|
||||
| **🛠️ 3D Generation**<br>*(Requires [Blender](https://www.blender.org/) & [blender-mcp](https://github.com/ahujasid/blender-mcp))* | `blender_3d_builder_simple.yaml`<br>`blender_3d_builder_hub.yaml`<br>`blender_scientific_illustration.yaml` | <img src="assets/cases/3d_generation/3d.gif" width="100%"><br>Prompt: *"Please build a Christmas tree."* |
|
||||
| **🎮 Game Dev** | `GameDev_v1.yaml`<br>`ChatDev_v1.yaml` | <img src="assets/cases/game_development/game.gif" width="100%"><br>Prompt: *"Please help me design and develop a Tank Battle game."* |
|
||||
| **📚 Deep Research** | `deep_research_v1.yaml` | <img src="assets/cases/deep_research/deep_research.gif" width="85%"><br>Prompt: *"Research about recent advances in the field of LLM-based agent RL"* |
|
||||
| **🎓 Teach Video** | `teach_video.yaml` (Please run command `uv add manim` before running this workflow) | <img src="assets/cases/video_generation/video.gif" width="140%"><br>Prompt: *"讲一下什么是凸优化"* |
|
||||
| **📈 数据可视化** | `data_visualization_basic.yaml`<br>`data_visualization_enhanced.yaml` | <img src="assets/cases/data_analysis/data_analysis.gif" width="100%"><br>提示词：*"Create 4–6 high-quality PNG charts for my large real-estate transactions dataset."* |
|
||||
| **🛠️ 3D 场景生成**<br>*(需要 [Blender](https://www.blender.org/) 和 [blender-mcp](https://github.com/ahujasid/blender-mcp))* | `blender_3d_builder_simple.yaml`<br>`blender_3d_builder_hub.yaml`<br>`blender_scientific_illustration.yaml` | <img src="assets/cases/3d_generation/3d.gif" width="100%"><br>提示词：*"Please build a Christmas tree."* |
|
||||
| **🎮 游戏开发** | `GameDev_v1.yaml`<br>`ChatDev_v1.yaml` | <img src="assets/cases/game_development/game.gif" width="100%"><br>提示词：*"Please help me design and develop a Tank Battle game."* |
|
||||
| **📚 深度研究** | `deep_research_v1.yaml` | <img src="assets/cases/deep_research/deep_research.gif" width="85%"><br>提示词：*"Research about recent advances in the field of LLM-based agent RL"* |
|
||||
| **🎓 教学视频** | `teach_video.yaml` (请在运行此工作流之前运行 `uv add manim` 命令) | <img src="assets/cases/video_generation/video.gif" width="140%"><br>提示词：*"讲一下什么是凸优化"* |
|
||||
|
||||
------
|
||||
|
||||
### 💡 使用指南
|
||||
对于这些实现，您可以使用 **Launch** 标签页来执行它们。
|
||||
1. **选择**：在 **Launch** 标签页选择一个工作流。
|
||||
2. **上传**：如果需要，上传相关文件（例如用于数据分析的 `.csv`）。
|
||||
3. **提示**：输入您的请求（例如*“可视化销售趋势”*或*“设计一个贪吃蛇游戏”*）。
|
||||
|
||||
---
|
||||
|
||||
### 💡 Usage Guide
|
||||
For those implementations, you can use the **Launch** tab to execute them.
|
||||
1. **Select**: Choose a workflow in the **Launch** tab.
|
||||
2. **Upload**: Upload necessary files (e.g., `.csv` for data analysis) if required.
|
||||
3. **Prompt**: Enter your request (e.g., *"Visualize the sales trends"* or *"Design a snake game"*).
|
||||
## 🤝 参与贡献
|
||||
|
||||
---
|
||||
我们欢迎社区的任何形式的贡献！无论是修复 Bug、添加新的工作流模板，还是分享由 DevAll 生成的优质案例/产物，您的帮助都至关重要。欢迎通过提交 **Issue** 或 **Pull Request** 来参与。
|
||||
|
||||
## 🤝 Contributing
|
||||
通过参与贡献，您的名字将被列入下方的 **贡献者** 名单中。请查看 [开发者指南](#开发者) 开始您的贡献之旅！
|
||||
|
||||
We welcome contributions from the community! Whether you're fixing bugs, adding new workflow templates, or sharing high-quality cases/artifacts produced by DevAll, your help is much appreciated. Feel free to contribute by submitting **Issues** or **Pull Requests**.
|
||||
### 👥 贡献者
|
||||
|
||||
By contributing to DevAll, you'll be recognized in our **Contributors** list below. Check out our [Developer Guide](#developers) to get started!
|
||||
|
||||
### 👥 Contributors
|
||||
|
||||
#### Primary Contributors
|
||||
#### 主要贡献者
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
@@ -325,7 +330,7 @@ By contributing to DevAll, you'll be recognized in our **Contributors** list bel
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
#### Contributors
|
||||
#### 贡献者
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/LaansDole"><img src="https://github.com/LaansDole.png?size=100" width="64px;"/><br /><sub><b>LaansDole</b></sub></a></td>
|
||||
@@ -353,7 +358,7 @@ By contributing to DevAll, you'll be recognized in our **Contributors** list bel
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## 🤝 Acknowledgments
|
||||
## 🤝 致谢
|
||||
|
||||
<a href="http://nlp.csai.tsinghua.edu.cn/"><img src="assets/thunlp.png" height=50pt></a>
|
||||
<a href="https://modelbest.cn/"><img src="assets/modelbest.png" height=50pt></a>
|
||||
@@ -363,7 +368,7 @@ By contributing to DevAll, you'll be recognized in our **Contributors** list bel
|
||||
<a href="www.teachmaster.cn"><img src="assets/teachmaster.png" height=50pt></a>
|
||||
<a href="https://github.com/OpenBMB/AppCopilot"><img src="assets/appcopilot.png" height=50pt></a>
|
||||
|
||||
## 🔎 Citation
|
||||
## 🔎 引用
|
||||
|
||||
```
|
||||
@article{chatdev,
|
||||
@@ -407,6 +412,6 @@ By contributing to DevAll, you'll be recognized in our **Contributors** list bel
|
||||
}
|
||||
```
|
||||
|
||||
## 📬 Contact
|
||||
## 📬 联系方式
|
||||
|
||||
If you have any questions, feedback, or would like to get in touch, please feel free to reach out to us via email at [qianc62@gmail.com](mailto:qianc62@gmail.com)
|
||||
如果您有任何问题、反馈或希望取得联系，请随时通过电子邮件发送至 [qianc62@gmail.com](mailto:qianc62@gmail.com)
|
||||
|
||||
Reference in New Issue
Block a user