🎯 概览

RooFlow 为 Roo Code VS Code 扩展 中的 AI 辅助开发提供了一种实验性的替代方案。它采用基于 YAML 的系统提示来实现其特有的“Flow”模式，相较于标准模式，可能带来更高的效率和更低的令牌消耗。RooFlow 通过其 Memory Bank 系统（借鉴了 roo-code-memory-bank 中的概念）提供了持久化的项目上下文，确保 AI 助手在不同会话中都能保持对项目的理解。

相较于 Roo Code Memory Bank 的关键改进：

• 降低令牌消耗： 优化后的提示和指令最大限度地减少了令牌使用。
• 五种集成模式： Flow-Architect、Flow-Code、Flow-Debug、Flow-Ask 和 Flow-Orchestrator 模式无缝协作。
• 简化设置： 更加简便的安装与配置。
• 精简实时更新： Memory Bank 更新更高效且更具针对性。
• 更清晰的说明： 改进的 YAML 规则文件，提升可读性和可维护性。

关键组件

%%{init: {'themeVariables': { 'fontSize': '14px'}}}%%
graph LR
    subgraph Workspace
        U[用户]
        MB[(Memory Bank)]
    end

    subgraph VSCode
        RC[Roo Code 扩展]
    end

    subgraph RooFlow ["RooFlow（实验性替代方案）"]
        subgraph FlowModes ["Flow 模式（YAML 提示）"]
            direction TB
            FO[Flow-Orchestrator]
            subgraph ExecutionModes ["直接/委托模式"]
               direction LR
               FA[Flow-Architect]
               FC[Flow-Code]
               FD[Flow-Debug]
               FK[Flow-Ask]
            end
             %% 将 Orchestrator 链接到它所委托的组
             FO -- 委托 --> ExecutionModes
        end
    end

    %% 核心流程
    U -- 与 --> RC 交互
    RC -- 使用 --> RooFlow

    %% 用户任务路径
    U -- 复杂任务 --> FO
    U -- 直接任务 --> ExecutionModes


    %% Memory Bank 交互
    FA <--> MB
    FC <--> MB
    FD <--> MB
    FK --> MB

    %% 样式
    style MB fill:#f9f,stroke:#333,stroke-width:2px,color:#000
    style FO fill:#ccf,stroke:#333,stroke-width:2px,color:#000

Memory Bank 访问标记：

• <-->（读/写）：Flow-Architect、Flow-Code、Flow-Debug
• -->（只读）：Flow-Ask

• 🧠 Memory Bank：用于存储项目知识的持久化存储（自动管理）。
• 💻 系统提示：每个模式的核心指令均基于 YAML（位于 .roo/system-prompt-[mode]）。
• 🔧 VS Code 集成：在 VS Code 中实现无缝开发体验。
• ⚡ 实时更新：由重要事件触发的 Memory Bank 自动更新。

🚀 快速入门

安装

1. 安装 Roo Code 扩展： 确保您已在 VS Code 中安装了 Roo Code 扩展。
2. 先决条件：
   • Git： 安装脚本需要 git 已安装并可在系统的 PATH 中访问。请从 https://git-scm.com/downloads 下载 Git。
   • Python 3： 脚本现在直接使用 Python。确保 Python 3 已安装，并可在 PATH 中以 python3（Linux/macOS）或 python（Windows）访问。请从 https://www.python.org/downloads/ 下载 Python。
   • PyYAML： Python 脚本需要 PyYAML 库。使用 pip 安装：

   pip install pyyaml
   # 或者可能需要 pip3 install pyyaml
   

3. 打开您的终端，并导航（cd）到项目的根目录。
4. 直接运行适用于您操作系统的相应命令：
   • Windows（命令提示符或 PowerShell）：

   1. 下载脚本

      用于基于文件的 Memory Bank：

      curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow.cmd
      

      用于 Context Portal MCP：

      curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow_conport.cmd
      

   2. 执行下载的脚本（⚠️如果您已连接 MCP 服务器，请先参阅 导入已连接的 MCP 服务器工具 再进行安装）：

      ./install_rooflow.cmd
      

      或

      ./install_rooflow_conport.cmd
      

   • Linux / macOS（bash/zsh）：
   1. 下载脚本

适用于基于文件的内存库：

curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow.sh

适用于Context Portal MCP：

curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow_conport.sh

2. 使脚本可执行：

chmod +x install_rooflow.sh

或

chmod +x install_rooflow_conport.sh

3. 执行下载的脚本（⚠️如果您已连接MCP服务器，请在安装前参阅导入已连接的MCP服务器工具）：

./install_rooflow.sh

或

./install_rooflow_conport.sh

