# CodeFlowMu Open Dev Team Edition

<p align="center">
  <img src="docs/images/product-1.png" alt="CodeFlowMu - Commands Flow, Intelligence Follows" width="720">
</p>

<p align="center">
  <strong>码流 CodeFlowMu：把 AI Agent 组织成一个本地开发团队。</strong><br>
  <strong>CodeFlowMu turns local AI agents into a coordinated development team.</strong>
</p>

<p align="center">
  <a href="#中文">中文</a> ·
  <a href="README.zh.md">完整中文介绍</a> ·
  <a href="#english">English</a> ·
  <a href="INSTALL.md">Install</a> ·
  <a href="docs/open/getting-started.md">Getting Started</a>
</p>

---

## 中文

CodeFlowMu Open Dev Team Edition 是公开开源版本，面向本地安装、体验、二次开发和贡献。

当前开源版本：`V1.0.0-open`

它不是母体私有仓库的完整镜像，也不是用来开发 CodeFlowMu 自身的目录。它是一个确定的 FCoP 团队开发应用工具：安装在本地，用 PM / DEV / OPS / QA / EVAL 五个 Agent 协同开发你的项目。

- 固定团队：`PM / DEV / OPS / QA / EVAL`
- 固定接入：`Cursor SDK only`
- 默认本地运行：`http://127.0.0.1:18765/`
- 单实例安装：每台电脑当前只支持一个标准安装，Windows 默认 `D:\CodeFlowMu-open`
- 默认关闭私有 Gateway 自动连接
- 受保护工具根：`CodeFlowMu-open` 自身不能作为任务开发目标
- 保留 Git 状态、任务、报告、审批、聊天、项目配置、数据导出和任务模板
- 不包含母体真实运行记录、私有日志、私有 Gateway 凭据、内部评估/观察流和公司私有发布能力

如果你见过旧的 `joinwell52-AI/codehouse` / CodeFlow 仓库，可以把它理解成上一代产品叙事与实验现场。CodeFlowMu Open 是新的公开入口：保留“指令成流、文件协作、多 Agent 团队”的核心思想，但以干净的公开发行包、固定开发团队、可重复初始化和可贡献的源码结构重新组织。

### 一句话

把需求、任务、代码、报告和验收放进同一个本地协作面板里，让 PM、DEV、OPS、QA 四个 Agent 以文件协议协同工作。

### 本地团队

<p align="center">
  <img src="docs/images/product.png" alt="CodeFlowMu product view" width="680">
</p>

```mermaid
flowchart LR
  Human["Human / 你"] --> PM["PM<br/>拆解需求 / 验收调度"]
  PM --> DEV["DEV<br/>代码实现"]
  PM --> OPS["OPS<br/>运行环境 / 打包发布"]
  PM --> QA["QA<br/>测试验证"]
  DEV --> Report["REPORT<br/>交付证据"]
  OPS --> Report
  QA --> Report
  Report --> PM
  PM --> Git["Git 状态 / 公开贡献"]
```

### 快速开始

Windows 推荐：

```bat
START-CODEFLOWMU-OPEN.bat
```

手动方式：

```bash
git clone https://github.com/joinwell52-AI/CodeFlowMu-open.git
cd CodeFlowMu-open
npm install
npm start
```

打开：

```text
http://127.0.0.1:18765/
```

首次启动会进入干净初始化状态：清理公开版运行缓存，保留源码、Git 历史、`node_modules` 和 `.venv`。

启动后请先在「设置 → 项目」添加你的产品/代码目录，并切换为当前项目。任务、报告、FCoP 初始化、附件和 Agent 会话都会写入这个外部项目根；公开版不会更新自己的 `CodeFlowMu-open` 源码目录。

### 安装与更新

公开仓库面向下载、安装、介绍和贡献。一个全新发版会由母版构建为完整开源版本包，包含源码、面板、Shell、公开文档、公开初始化源、启动器、`VERSION.json`、`RELEASES.md` 和 `UPDATE.md`。

