mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-18 10:16:49 +00:00
d5dfd7da21
* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
137 lines
5.4 KiB
Markdown
137 lines
5.4 KiB
Markdown
# 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
|
|
1. **Installation**: Python CLI installs context files to `~/.claude/`
|
|
2. **Commands**: Type `/sc:analyze` → Claude Code reads `analyze.md` instruction file
|
|
3. **Behavior**: Claude adopts behaviors defined in context files
|
|
4. **Result**: Enhanced development workflows through context switching
|
|
|
|
## 🚀 Quick Start (5 Minutes)
|
|
|
|
**New Users**: [Quick Start Guide →](getting-started/quick-start.md)
|
|
```bash
|
|
# 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 →](reference/common-issues.md) | [Troubleshooting →](reference/troubleshooting.md)
|
|
|
|
## 📚 Documentation Structure
|
|
|
|
### 🌱 Start Here (New Users)
|
|
| Guide | Purpose |
|
|
|-------|---------|
|
|
| **[Quick Start](getting-started/quick-start.md)** | Setup and first commands |
|
|
| **[Installation](getting-started/installation.md)** | Detailed setup instructions |
|
|
| **[Commands Guide](user-guide/commands.md)** | All 21 `/sc:` commands |
|
|
|
|
### 🌿 Daily Usage (Regular Users)
|
|
| Guide | Purpose | Use For |
|
|
|-------|---------|---------|
|
|
| **[Commands Guide](user-guide/commands.md)** | Master all `/sc:` commands | Daily development |
|
|
| **[Agents Guide](user-guide/agents.md)** | 14 domain specialists (`@agent-*`) | Expert assistance |
|
|
| **[Flags Guide](user-guide/flags.md)** | Command behavior modification | Optimization |
|
|
| **[Modes Guide](user-guide/modes.md)** | 5 behavioral modes | Workflow optimization |
|
|
|
|
### 🌲 Reference & Advanced (Power Users)
|
|
| Guide | Purpose | Use For |
|
|
|-------|---------|---------|
|
|
| **[Troubleshooting](reference/troubleshooting.md)** | Problem resolution | When things break |
|
|
| **[Examples Cookbook](reference/examples-cookbook.md)** | Practical usage patterns | Learning workflows |
|
|
| **[MCP Servers](user-guide/mcp-servers.md)** | 6 enhanced capabilities | Advanced features |
|
|
|
|
### 🔧 Development & Contributing
|
|
| Guide | Purpose | Audience |
|
|
|-------|---------|----------|
|
|
| **[Technical Architecture](developer-guide/technical-architecture.md)** | System design | Contributors |
|
|
| **[Contributing](developer-guide/contributing-code.md)** | Development workflow | Developers |
|
|
|
|
## 🔑 Key Concepts
|
|
|
|
### What Gets Installed
|
|
- **Python CLI Tool** - Manages framework installation
|
|
- **Context Files** - `.md` behavioral 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)
|
|
```bash
|
|
# 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)
|
|
```bash
|
|
/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 →](reference/common-issues.md)
|
|
**Complex Problems**: [Full Troubleshooting Guide →](reference/troubleshooting.md)
|
|
**Installation Issues**: [Installation Guide →](getting-started/installation.md)
|
|
**Command Help**: [Commands Guide →](user-guide/commands.md)
|
|
**Community Support**: [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/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.* |