5. 该命令会下载并执行脚本，脚本将检查先决条件（git、python3/python、pyyaml），克隆仓库，复制必要文件（包括generate_mcp_yaml.py），清理克隆目录，并运行Python脚本处理模板。请根据屏幕提示或错误信息进行操作。

6. 注意： 安装脚本（install_rooflow.*）在执行后会保留下来，以便后续重新运行（例如用于更新）。

7. 验证安装： 脚本成功运行后：

• 检查项目根目录中是否存在.roo/目录以及.roomodes文件。
• 可选地，检查.roo/system-prompt-*文件，确保诸如WORKSPACE_PLACEHOLDER之类的占位符已被替换为您的实际系统路径。

8. 与标准模式共存： RooFlow安装会将Flow-*模式与标准Roo Code模式（Architect、Code、Debug、Ask）并列添加。您可随时通过Roo Code界面在Flow模式和标准模式之间切换。如果遇到Flow模式的问题，您可以轻松切换回其标准对应模式。

导入已连接的MCP服务器工具（可选）

如果您在Roo Code中使用MCP（模型上下文协议）服务器，RooFlow可在安装时自动将已连接服务器的详细信息（包括其工具、资源等）注入自定义Flow模式提示中。这确保了Flow模式能够识别与标准Roo Code模式相同的工具。

要在初始安装时启用此功能：

1. 获取完整系统提示： 在运行RooFlow安装程序之前，您需要Roo Code动态生成的完整系统提示文本——该文本是在Roo Code连接到您的MCP服务器后生成的。

• 导航至“扩展”->“Roo Code”->“提示”（如图所示）。

• 选择任意一个标准Roo Code模式（例如，“Architect”、“Code”、“Ask”、“Debug”）。
• 点击“复制系统提示到剪贴板”按钮（如上图所示）。
• 此文本包含您当前已连接的MCP服务器的动态发现信息。

2. 保存为system_prompt.md： 将复制的文本保存到一个名为system_prompt.md的新文件中，直接放在项目的根目录下。

3. 运行安装程序： 现在，按照上述主要安装部分所述，运行install_rooflow.sh或install_rooflow.cmd脚本。

• 安装程序会复制Python脚本generate_mcp_yaml.py。
• 随后运行该Python脚本（使用python3或python）。脚本会自动在根目录中查找system_prompt.md。
• 如果找到，Python脚本会解析其中的MCP服务器详细信息，将其转换为YAML格式，并注入到.roo/system-prompt-flow-*文件中的相应占位符（# [CONNECTED_MCP_SERVERS]）中，同时执行其他变量替换。
• 如果未找到system_prompt.md，则跳过此注入步骤。

稍后更新MCP服务器信息：

如果您在RooFlow初始安装后添加、删除或修改MCP服务器配置，您需要更新Flow模式提示：

1. 获取更新后的提示： 确保所需的MCP服务器已在Roo Code中连接。返回Roo Code设置，从一个标准模式中复制最新的完整系统提示文本（包含更新后的MCP详细信息），就像初始设置一样。
2. 保存更新后的system_prompt.md： 将新文本保存到项目根目录下的system_prompt.md中，覆盖之前的版本。
3. 重新运行安装程序： 从项目根目录再次执行install_rooflow.sh或install_rooflow.cmd脚本。

• 该脚本会从仓库中复制最新的基础配置（.roo/文件、.roomodes、generate_mcp_yaml.py），并再次运行generate_mcp_yaml.py Python脚本。
• Python脚本会读取您更新后的system_prompt.md，并将新的MCP服务器详细信息注入到新复制的.roo/system-prompt-flow-*文件中（同时执行基本变量替换）。

⚠️ 关于更新的重要提示： 重新运行安装程序是更新MCP信息最简单的方法，但请注意，这会覆盖.roo/目录和.roomodes文件，用仓库中的最新副本替换它们。如果您在初始安装后对.roo/system-prompt-flow-*文件进行了手动自定义，这些自定义内容将会丢失。如果您希望构建更精细的更新流程，Python脚本（generate_mcp_yaml.py）仍保留在根目录中。

3. 使用RooFlow