更新策略采用全量更新：应用文件整体替换，保留 `.git/`、`node_modules/`、`.venv/`、本机 `.env`、`.codeflowmu/mobile-gateway.json`、`workspace/` 和外部项目根。

用户侧更新：

```bash
cd CodeFlowMu-open
git pull
npm install
START-CODEFLOWMU-OPEN.bat
```

### 开源版包含什么

<p align="center">
  <img src="docs/images/product-2.png" alt="CodeFlowMu open edition overview" width="680">
</p>

| 模块 | 开源版状态 |
|---|---|
| PC Panel | 可用 |
| Mobile PWA | 本地局域网体验 |
| PM / DEV / OPS / QA / EVAL | 固定开发团队 |
| 外部项目根 | 必须添加后再开发 |
| CodeFlowMu-open 自身 | 工具根，受保护，不作为任务目标 |
| Git 状态 | 可用 |
| 技能库 | 公开 manifest 与 playbook |
| Gateway | 默认关闭，仅官方演示 / 受限使用 |
| Provider | Cursor SDK only |
| EVAL / 内部观察流 | 母体能力，公开版默认隐藏 |

### 界面一览

<p align="center">
  <img src="docs/images/task-010r-a/01-home-workbench.png" width="420" alt="CodeFlowMu Open home workbench">
  <img src="docs/images/task-010r-a/02-tasks.png" width="420" alt="CodeFlowMu Open tasks">
</p>
<p align="center">
  <img src="docs/images/task-010r-a/03-task-detail.png" width="420" alt="CodeFlowMu Open task detail">
  <img src="docs/images/task-010r-a/04-chat.png" width="420" alt="CodeFlowMu Open chat">
</p>
<p align="center">
  <img src="docs/images/task-010r-a/05-my-settings.png" width="420" alt="CodeFlowMu Open settings">
</p>

### 初始化源

公开包带有可公开初始化源：

```text
adoptedSource/fcop/
adoptedSource/pending/
docs/skills/
docs/open/
```

不会带入：

```text
adoptedSource/gateway/
private/
.env
真实任务、报告、日志、聊天历史
```

### 仓库关系

```text
私有母体仓库：
joinwell52-AI/codeflowmu

公开开源仓库：
joinwell52-AI/CodeFlowMu-open
```

母体负责版本选择、构建、同步、清理运行态和发布；公开仓库负责下载、安装、介绍、体验和贡献入口。

GitHub 仓库 About / topics 建议见 [docs/open/github-repo-about.md](docs/open/github-repo-about.md)。

---

## English

CodeFlowMu Open Dev Team Edition is the public open-source edition for local installation, hands-on evaluation, development, and contribution.

Current open edition version: `V1.0.0-open`

It is not a full mirror of the private mother repository, and it is not meant to develop CodeFlowMu itself. It is a fixed FCoP team-development application: install it locally, then use PM / DEV / OPS / QA / EVAL agents to collaborate on your own project.

- Fixed team: `PM / DEV / OPS / QA / EVAL`
- Fixed provider: `Cursor SDK only`
- Local default: `http://127.0.0.1:18765/`
- Single install: one standard CodeFlowMu Open install per computer; Windows default is `D:\CodeFlowMu-open`
- Private Gateway auto-connect is disabled by default
- Protected tool root: `CodeFlowMu-open` itself is not a development target
- Git status, tasks, reports, approvals, chat, project settings, data export, and task templates are available
- Private runtime history, private logs, Gateway credentials, internal observation/evaluation flows, and company release tooling are excluded

If you have seen the old `joinwell52-AI/codehouse` / CodeFlow repository, treat it as the previous product narrative and experiment ground. CodeFlowMu Open is the new public entry point: the same core idea of command flow, file-based collaboration, and multi-agent teams, reorganized as a clean public distribution with a fixed dev team, repeatable first-run initialization, and a contribution-ready source layout.

