mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-17 09:46:06 +00:00
bea4bfe289
* docs: fix mindbase syntax and document as optional MCP enhancement Fix incorrect method call syntax and clarify mindbase as optional enhancement that coexists with built-in ReflexionMemory. Changes: - Fix syntax: mindbase.search_conversations() → natural language instructions that allow Claude to autonomously select tools - Clarify mindbase requires airis-mcp-gateway "recommended" profile - Document ReflexionMemory as built-in fallback (always available) - Show coexistence model: both systems work together Architecture: - ReflexionMemory (built-in): Keyword-based search, local JSONL - Mindbase (optional MCP): Semantic search, PostgreSQL + pgvector - Claude autonomously selects best available tool when needed This approach allows users to enhance error learning with mindbase when installed, while maintaining full functionality with ReflexionMemory alone. Related: #452 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: add comprehensive ReflexionMemory user documentation Add user-facing documentation for the ReflexionMemory error learning system to address documentation gap identified during mindbase cleanup. New Documentation: - docs/user-guide/memory-system.md (283 lines) * Complete user guide for ReflexionMemory * How it works, storage format, usage examples * Performance benefits and troubleshooting * Manual inspection and management commands - docs/memory/reflexion.jsonl.example (15 entries) * 15 realistic example reflexion entries * Covers common scenarios: auth, DB, CORS, uploads, etc. * Reference for understanding the data format - docs/memory/README.md (277 lines) * Overview of memory directory structure * Explanation of all files (reflexion, metrics, patterns) * File management, backup, and git guidelines * Quick command reference Context: Previous mindbase cleanup removed references to non-existent external MCP server, but didn't add sufficient user-facing documentation for the actual ReflexionMemory implementation. Related: #452 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: translate Japanese text to English in documentation Address PR feedback to remove Japanese text from English documentation files. Changes: - docs/mcp/mcp-integration-policy.md: Translate headers and descriptions - docs/reference/pm-agent-autonomous-reflection.md: Translate error messages - docs/research/reflexion-integration-2025.md: Translate error messages - docs/memory/pm_context.md: Translate example keywords All Japanese text in English documentation files has been translated to English. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
SuperClaude Documentation
🎯 Essential Understanding
SuperClaude is a Context Framework for Claude Code - it installs behavioral instruction files that Claude Code reads to enhance its capabilities.
How It Works
- Installation: Python CLI installs context files to
~/.claude/ - Commands: Type
/sc:analyze→ Claude Code readsanalyze.mdinstruction file - Behavior: Claude adopts behaviors defined in context files
- Result: Enhanced development workflows through context switching
🚀 Quick Start (5 Minutes)
New Users: Quick Start Guide →
# Recommended for Linux/macOS
pipx install SuperClaude && SuperClaude install
# Traditional method
pip install SuperClaude && SuperClaude install
# Then try: /sc:brainstorm "web app idea" in Claude Code
Having Issues: Quick Fixes → | Troubleshooting →
📚 Documentation Structure
🌱 Start Here (New Users)
| Guide | Purpose |
|---|---|
| Quick Start | Setup and first commands |
| Installation | Detailed setup instructions |
| Commands Guide | All 21 /sc: commands |
🌿 Daily Usage (Regular Users)
| Guide | Purpose | Use For |
|---|---|---|
| Commands Guide | Master all /sc: commands |
Daily development |
| Agents Guide | 14 domain specialists (@agent-*) |
Expert assistance |
| Flags Guide | Command behavior modification | Optimization |
| Modes Guide | 5 behavioral modes | Workflow optimization |
🌲 Reference & Advanced (Power Users)
| Guide | Purpose | Use For |
|---|---|---|
| Troubleshooting | Problem resolution | When things break |
| Examples Cookbook | Practical usage patterns | Learning workflows |
| MCP Servers | 6 enhanced capabilities | Advanced features |
🔧 Development & Contributing
| Guide | Purpose | Audience |
|---|---|---|
| Technical Architecture | System design | Contributors |
| Contributing | Development workflow | Developers |
🔑 Key Concepts
What Gets Installed
- Python CLI Tool - Manages framework installation
- Context Files -
.mdbehavioral instructions in~/.claude/ - MCP Configurations - Optional external tool settings
Framework Components
- 21 Commands (
/sc:*) - Workflow automation patterns - 14 Agents (
@agent-*) - Domain specialists - 5 Modes - Behavioral modification patterns
- 6 MCP Servers - Optional external tools
🚀 Quick Command Reference
In Your Terminal (Installation)
# Install framework (choose one)
pipx install SuperClaude # Recommended for Linux/macOS
pip install SuperClaude # Traditional method
npm install -g @bifrost_inc/superclaude # Cross-platform
# Configure and maintain
SuperClaude install # Configure Claude Code
SuperClaude update # Update framework
python3 -m SuperClaude --version # Check installation
In Claude Code (Usage)
/sc:brainstorm "project idea" # Start new project
/sc:implement "feature" # Build features
/sc:analyze src/ # Analyze code
@agent-python-expert "optimize this" # Manual specialist
@agent-security "review authentication" # Security review
📊 Framework vs Software Comparison
| Component | Type | Where It Runs | What It Does |
|---|---|---|---|
| SuperClaude Framework | Context Files | Read by Claude Code | Modifies AI behavior |
| Claude Code | Software | Your computer | Executes everything |
| MCP Servers | Software | Node.js processes | Provide tools |
| Python CLI | Software | Python runtime | Manages installation |
🔄 How Everything Connects
User Input → Claude Code → Reads SuperClaude Context → Modified Behavior → Enhanced Output
↓
May use MCP Servers
(if configured)
🆘 Getting Help
Quick Issues (< 2 min): Common Issues →
Complex Problems: Full Troubleshooting Guide →
Installation Issues: Installation Guide →
Command Help: Commands Guide →
Community Support: GitHub Discussions
🤔 Common Misconceptions Clarified
❌ "SuperClaude is an AI assistant"
✅ SuperClaude is a configuration framework that enhances Claude Code
❌ "I'm running SuperClaude"
✅ You're running Claude Code with SuperClaude context loaded
❌ "Claude Code executes; SuperClaude provides context my commands"
✅ Claude Code executes everything; SuperClaude provides the instructions
❌ "The .md files are documentation"
✅ The .md files ARE the framework - active instruction sets
Remember: SuperClaude enhances Claude Code through context - it doesn't replace it or run alongside it. Everything happens within Claude Code itself.