/RooFlow-generic

RooFlow's fork that aims to be more generic, so that it could be used in collaborated projects (OSS)

Primary LanguageBatchfileApache License 2.0Apache-2.0

Important note:

The original RooFlow currently as of writing and this fork is not compatible with the latest Roo Code versions, so, PLEASE DON'T install this, if I have any new suggestion for similar mode systems, I will adapt them at starter-monorepo

Fork information:

This is a fork of RooFlow, this fork aims to be more generic, without requirement for machine-specific variable setup. So that it could be used in collaborated projects (OSS).

This fork could also contains opinionated modifications/optimizations over RooFlow, so take that in mind.

Current notable changes (vs v0.3.6):

  • Documents heavily revised.
  • Restructures:
    • config is now src.
    • Default + Boomerang modes are now defined in .roocodes and
      • This is more intuitive:
        • Better DX/UX (Users simply open the project and proceed)
        • Adding these modes as global scope is not gonna work anyways, as custom system prompt files for other modes are needed.
  • Use a different Boomerang mode that is more optimized.
  • More optimzed install script that installs latest release-ready version instead of HEAD, also removes git requirement
  • Is generic!, feel free to use it in a collaborated repo.
  • Of courses, other minor changes and improvements

You can test the fork in action at: starter-monorepo

Now with install scripts for Windows and Linux/macOS!

For MCP server use in RooFlow custom modes, there is a MCP_SERVERS_PLACEHOLDER in the system-prompt-[mode] files where connected MCP servers will need to be inserted.

☢️☢️☢️ Footgun in Use ☢️☢️☢️


RooFlow generic

RooFlow Logo

Persistent Project Context and Streamlined AI-Assisted Development for Roo Code

🎯 Overview

RooFlow enhances AI-assisted development in VS Code by providing persistent project context and optimized mode interactions, resulting in reduced token consumption and a more efficient workflow. It builds upon the concepts of the Roo Code Memory Bank, but streamlines the process and introduces a more integrated system of modes. RooFlow ensures your AI assistant maintains a deep understanding of your project across sessions, even after interruptions.

Key Improvements over Roo Code Memory Bank:

  • Reduced Token Consumption: Optimized prompts and instructions minimize token usage.
  • Five Integrated Modes: Architect, Code, Test, Debug, and Ask modes work together seamlessly.
  • Simplified Setup: Easier installation and configuration.
  • Streamlined Real-time Updates: More efficient and targeted Memory Bank updates.
  • Clearer Instructions: Improved YAML-based rule files for better readability and maintainability.

Key Components

flowchart LR
  A["RooFlow"] --> D["Toolkit"]
  A["RooFlow"] --> M["Real-time Updates"]
  D --> C["Mode Rules"]
  B["Memory Bank"] --> E["Product Context"] & N["Active Context"] & F["Decisions"] & G["Progress"]
  C --> H["Architect"] & I["Code"] & J["Ask"] & K["Debug"] & L["Test"]
  M["Real-time Updates"] --> B
Loading
  • 🧠 Memory Bank: Persistent storage for project knowledge (automatically managed).
  • 💻 System Prompts: YAML-based core instructions for each mode (.roo/system-prompt-[mode]).
  • 🔧 VS Code Integration: Seamless development experience within VS Code.
  • ⚡ Real-time Updates: Automatic Memory Bank updates triggered by significant events.

🚀 Quick Start

Installation

  1. Install Roo Code Extension: Ensure you have the Roo Code extension installed in VS Code.
  2. Open your terminal and navigate (cd) to your project's root directory.
  3. Download and execute the appropriate script for your operating system:
  • Windows (Command Prompt or PowerShell):
curl -L -o install_rooflow.cmd https://raw.githubusercontent.com/NamesMT/RooFlow-generic/main/src/install_rooflow.cmd && .\install_rooflow.cmd
  • Linux / macOS (bash/zsh):
curl -Lo install_rooflow.sh https://raw.githubusercontent.com/NamesMT/RooFlow-generic/main/src/install_rooflow.sh && sh ./install_rooflow.sh
  1. The script will download the latest release, extract, move files, and cleanup.
    • Follow any on-screen prompts or error messages.
  2. Verify Installation: After the script runs successfully:
  • Check that the .roo/ directory, along with the .roomodes file exist in your project root.

Open an issue if you encounter any problems :).

Using RooFlow

  1. Start a Chat: Open a new Roo Code chat in your project.
  2. Select a Mode: Choose the appropriate mode (Architect, Code, Test, Debug, Ask, Default or Boomerang) for your task. *. Generally, you should start with the Default mode, which is designed for general project context and collaboration. *. If you are doing a large and long task, use Boomerang mode.
  3. Interact with Roo: Give Roo instructions and ask questions. Roo will automatically use the Memory Bank to maintain context.

Notes:

  1. Memory Bank Initialization: If you start a chat in a project without a memory-bank/ directory, Roo will suggest switching to Architect mode and guide you through the initialization process.
  2. "Update Memory Bank" Command: At any time, you can type "Update Memory Bank" or "UMB" to force a synchronization of the chat session's information into the Memory Bank. This is useful for ensuring continuity across sessions or before switching modes.

📚 Memory Bank Structure

The Memory Bank is a directory, located at memory-bank/ relative to your project's root. It contains several Markdown files that store different aspects of your project's knowledge:

File Purpose
activeContext.md Tracks the current session's context: recent changes, current goals, and open questions/issues.
decisionLog.md Records architectural and implementation decisions, including the context, decision, rationale, and implementation details.
productContext.md Provides a high-level overview of the project, including its goals, features, and overall architecture.
progress.md Tracks the progress of the project, including completed work, current tasks, and next steps. Uses a task list format.
systemPatterns.md (Optional) Documents recurring patterns and standards used in the project (coding patterns, architectural patterns, testing patterns).

RooFlow automatically manages these files. You generally don't need to edit them directly, although you can review them to understand the AI's knowledge.

✨ Features

🧠 Persistent Context

The Memory Bank ensures that RooFlow retains project knowledge across sessions. When you start a new chat, RooFlow reads the Memory Bank files, providing the AI with immediate context.

⚡ Real-time Updates

RooFlow automatically updates the Memory Bank during your chat session when significant changes occur (e.g., new decisions, code modifications, task completion). This keeps the context fresh and accurate. The "Update Memory Bank" (UMB) command allows for manual synchronization.

🤝 Mode Collaboration

The different modes (Architect, Code, Test, Debug, Ask) are designed to collaborate. Each mode has specific triggers and handoff points defined in its system prompt, allowing for seamless transitions between specialized tasks.

⬇️ Reduced Token Consumption

By storing persistent context in the Memory Bank and using optimized prompts, RooFlow significantly reduces the number of tokens needed for each interaction compared to traditional methods that rely solely on chat history.

⚙️ Configuration

  • System Prompts (.roo/system-prompt-[mode]): Customize the core behavior of each mode.
  • Mode Definitions (.roomodes): Define custom modes and their associated system prompts.

Contributing

See CONTRIBUTING.md for details on how to contribute to RooFlow.

License

Apache 2.0