### What It Does

CodeFlowMu gives local AI agents a shared collaboration surface: requirements become tasks, tasks produce reports, reports carry evidence, and PM/DEV/OPS/QA/EVAL can move work through a visible workflow.

### Quick Start

Recommended on Windows:

```bat
START-CODEFLOWMU-OPEN.bat
```

Manual:

```bash
git clone https://github.com/joinwell52-AI/CodeFlowMu-open.git
cd CodeFlowMu-open
npm install
npm start
```

Open:

```text
http://127.0.0.1:18765/
```

The first launch initializes a clean open-edition runtime state. It removes generated public runtime caches while keeping source files, Git history, `node_modules`, and `.venv`.

After startup, open Settings -> Projects, add your product/source directory, and switch to it. Tasks, reports, FCoP initialization, attachments, and agent sessions are written to that external project root. The open edition does not update its own `CodeFlowMu-open` source directory.

### Install And Update

The public repository is for download, installation, introduction, and contribution. Each fresh release is built by the mother repository as a complete open-edition package with source, panel assets, Shell, public docs, public initialization sources, launcher, `VERSION.json`, `RELEASES.md`, and `UPDATE.md`.

Updates use a full replacement strategy: application files are replaced as a whole, while `.git/`, `node_modules/`, `.venv/`, local `.env`, `.codeflowmu/mobile-gateway.json`, `workspace/`, and external project roots are preserved.

User update flow:

```bash
cd CodeFlowMu-open
git pull
npm install
START-CODEFLOWMU-OPEN.bat
```

### Edition Boundary

| Area | Open Edition |
|---|---|
| PC Panel | Available |
| Mobile PWA | Local LAN experience |
| PM / DEV / OPS / QA / EVAL | Fixed team |
| External project root | Required before project development |
| CodeFlowMu-open itself | Protected tool root, not a task target |
| Git Status | Available |
| Skills | Public manifest and playbooks |
| Gateway | Disabled by default, official demo / limited use only |
| Provider | Cursor SDK only |
| EVAL / internal observation | Private mother-edition capability, hidden by default |

### Screenshots

<p align="center">
  <img src="docs/images/task-010r-a/01-home-workbench.png" width="420" alt="CodeFlowMu Open home workbench">
  <img src="docs/images/task-010r-a/02-tasks.png" width="420" alt="CodeFlowMu Open tasks">
</p>
<p align="center">
  <img src="docs/images/task-010r-a/03-task-detail.png" width="420" alt="CodeFlowMu Open task detail">
  <img src="docs/images/task-010r-a/04-chat.png" width="420" alt="CodeFlowMu Open chat">
</p>
<p align="center">
  <img src="docs/images/task-010r-a/05-my-settings.png" width="420" alt="CodeFlowMu Open settings">
</p>

### Public Initialization Sources

Included:

```text
adoptedSource/fcop/
adoptedSource/pending/
docs/skills/
docs/open/
```

Excluded:

```text
adoptedSource/gateway/
private/
.env
real tasks, reports, logs, and chat history
```

### Contributing

Good first contribution areas:

- Windows/macOS/Linux install flow
- Local four-agent workflow
- Git status and project configuration UX
- Public docs, templates, and examples
- Panel usability and local runtime stability

See also:

- [Install](INSTALL.md)
- [Getting Started](docs/open/getting-started.md)
- [Edition Boundary](docs/open/edition-boundary.md)
- [Gateway Policy](docs/open/gateway-demo.md)
- [GitHub Repository About](docs/open/github-repo-about.md)
- [Open Edition Articles](docs/articles/README.md)
- [Open Edition Scope](docs/articles/open-edition-scope.md)
- [Open Edition Directory Manual](docs/articles/open-edition-directory-manual.md)
- [Release Content Boundary](docs/articles/release-content-boundary.md)
- [Contributing](docs/open/contributing.md)