1. 开始聊天：在您的项目中打开一个新的Roo Code聊天。

   2. 选择模式：为您的任务选择合适的模式：
      • 🌊Flow代码💻：用于编写、修改和记录代码。
      • 🌊Flow架构师🏗️：用于系统设计、项目结构以及Memory Bank的初始化。
      • 🌊Flow提问❓：用于提问、代码分析和解释。
      • 🌊Flow调试🪲：用于排查错误和调试代码。
      • 🌊Flow协调员🪃：用于需要分解并委托给其他模式的复杂任务（参见回旋镖任务）。
   3. 与Roo互动：向Roo发出指令并提出问题。Roo将利用Memory Bank（如果已初始化）和模式功能来提供帮助。
   4. Memory Bank初始化：如果您在没有memory-bank/目录的项目中开始聊天，Roo会建议切换到Flow-架构师模式，并引导您完成初始化过程。
   5. “更新Memory Bank”命令：您可以随时输入“更新Memory Bank”或“UMB”，以强制将聊天会话的信息同步到Memory Bank。这在确保跨会话连续性或切换模式前非常有用。
   
   

   4. 更新RooFlow

   只需运行安装脚本，它就会覆盖您现有的.roo/目录和.roomodes文件。如果您在.roomodes中有自己的额外自定义模式，请在运行更新前重命名该文件，然后用您自定义文件的内容替换新安装的.roomodes文件内容。

📚 Memory Bank结构

Memory Bank是一个名为memory-bank的目录，位于您的项目根目录下。它包含若干Markdown文件，用于存储项目知识的不同方面：

文件	用途
activeContext.md	跟踪当前会话的上下文：最近的变更、当前目标以及开放的问题/议题。
decisionLog.md	记录架构和实现决策，包括上下文、决策内容、理由及实施细节。
productContext.md	提供项目的高层次概览，包括其目标、功能和整体架构。
progress.md	跟踪项目的进展，包括已完成的工作、当前任务和下一步计划。采用任务列表格式。
systemPatterns.md	（可选）记录项目中使用的常见模式和标准（编码模式、架构模式、测试模式）。

RooFlow会自动管理这些文件。通常您无需直接编辑它们，不过可以查看这些文件以了解AI的知识。

✨ 功能

🧠 持久化上下文

RooFlow会在不同会话之间记住项目细节，保持对您的代码库、设计决策和进度的一致理解。

⚡ 实时更新

Memory Bank会根据每个模式中的重要事件自动更新，确保上下文始终是最新的。

🤝 模式协作

五个模式（Flow-架构师、Flow-代码、Flow-调试、Flow-提问和Flow-协调员）旨在无缝协作。Flow-协调员可以将任务委派给其他模式，各模式也可根据需要相互切换，并通过Memory Bank共享信息。

⬇️ 降低Token消耗

RooFlow的设计旨在比以前的系统使用更少的Token，从而更加高效且经济实惠。

📝 UMB命令

随时可以输入“更新Memory Bank”或“UMB”命令，以将当前聊天会话的信息更新到Memory Bank。

贡献

欢迎为RooFlow做出贡献！请参阅CONTRIBUTING.md文件（您需要创建此文件）以获取指南。

许可证

Apache 2.0

RooFlow 快速上手指南

环境准备

• VS Code：已安装 Roo Code 扩展
• Git：确保已安装并加入系统 PATH
  下载地址（国内推荐：清华镜像）
• Python 3：确保可执行命令为 python3（Linux/macOS）或 python（Windows）
  下载地址（国内推荐：清华源）
• PyYAML：安装依赖库

  pip install pyyaml
  # 或使用国内源加速
  pip install pyyaml -i https://pypi.tuna.tsinghua.edu.cn/simple
  

安装步骤

1. 打开终端，进入你的项目根目录。

2. 根据使用场景选择安装脚本：

   使用本地 Memory Bank（推荐默认）

   # Linux/macOS
   curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow.sh
   chmod +x install_rooflow.sh
   ./install_rooflow.sh
   
   # Windows（PowerShell 或 CMD）
   curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow.cmd
   ./install_rooflow.cmd
   

   使用 Context Portal MCP（可选）

   # Linux/macOS
   curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow_conport.sh
   chmod +x install_rooflow_conport.sh
   ./install_rooflow_conport.sh
   
   # Windows
   curl -O https://raw.githubusercontent.com/GreatScottyMac/RooFlow/main/config/install_rooflow_conport.cmd
   ./install_rooflow_conport.cmd
   

3. 安装完成后，检查项目根目录是否生成 .roo/ 文件夹及 .roomodes 文件。

基本使用

1. 在 VS Code 中打开你的项目。

2. 打开 Roo Code 面板，选择任意 Flow 模式：

   • Flow-Architect：架构设计
   • Flow-Code：代码生成
   • Flow-Debug：调试分析
   • Flow-Ask：问答咨询
   • Flow-Orchestrator：任务编排（推荐复杂任务）

3. 输入你的开发请求，例如：

   请为这个项目添加一个用户登录模块，使用 Python + Flask
   

4. RooFlow 会自动利用项目上下文（Memory Bank）进行响应，无需重复提供背景信息。

✅ 所有 Flow 模式与原 Roo Code 模式共存，可随时切换。