Skip to content

๐Ÿง  Intelligent project memory system for Windsurf IDE. Empowers Cascade AI to maintain deep context across sessions, automatically documenting decisions, progress, and architectural evolution. Perfect for complex projects that demand consistent understanding over time.

Notifications You must be signed in to change notification settings

GreatScottyMac/cascade-memory-bank

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

35 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿง  Cascade Memory Bank

Enhance your Windsurf IDE experience with persistent project memory. Cascade Memory Bank enables the Cascade AI assistant to maintain deep project understanding across sessions, automatically documenting important context, decisions, and progress.

๐Ÿš€ Quick Start

Install

1. Download or copy the contents of these files:

  • .windsurfrules - Copy to your project root or paste into "Add workspace rules"

  • Optionally: Paste into "Add global rules"

    Prompt Settings Icon

2. Turn off "Auto-Generate Memories": [Ctrl + ,] - Configuration - Auto-Generate Memories

Prompt Settings Icon


Start Using

  • Begin by telling Cascade: "Follow the protocol in your rules" (you may also include the initial task)
  • Memory bank initializes and loads all context
  • Project context updates automatically in real-time
  • Use "Update Memory Bank" or "UMB" trigger for manual updates (defined in .windsurfrules)

๐Ÿ“ Memory Bank Structure

The system maintains context through a memory-bank/ directory containing four core files:

Core Files

File Purpose Updates
activeContext.md Tracks session state and goals Every session
productContext.md Defines project scope and architecture When scope changes
progress.md Tracks work status and milestones As tasks progress
decisionLog.md Records important decisions When decisions made

๐ŸŽฏ Benefits

  • Enhanced Productivity

    • No context loss between sessions
    • Reduced onboarding time for new tasks
    • Automatic documentation maintenance
  • Better Project Understanding

    • Comprehensive decision history
    • Clear project evolution tracking
    • Maintained architectural context
  • Reduced Cognitive Load

    • No manual note-taking needed
    • Important context always available
    • Natural conversation flow

๐Ÿ“˜ Usage Tips

  • Real-Time Updates

    • Context updates happen automatically
    • Changes are logged immediately
    • Use "update memory bank" or "UMB" for manual updates if needed
  • Focus on Your Work

    • Documentation happens automatically
    • Important context is preserved
    • Project history maintains itself

๐Ÿ“ License

MIT License - See LICENSE file for details

๐Ÿค Contributing

Contributions welcome! Please read our Contributing Guidelines first.

โค๏ธ Support the Project

If you find Cascade Memory Bank valuable in your development workflow, consider becoming a sponsor. Your support helps maintain and improve the project!

About

๐Ÿง  Intelligent project memory system for Windsurf IDE. Empowers Cascade AI to maintain deep context across sessions, automatically documenting decisions, progress, and architectural evolution. Perfect for complex projects that demand consistent understanding over time.

Resources

Contributing

Stars

Watchers

Forks

Packages

No packages published