How hheydaroff/rooflow-cookiecutter works
Project’s Purpose and Type
• This is a Cookiecutter template designed to generate RooFlow projects.
• RooFlow’s core purpose is to enable AI-assisted development through persistent context across sessions. This involves configuring system prompts for various development modes (coding, debugging, architecture planning, etc.), managing environment variables, and optionally integrating memory banks and UVX for Python package management.
Break Down the Main Components
A. Template & Configuration Files
• Cookiecutter Metadata: The cookiecutter.json file provides variables for generating project-specific values (e.g., project_name, project_slug). This determines the final project structure.
• License, README, CONTRIBUTING.md: Standard project documentation and licensing files.
B. RooFlow Core Integration
• System Prompts Directory:
• .rooignore and .roomodes further configure what aspects of the project should be included/excluded in AI interactions.
• Roo Configuration (roo_config Directory):
• Contains environment variable setup scripts for both Windows (insert-variables.cmd) and Unix/Mac (insert-variables.sh).
• The default-mode subdirectory (if enabled) holds files for custom AI assistant behavior: custom instructions (custom-instructions.yaml), role definitions (role-definition.txt), custom modes (cline_custom_modes.json) and accompanying documentation.
C. Optional Enhancements
• Memory Bank Templates:
• If enabled, the memory-bank directory holds templates (with its own README) for storing project-specific context across AI sessions.
• UVX Integration (for enhanced package management):
• Additional directories and files (.uv, uv.toml, uv-setup.cmd, uv-setup.sh, requirements.txt) provide configuration for UVX, including a virtual environment setup.
Inter-component Relationships & Data Flow
• The cookiecutter engine uses the cookiecutter.json configuration to scaffold the projects, injecting project-specific values into every generated file.
• The system prompt components (.roo in different locations) serve as the interface for the AI assistant, controlling mode switches (code, architect, debug, etc.).
• The roo_config directory not only holds configuration aspects but also provides environment variable setup scripts that bind the local development context to the AI assistant.
• If memory bank templates are included, they act as a repository that the AI can tap into for context propagation.
Architectural Patterns & Technologies
• The template encourages a separation-of-concerns:
• System prompt management for AI operations,
• Configuration and environment setup (separate scripts for Windows vs Unix/Mac),
• Extensibility through default mode settings and memory bank usage.
• That the architectural style leans towards a modular and extensible design where each component (system prompts, configuration, memory bank, etc.) can be developed or modified independently.
• Technologies involved include Python 3.6+ (for the template’s runtime), Cookiecutter itself, and optionally UVX for package management.