diff --git a/Makefile b/Makefile index b3ae48c..b14a227 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: dev install test test-plugin doctor verify clean lint format help +.PHONY: dev install test test-plugin doctor verify clean lint format install-plugin uninstall-plugin reinstall-plugin help # Development installation (local source, editable) - RECOMMENDED dev: @@ -64,6 +64,46 @@ clean: find . -type d -name .pytest_cache -exec rm -rf {} + find . -type d -name .ruff_cache -exec rm -rf {} + +# Install Claude Code plugin +install-plugin: + @echo "🔌 Installing SuperClaude plugin to Claude Code..." + @if [ -d ~/.claude/plugins/pm-agent ]; then \ + echo "⚠️ Plugin already exists at ~/.claude/plugins/pm-agent"; \ + echo " Run 'make reinstall-plugin' to update"; \ + exit 1; \ + fi + @mkdir -p ~/.claude/plugins/pm-agent + @cp -r .claude-plugin/* ~/.claude/plugins/pm-agent/ + @echo "" + @echo "✅ Plugin installed successfully!" + @echo "" + @echo "📋 Installed components:" + @echo " - PM Agent: Auto-activation orchestrator (SessionStart hook)" + @echo " - Research: Deep web search with adaptive planning" + @echo " - Index: Repository indexing (94% token reduction)" + @echo "" + @echo "🔄 Restart Claude Code or run /plugin to verify installation" + @echo " Available commands: /pm, /research, /index-repo" + +# Uninstall Claude Code plugin +uninstall-plugin: + @echo "🗑️ Uninstalling SuperClaude plugin..." + @if [ ! -d ~/.claude/plugins/pm-agent ]; then \ + echo "❌ Plugin not found at ~/.claude/plugins/pm-agent"; \ + exit 1; \ + fi + @rm -rf ~/.claude/plugins/pm-agent + @echo "✅ Plugin uninstalled successfully" + +# Reinstall Claude Code plugin (uninstall + install) +reinstall-plugin: + @echo "🔄 Reinstalling SuperClaude plugin..." + @rm -rf ~/.claude/plugins/pm-agent 2>/dev/null || true + @mkdir -p ~/.claude/plugins/pm-agent + @cp -r .claude-plugin/* ~/.claude/plugins/pm-agent/ + @echo "✅ Plugin reinstalled successfully" + @echo "🔄 Restart Claude Code to apply changes" + # Translate README to multiple languages using Neural CLI translate: @echo "🌐 Translating README using Neural CLI (Ollama + qwen2.5:3b)..." @@ -90,6 +130,7 @@ help: @echo "🚀 Quick Start:" @echo " make dev - Install in development mode (RECOMMENDED)" @echo " make verify - Verify installation is working" + @echo " make install-plugin - Install plugin to Claude Code (~/.claude/plugins/)" @echo "" @echo "🔧 Development:" @echo " make test - Run test suite" @@ -99,6 +140,11 @@ help: @echo " make format - Format code (ruff format)" @echo " make clean - Clean build artifacts" @echo "" + @echo "🔌 Plugin Management:" + @echo " make install-plugin - Install plugin to Claude Code" + @echo " make uninstall-plugin - Remove plugin from Claude Code" + @echo " make reinstall-plugin - Update existing plugin installation" + @echo "" @echo "📚 Documentation:" @echo " make translate - Translate README to Chinese and Japanese" @echo " make help - Show this help message" diff --git a/README.md b/README.md index e7ad117..d0cf4aa 100644 --- a/README.md +++ b/README.md @@ -100,23 +100,33 @@ Claude Code is a product built and maintained by [Anthropic](https://www.anthrop ## ⚡ **Quick Installation** -### **Plugin Installation - Auto-Activation with Hot Reload** +### **One-Command Plugin Installation** -SuperClaude v2.0+ uses **TypeScript plugins** for instant updates and auto-activation: +SuperClaude v2.0+ uses **TypeScript plugins** with automated installer: ```bash -# Method 1: Plugin Marketplace (Recommended) -# Open Claude Code → /plugin marketplace → Search "pm-agent" → Install +# Clone repository +git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git +cd SuperClaude_Framework -# Method 2: Manual Installation -cd /Users/kazuki/github/superclaude -# Plugin auto-registers on session start via SessionStart hook +# Install plugin (one command) +make install-plugin +``` + +**That's it!** Restart Claude Code and the plugin auto-activates. + +**Plugin Management Commands**: +```bash +make install-plugin # Install plugin to ~/.claude/plugins/ +make uninstall-plugin # Remove plugin +make reinstall-plugin # Update existing installation ``` **Key Features**: +- ✅ **One-Command Install**: No manual configuration needed - ✅ **Hot Reload**: Edit TypeScript → Save → Instant reflection (no restart) - ✅ **Auto-Activation**: PM Agent starts automatically on session start -- ✅ **Zero Configuration**: Works out of the box +- ✅ **Zero Configuration**: Works out of the box after `make install-plugin` ### **Enhanced Performance (Optional MCPs)** @@ -148,13 +158,14 @@ For **2-3x faster** execution and **30-50% fewer tokens**, optionally install MC # 1. Remove old slash commands (if installed) rm -rf ~/.claude/commands/sc/ -# 2. Install new plugin -# Via Claude Code: /plugin marketplace → "pm-agent" -# Or clone repository to project directory +# 2. Install new plugin (one command) +cd SuperClaude_Framework +make install-plugin ``` **What's New in V2.0:** - ✅ TypeScript plugins (hot reload support) +- ✅ One-command installation (no manual config) - ✅ Auto-activation via SessionStart hook - ✅ 3 core plugins: PM Agent, Research, Index - ✅ Confidence-driven workflow (≥90% threshold, Precision/Recall 1.0) @@ -163,21 +174,39 @@ rm -rf ~/.claude/commands/sc/ - Old: `/sc:pm`, `/sc:research`, `/sc:index-repo` (27 commands) - New: `/pm`, `/research`, `/index-repo` (3 plugin commands) - Functionality improved with hot reload and auto-activation +- Installation: Manual file copying → `make install-plugin`
-💡 Troubleshooting PEP 668 Errors +💡 Installation Troubleshooting +**Plugin installation failed?** ```bash -# Option 1: Use pipx (Recommended) -pipx install SuperClaude +# Check if Claude Code is installed +which claude -# Option 2: User installation -pip install --user SuperClaude +# Verify plugin directory exists +ls ~/.claude/plugins/ -# Option 3: Force installation (use with caution) -pip install --break-system-packages SuperClaude +# Reinstall plugin +make reinstall-plugin + +# Check installation +ls ~/.claude/plugins/pm-agent/ +``` + +**Plugin not loading?** +- Restart Claude Code completely +- Run `/plugin` in Claude Code to verify installation +- Check that `.claude-plugin/plugin.json` exists in repository + +**Development mode (for contributors):** +```bash +# Install Python package for testing +make dev +make verify +uv run pytest ```