feat: add one-command plugin installer (make install-plugin)

**Problem:**
- Old installation method required manual file copying or complex marketplace setup
- Users had to run `/plugin marketplace add` + `/plugin install` (tedious)
- No automated installation workflow

**Solution:**
- Add `make install-plugin` for one-command installation
- Copies `.claude-plugin/` to `~/.claude/plugins/pm-agent/`
- Add `make uninstall-plugin` and `make reinstall-plugin`
- Update README.md with clear installation instructions

**Changes:**

Makefile:
- Add install-plugin target: Copy plugin to ~/.claude/plugins/
- Add uninstall-plugin target: Remove plugin
- Add reinstall-plugin target: Update existing installation
- Update help menu with plugin management section

README.md:
- Replace complex marketplace instructions with `make install-plugin`
- Add plugin management commands section
- Update troubleshooting guide
- Simplify migration guide from v1.x

**Installation Flow:**
```bash
git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
cd SuperClaude_Framework
make install-plugin
# Restart Claude Code → Plugin auto-activates
```

**Features:**
- One-command install (no manual config)
- Auto-activation via SessionStart hook
- Hot reload support (TypeScript)
- Clean uninstall/reinstall workflow

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
kazuki
2025-10-21 14:38:56 +09:00
parent 797a06cea3
commit a302ca7e86
2 changed files with 94 additions and 19 deletions

View File

@@ -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 # Development installation (local source, editable) - RECOMMENDED
dev: dev:
@@ -64,6 +64,46 @@ clean:
find . -type d -name .pytest_cache -exec rm -rf {} + find . -type d -name .pytest_cache -exec rm -rf {} +
find . -type d -name .ruff_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 README to multiple languages using Neural CLI
translate: translate:
@echo "🌐 Translating README using Neural CLI (Ollama + qwen2.5:3b)..." @echo "🌐 Translating README using Neural CLI (Ollama + qwen2.5:3b)..."
@@ -90,6 +130,7 @@ help:
@echo "🚀 Quick Start:" @echo "🚀 Quick Start:"
@echo " make dev - Install in development mode (RECOMMENDED)" @echo " make dev - Install in development mode (RECOMMENDED)"
@echo " make verify - Verify installation is working" @echo " make verify - Verify installation is working"
@echo " make install-plugin - Install plugin to Claude Code (~/.claude/plugins/)"
@echo "" @echo ""
@echo "🔧 Development:" @echo "🔧 Development:"
@echo " make test - Run test suite" @echo " make test - Run test suite"
@@ -99,6 +140,11 @@ help:
@echo " make format - Format code (ruff format)" @echo " make format - Format code (ruff format)"
@echo " make clean - Clean build artifacts" @echo " make clean - Clean build artifacts"
@echo "" @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 "📚 Documentation:"
@echo " make translate - Translate README to Chinese and Japanese" @echo " make translate - Translate README to Chinese and Japanese"
@echo " make help - Show this help message" @echo " make help - Show this help message"

View File

@@ -100,23 +100,33 @@ Claude Code is a product built and maintained by [Anthropic](https://www.anthrop
## ⚡ **Quick Installation** ## ⚡ **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 ```bash
# Method 1: Plugin Marketplace (Recommended) # Clone repository
# Open Claude Code → /plugin marketplace → Search "pm-agent" → Install git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git
cd SuperClaude_Framework
# Method 2: Manual Installation # Install plugin (one command)
cd /Users/kazuki/github/superclaude make install-plugin
# Plugin auto-registers on session start via SessionStart hook ```
**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**: **Key Features**:
-**One-Command Install**: No manual configuration needed
-**Hot Reload**: Edit TypeScript → Save → Instant reflection (no restart) -**Hot Reload**: Edit TypeScript → Save → Instant reflection (no restart)
-**Auto-Activation**: PM Agent starts automatically on session start -**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)** ### **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) # 1. Remove old slash commands (if installed)
rm -rf ~/.claude/commands/sc/ rm -rf ~/.claude/commands/sc/
# 2. Install new plugin # 2. Install new plugin (one command)
# Via Claude Code: /plugin marketplace → "pm-agent" cd SuperClaude_Framework
# Or clone repository to project directory make install-plugin
``` ```
**What's New in V2.0:** **What's New in V2.0:**
- ✅ TypeScript plugins (hot reload support) - ✅ TypeScript plugins (hot reload support)
- ✅ One-command installation (no manual config)
- ✅ Auto-activation via SessionStart hook - ✅ Auto-activation via SessionStart hook
- ✅ 3 core plugins: PM Agent, Research, Index - ✅ 3 core plugins: PM Agent, Research, Index
- ✅ Confidence-driven workflow (≥90% threshold, Precision/Recall 1.0) - ✅ 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) - Old: `/sc:pm`, `/sc:research`, `/sc:index-repo` (27 commands)
- New: `/pm`, `/research`, `/index-repo` (3 plugin commands) - New: `/pm`, `/research`, `/index-repo` (3 plugin commands)
- Functionality improved with hot reload and auto-activation - Functionality improved with hot reload and auto-activation
- Installation: Manual file copying → `make install-plugin`
</details> </details>
<details> <details>
<summary><b>💡 Troubleshooting PEP 668 Errors</b></summary> <summary><b>💡 Installation Troubleshooting</b></summary>
**Plugin installation failed?**
```bash ```bash
# Option 1: Use pipx (Recommended) # Check if Claude Code is installed
pipx install SuperClaude which claude
# Option 2: User installation # Verify plugin directory exists
pip install --user SuperClaude ls ~/.claude/plugins/
# Option 3: Force installation (use with caution) # Reinstall plugin
pip install --break-system-packages SuperClaude 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
``` ```
</details> </details>