Skip to content

joinwell52-AI/CodeFlowMu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CodeFlowMu

CodeFlowMu 是一个基于 FCoP(File-based Coordination Protocol)的本地 AI 协作运行面板和运行时。 本仓库包含 Web Panel、Shell 运行时、FCoP 协议包、运行时包和桌面端代码。

默认开发目录:

D:\codeflowmu

默认 Web Panel 地址:

http://127.0.0.1:18766

多产品开发根: 可在 Panel 设置 → 项目 登记多个磁盘目录(如 D:\xiangqiD:\weiqi),与 monorepo 可不在同一盘;添加时可用 「浏览…」 本机选文件夹。列表保存在 %USERPROFILE%\.codeflowmu\v2\projects-registry.json。详见 操作手册 · 项目

目录结构

codeflowmu/
├─ codeflowmu-shell/              # Node/TypeScript Shell 入口,npm start 实际运行这里
├─ codeflowmu-desktop/            # Python 桌面端与面板资源
├─ packages/
│  ├─ codeflowmu-protocol/         # FCoP 协议 schema 与校验
│  ├─ codeflowmu-runtime/          # 调度、Agent、Review、Session 等运行时
│  └─ evaluator/                   # EVAL 观察相关脚本
├─ fcop/                           # 默认产品开发根下的 FCoP 账本(切换项目后 API 指向其他根的 fcop/)
│  └─ adopted/pending/             # 已采用 · 运行时生效 · 待 ADMIN 决定是否并入正式版(见 FCoP-PENDING-0001)
├─ docs/                           # 设计文档和操作手册
├─ workspace/                      # FCoP 工作区说明
├─ package.json                    # 根目录脚本
└─ .env                            # 本机环境配置,不建议跨电脑直接覆盖

环境要求

Windows 开发环境建议:

Node.js 24 LTS 或 22 LTS
npm 11+
Python 3.10+
Git

本机已验证组合:

Node.js v24.16.0
npm 11.13.0
Python 3.10.11
fcop 3.2.5

安装 Node.js 和 npm:

winget install --id OpenJS.NodeJS.LTS --source winget --accept-package-agreements --accept-source-agreements

安装或升级 Python 端 FCoP:

python -m pip install -U fcop

检查环境:

node -v
npm -v
python --version
python -c "import fcop; print(getattr(fcop, '__version__', 'no-version'))"

如果刚安装 Node 后旧终端还找不到 nodenpm,新开一个 PowerShell / Cursor 终端即可。旧终端临时可用:

$env:Path='C:\Program Files\nodejs;' + $env:Path

首次安装

在仓库根目录执行:

cd D:\codeflowmu
npm run install:all

这个脚本会依次安装:

根 workspace
packages/codeflowmu-protocol
packages/codeflowmu-runtime
codeflowmu-shell

如果只安装 Shell:

cd D:\codeflowmu\codeflowmu-shell
npm install

本机配置

根目录 .env 是本机配置文件。两台电脑的 Python 路径、API Key 可能不同,不建议直接互相覆盖。

常用配置示例:

CODEFLOW_PROVIDER=cursor
CURSOR_API_KEY=crsr_xxx
CURSOR_DEFAULT_MODEL=default
PYTHON_BIN=C:\Users\wei\AppData\Local\Programs\Python\Python310\python.exe
CODEFLOW_SKIP_FCOP_PROBE=0

查找本机 Python 路径:

where.exe python
py -3 -c "import sys; print(sys.executable)"

如果启动时报 PYTHON_BIN points at a path that does not exist,把 .env 里的 PYTHON_BIN 改成本机真实路径。

启动

正式启动:

cd D:\codeflowmu
npm start

无 Web Panel 启动:

cd D:\codeflowmu
npm run start:no-ui

启动成功后访问:

http://127.0.0.1:18766

停止:

Ctrl+C

常用开发命令

# 安装全部依赖
npm run install:all

# 启动 Web Panel
npm start

# 启动无界面模式
npm run start:no-ui

# Shell 类型检查
npm run shell:typecheck

# Shell 测试
npm run shell:test

# Shell 构建
npm run shell:build

也可以进入子目录单独执行:

cd D:\codeflowmu\codeflowmu-shell
npm run typecheck
npm test
npm run build

双电脑开发 Git 流程

两台电脑可以同时开发,但要养成“开始前拉取,结束后提交推送”的习惯。

每次开始工作前:

cd D:\codeflowmu
git status
git pull

开发完成后:

git status
git diff
git add .
git commit -m "描述这次修改"
git push

另一台电脑继续开发前:

git pull
npm run install:all

推荐规则:

  • 不要两台电脑同时改同一个文件的同一段代码。
  • 一台电脑完成一小段工作后及时 commit + push
  • 另一台电脑开始前先 pull
  • node_modules/ 不要提交,也不需要跨电脑同步。
  • .env 是本机配置,API Key 和 Python 路径不要随意互相覆盖。
  • 如果 npm start 提示本地包缺失,先确认 packages/ 目录存在,再跑 npm run install:all

Git 冲突处理

如果 git pull 出现冲突:

git status

打开冲突文件,处理这些标记:

    <<<<<<< HEAD(示例)
本机修改
=======(示例)
远端修改
    >>>>>>> origin/main(示例)

解决后:

git add .
git commit
git push

如果只是想丢弃本机所有改动并完全对齐远端,谨慎使用:

git fetch origin
git reset --hard origin/main

这会覆盖本机未提交修改。

常见问题

npm start 找不到 node 或 npm

新开终端,或临时执行:

$env:Path='C:\Program Files\nodejs;' + $env:Path

Cannot find package @codeflowmu/runtime

通常是 packages/codeflowmu-runtime 缺失,或依赖没有重新安装。

cd D:\codeflowmu
git pull
npm run install:all

python3 ENOENT

Windows 上通常没有 python3 命令。设置 .env

PYTHON_BIN=C:\Users\wei\AppData\Local\Programs\Python\Python310\python.exe

fcop import 失败

确认 PYTHON_BIN 指向的 Python 已安装 fcop:

python -m pip install -U fcop
python -c "import fcop; print(getattr(fcop, '__version__', 'no-version'))"

端口 18766 被占用

查找进程:

netstat -ano | findstr 18766

结束进程:

taskkill /PID <PID> /F

参考文档

About

CodeFlowMu** 是一个基于 **FCoP (File-based Coordination Protocol)** 构建的 **AI 驱动的协作工作流系统**。它通过文件协议实现 AI 团队和人类之间的协作。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors