mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-17 09:46:06 +00:00

feat: comprehensive framework improvements (#447 )

* refactor(docs): move core docs into framework/business/research (move-only)

- framework/: principles, rules, flags (思想・行動規範)
- business/: symbols, examples (ビジネス領域)
- research/: config (調査設定)
- All files renamed to lowercase for consistency

* docs: update references to new directory structure

- Update ~/.claude/CLAUDE.md with new paths
- Add migration notice in core/MOVED.md
- Remove pm.md.backup
- All @superclaude/ references now point to framework/business/research/

* fix(setup): update framework_docs to use new directory structure

- Add validate_prerequisites() override for multi-directory validation
- Add _get_source_dirs() for framework/business/research directories
- Override _discover_component_files() for multi-directory discovery
- Override get_files_to_install() for relative path handling
- Fix get_size_estimate() to use get_files_to_install()
- Fix uninstall/update/validate to use install_component_subdir

Fixes installation validation errors for new directory structure.

Tested: make dev installs successfully with new structure
  - framework/: flags.md, principles.md, rules.md
  - business/: examples.md, symbols.md
  - research/: config.md

* refactor(modes): update component references for docs restructure

* chore: remove redundant docs after PLANNING.md migration

Cleanup after Self-Improvement Loop implementation:

**Deleted (21 files, ~210KB)**:
- docs/Development/ - All content migrated to PLANNING.md & TASK.md
  * ARCHITECTURE.md (15KB) → PLANNING.md
  * TASKS.md (3.7KB) → TASK.md
  * ROADMAP.md (11KB) → TASK.md
  * PROJECT_STATUS.md (4.2KB) → outdated
  * 13 PM Agent research files → archived in KNOWLEDGE.md
- docs/PM_AGENT.md - Old implementation status
- docs/pm-agent-implementation-status.md - Duplicate
- docs/templates/ - Empty directory

**Retained (valuable documentation)**:
- docs/memory/ - Active session metrics & context
- docs/patterns/ - Reusable patterns
- docs/research/ - Research reports
- docs/user-guide*/ - User documentation (4 languages)
- docs/reference/ - Reference materials
- docs/getting-started/ - Quick start guides
- docs/agents/ - Agent-specific guides
- docs/testing/ - Test procedures

**Result**:
- Eliminated redundancy after Root Documents consolidation
- Preserved all valuable content in PLANNING.md, TASK.md, KNOWLEDGE.md
- Maintained user-facing documentation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: relocate PM modules to commands/modules

- Move modules to superclaude/commands/modules/
- Organize command-specific modules under commands/

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add self-improvement loop with 4 root documents

Implements Self-Improvement Loop based on Cursor's proven patterns:

**New Root Documents**:
- PLANNING.md: Architecture, design principles, 10 absolute rules
- TASK.md: Current tasks with priority (🔴🟡🟢⚪)
- KNOWLEDGE.md: Accumulated insights, best practices, failures
- README.md: Updated with developer documentation links

**Key Features**:
- Session Start Protocol: Read docs → Git status → Token budget → Ready
- Evidence-Based Development: No guessing, always verify
- Parallel Execution Default: Wave → Checkpoint → Wave pattern
- Mac Environment Protection: Docker-first, no host pollution
- Failure Pattern Learning: Past mistakes become prevention rules

**Cleanup**:
- Removed: docs/memory/checkpoint.json, current_plan.json (migrated to TASK.md)
- Enhanced: setup/components/commands.py (module discovery)

**Benefits**:
- LLM reads rules at session start → consistent quality
- Past failures documented → no repeats
- Progressive knowledge accumulation → continuous improvement
- 3.5x faster execution with parallel patterns

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* test: validate Self-Improvement Loop workflow

Tested complete cycle: Read docs → Extract rules → Execute task → Update docs

Test Results:
- Session Start Protocol: ✅ All 6 steps successful
- Rule Extraction: ✅ 10/10 absolute rules identified from PLANNING.md
- Task Identification: ✅ Next tasks identified from TASK.md
- Knowledge Application: ✅ Failure patterns accessed from KNOWLEDGE.md
- Documentation Update: ✅ TASK.md and KNOWLEDGE.md updated with completed work
- Confidence Score: 95% (exceeds 70% threshold)

Proved Self-Improvement Loop closes: Execute → Learn → Update → Improve

* refactor: responsibility-driven component architecture

Rename components to reflect their responsibilities:
- framework_docs.py → knowledge_base.py (KnowledgeBaseComponent)
- modes.py → behavior_modes.py (BehaviorModesComponent)
- agents.py → agent_personas.py (AgentPersonasComponent)
- commands.py → slash_commands.py (SlashCommandsComponent)
- mcp.py → mcp_integration.py (MCPIntegrationComponent)

Each component now clearly documents its responsibility:
- knowledge_base: Framework knowledge initialization
- behavior_modes: Execution mode definitions
- agent_personas: AI agent personality definitions
- slash_commands: CLI command registration
- mcp_integration: External tool integration

Benefits:
- Self-documenting architecture
- Clear responsibility boundaries
- Easy to navigate and extend
- Scalable for future hierarchical organization

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: add project-specific CLAUDE.md with UV rules

- Document UV as required Python package manager
- Add common operations and integration examples
- Document project structure and component architecture
- Provide development workflow guidelines

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: resolve installation failures after framework_docs rename

## Problems Fixed
1. **Syntax errors**: Duplicate docstrings in all component files (line 1)
2. **Dependency mismatch**: Stale framework_docs references after rename to knowledge_base

## Changes
- Fix docstring format in all component files (behavior_modes, agent_personas, slash_commands, mcp_integration)
- Update all dependency references: framework_docs → knowledge_base
- Update component registration calls in knowledge_base.py (5 locations)
- Update install.py files in both setup/ and superclaude/ (5 locations total)
- Fix documentation links in README-ja.md and README-zh.md

## Verification
✅ All components load successfully without syntax errors
✅ Dependency resolution works correctly
✅ Installation completes in 0.5s with all validations passing
✅ make dev succeeds

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: add automated README translation workflow

## New Features
- **Auto-translation workflow** using GPT-Translate
- Automatically translates README.md to Chinese (ZH) and Japanese (JA)
- Triggers on README.md changes to master/main branches
- Cost-effective: ~¥90/month for typical usage

## Implementation Details
- Uses OpenAI GPT-4 for high-quality translations
- GitHub Actions integration with gpt-translate@v1.1.11
- Secure API key management via GitHub Secrets
- Automatic commit and PR creation on translation updates

## Files Added
- `.github/workflows/translation-sync.yml` - Auto-translation workflow
- `docs/Development/translation-workflow.md` - Setup guide and documentation

## Setup Required
Add `OPENAI_API_KEY` to GitHub repository secrets to enable auto-translation.

## Benefits
- 🤖 Automated translation on every README update
- 💰 Low cost (~$0.06 per translation)
- 🛡️ Secure API key storage
- 🔄 Consistent translation quality across languages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix(mcp): update airis-mcp-gateway URL to correct organization

Fixes #440

## Problem
Code referenced non-existent `oraios/airis-mcp-gateway` repository,
causing MCP installation to fail completely.

## Root Cause
- Repository was moved to organization: `agiletec-inc/airis-mcp-gateway`
- Old reference `oraios/airis-mcp-gateway` no longer exists
- Users reported "not a python/uv module" error

## Changes
- Update install_command URL: oraios → agiletec-inc
- Update run_command URL: oraios → agiletec-inc
- Location: setup/components/mcp_integration.py lines 37-38

## Verification
✅ Correct URL now references active repository
✅ MCP installation will succeed with proper organization
✅ No other code references oraios/airis-mcp-gateway

## Related Issues
- Fixes #440 (Airis-mcp-gateway url has changed)
- Related to #442 (MCP update issues)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: replace cloud translation with local Neural CLI

## Changes

### Removed (OpenAI-dependent)
- ❌ `.github/workflows/translation-sync.yml` - GPT-Translate workflow
- ❌ `docs/Development/translation-workflow.md` - OpenAI setup docs

### Added (Local Ollama-based)
- ✅ `Makefile`: New `make translate` target using Neural CLI
- ✅ `docs/Development/translation-guide.md` - Neural CLI guide

## Benefits

**Before (GPT-Translate)**:
- 💰 Monthly cost: ~¥90 (OpenAI API)
- 🔑 Requires API key setup
- 🌐 Data sent to external API
- ⏱️ Network latency

**After (Neural CLI)**:
- ✅ **$0 cost** - Fully local execution
- ✅ **No API keys** - Zero setup friction
- ✅ **Privacy** - No external data transfer
- ✅ **Fast** - ~1-2 min per README
- ✅ **Offline capable** - Works without internet

## Technical Details

**Neural CLI**:
- Built in Rust with Tauri
- Uses Ollama + qwen2.5:3b model
- Binary size: 4.0MB
- Auto-installs to ~/.local/bin/

**Usage**:
```bash
make translate  # Translates README.md → README-zh.md, README-ja.md
```

## Requirements

- Ollama installed: `curl -fsSL https://ollama.com/install.sh | sh`
- Model downloaded: `ollama pull qwen2.5:3b`
- Neural CLI built: `cd ~/github/neural/src-tauri && cargo build --bin neural-cli --release`

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
Co-authored-by: Claude <noreply@anthropic.com>

2025-10-18 20:28:10 +05:30

16 KiB

Raw Blame History

🚀 SuperClaude Framework

Transform Claude Code into a Structured Development Platform

Quick Start • Support • Features • Docs • Contributing

📊 Framework Statistics

Commands	Agents	Modes	MCP Servers
26	16	7	8
Slash Commands	Specialized AI	Behavioral	Integrations

Use the new /sc:help command to see a full list of all available commands.

🎯 Overview

SuperClaude is a meta-programming configuration framework that transforms Claude Code into a structured development platform through behavioral instruction injection and component orchestration. It provides systematic workflow automation with powerful tools and intelligent agents.

Disclaimer

This project is not affiliated with or endorsed by Anthropic. Claude Code is a product built and maintained by Anthropic.

📖 For Developers & Contributors

Essential documentation for working with SuperClaude Framework:

Document	Purpose	When to Read
PLANNING.md	Architecture, design principles, absolute rules	Session start, before implementation
TASK.md	Current tasks, priorities, backlog	Daily, before starting work
KNOWLEDGE.md	Accumulated insights, best practices, troubleshooting	When encountering issues, learning patterns
CONTRIBUTING.md	Contribution guidelines, workflow	Before submitting PRs

💡 Pro Tip: Claude Code reads these files at session start to ensure consistent, high-quality development aligned with project standards.

⚡ Quick Installation

Choose Your Installation Method

Method	Command	Best For
🐍 pipx	`pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install`	✅ Recommended - Linux/macOS
📦 pip	`pip install SuperClaude && pip upgrade SuperClaude && SuperClaude install`	Traditional Python environments
🌐 npm	`npm install -g @bifrost_inc/superclaude && superclaude install`	Cross-platform, Node.js users

⚠️ IMPORTANT: Upgrading from SuperClaude V3

If you have SuperClaude V3 installed, you SHOULD uninstall it before installing V4:

# Uninstall V3 first
Remove all related files and directories :
*.md *.json and commands/

# Then install V4
pipx install SuperClaude && pipx upgrade SuperClaude && SuperClaude install

✅ What gets preserved during upgrade:

✓ Your custom slash commands (outside commands/sc/)
✓ Your custom content in CLAUDE.md
✓ Claude Code's .claude.json, .credentials.json, settings.json and settings.local.json
✓ Any custom agents and files you've added

⚠️ Note: Other SuperClaude-related .json files from V3 may cause conflicts and should be removed.

💡 Troubleshooting PEP 668 Errors

# Option 1: Use pipx (Recommended)
pipx install SuperClaude

# Option 2: User installation
pip install --user SuperClaude

# Option 3: Force installation (use with caution)
pip install --break-system-packages SuperClaude

💖 Support the Project

Hey, let's be real - maintaining SuperClaude takes time and resources.

The Claude Max subscription alone runs $100/month for testing, and that's before counting the hours spent on documentation, bug fixes, and feature development. If you're finding value in SuperClaude for your daily work, consider supporting the project. Even a few dollars helps cover the basics and keeps development active.

Every contributor matters, whether through code, feedback, or support. Thanks for being part of this community! 🙏

☕ Ko-fi

One-time contributions

🎯 Patreon

Monthly support

💜 GitHub

Flexible tiers

Your Support Enables:

Item	Cost/Impact
🔬 Claude Max Testing	$100/month for validation & testing
⚡ Feature Development	New capabilities & improvements
📚 Documentation	Comprehensive guides & examples
🤝 Community Support	Quick issue responses & help
🔧 MCP Integration	Testing new server connections
🌐 Infrastructure	Hosting & deployment costs

Note: No pressure though - the framework stays open source regardless. Just knowing people use and appreciate it is motivating. Contributing code, documentation, or spreading the word helps too! 🙏

🎉 What's New in V4

Version 4 brings significant improvements based on community feedback and real-world usage patterns.

🤖 Smarter Agent System

16 specialized agents with domain expertise:

PM Agent ensures continuous learning through systematic documentation
Deep Research agent for autonomous web research
Security engineer catches real vulnerabilities
Frontend architect understands UI patterns
Automatic coordination based on context
Domain-specific expertise on demand

📝 Improved Namespace

/sc: prefix for all commands:

No conflicts with custom commands
25 commands covering full lifecycle
From brainstorming to deployment
Clean, organized command structure

🔧 MCP Server Integration

8 powerful servers working together:

Context7 → Up-to-date documentation
Sequential → Complex analysis
Magic → UI component generation
Playwright → Browser testing
Morphllm → Bulk transformations
Serena → Session persistence
Tavily → Web search for deep research
Chrome DevTools → Performance analysis

🎯 Behavioral Modes

7 adaptive modes for different contexts:

Brainstorming → Asks right questions
Business Panel → Multi-expert strategic analysis
Deep Research → Autonomous web research
Orchestration → Efficient tool coordination
Token-Efficiency → 30-50% context savings
Task Management → Systematic organization
Introspection → Meta-cognitive analysis

⚡ Optimized Performance

Smaller framework, bigger projects:

Reduced framework footprint
More context for your code
Longer conversations possible
Complex operations enabled

📚 Documentation Overhaul

Complete rewrite for developers:

Real examples & use cases
Common pitfalls documented
Practical workflows included
Better navigation structure

🔬 Deep Research Capabilities

Autonomous Web Research Aligned with DR Agent Architecture

SuperClaude v4.2 introduces comprehensive Deep Research capabilities, enabling autonomous, adaptive, and intelligent web research.

🎯 Adaptive Planning

Three intelligent strategies:

Planning-Only: Direct execution for clear queries
Intent-Planning: Clarification for ambiguous requests
Unified: Collaborative plan refinement (default)

🔄 Multi-Hop Reasoning

Up to 5 iterative searches:

Entity expansion (Paper → Authors → Works)
Concept deepening (Topic → Details → Examples)
Temporal progression (Current → Historical)
Causal chains (Effect → Cause → Prevention)

📊 Quality Scoring

Confidence-based validation:

Source credibility assessment (0.0-1.0)
Coverage completeness tracking
Synthesis coherence evaluation
Minimum threshold: 0.6, Target: 0.8

🧠 Case-Based Learning

Cross-session intelligence:

Pattern recognition and reuse
Strategy optimization over time
Successful query formulations saved
Performance improvement tracking

Research Command Usage

# Basic research with automatic depth
/sc:research "latest AI developments 2024"

# Controlled research depth
/sc:research "quantum computing breakthroughs" --depth exhaustive

# Specific strategy selection
/sc:research "market analysis" --strategy planning-only

# Domain-filtered research
/sc:research "React patterns" --domains "reactjs.org,github.com"

Research Depth Levels

Depth	Sources	Hops	Time	Best For
Quick	5-10	1	~2min	Quick facts, simple queries
Standard	10-20	3	~5min	General research (default)
Deep	20-40	4	~8min	Comprehensive analysis
Exhaustive	40+	5	~10min	Academic-level research

Integrated Tool Orchestration

The Deep Research system intelligently coordinates multiple tools:

Tavily MCP: Primary web search and discovery
Playwright MCP: Complex content extraction
Sequential MCP: Multi-step reasoning and synthesis
Serena MCP: Memory and learning persistence
Context7 MCP: Technical documentation lookup

📚 Documentation

Complete Guide to SuperClaude

🚀 Getting Started	📖 User Guides	🛠️ Developer Resources	📋 Reference
📝 Quick Start Guide Get up and running fast 💾 Installation Guide Detailed setup instructions	🎯 Commands Reference All 25 slash commands 🤖 Agents Guide 15 specialized agents 🎨 Behavioral Modes 7 adaptive modes 🚩 Flags Guide Control behaviors 🔧 MCP Servers 7 server integrations 💼 Session Management Save & restore state	🏗️ Technical Architecture System design details 💻 Contributing Code Development workflow 🧪 Testing & Debugging Quality assurance	- 📓 [Examples Cookbook](docs/reference/examples-cookbook.md) Real-world recipes 🔍 Troubleshooting Common issues & fixes

🤝 Contributing

Join the SuperClaude Community

We welcome contributions of all kinds! Here's how you can help:

Priority	Area	Description
📝 High	Documentation	Improve guides, add examples, fix typos
🔧 High	MCP Integration	Add server configs, test integrations
🎯 Medium	Workflows	Create command patterns & recipes
🧪 Medium	Testing	Add tests, validate features
🌐 Low	i18n	Translate docs to other languages

⚖️ License

This project is licensed under the MIT License - see the LICENSE file for details.

⭐ Star History

🚀 Built with passion by the SuperClaude community

_{Made with ❤️ for developers who push boundaries}

16 KiB Raw Blame History