feat(scripts): add plugin installation mechanism for consumer projects
Add three new scripts for installing marketplace plugins to consumer projects: - install-plugin.sh: Install plugin to target project (.mcp.json + CLAUDE.md) - uninstall-plugin.sh: Remove plugin from target project - list-installed.sh: Show installed/available plugins in a project Features: - Idempotent operations (safe to run multiple times) - Handles plugins with/without MCP servers - Code block aware CLAUDE.md section removal - Flexible header format detection Documentation updated in docs/CONFIGURATION.md with usage examples. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
337
scripts/install-plugin.sh
Executable file
337
scripts/install-plugin.sh
Executable file
@@ -0,0 +1,337 @@
|
||||
#!/usr/bin/env bash
|
||||
# =============================================================================
|
||||
# install-plugin.sh - Install marketplace plugin to a consumer project
|
||||
# =============================================================================
|
||||
#
|
||||
# Usage: ./scripts/install-plugin.sh <plugin-name> <target-project-path>
|
||||
#
|
||||
# This script:
|
||||
# 1. Validates plugin exists in the marketplace
|
||||
# 2. Updates target project's .mcp.json with MCP server entry (if applicable)
|
||||
# 3. Appends CLAUDE.md integration snippet to target project
|
||||
# 4. Is idempotent (safe to run multiple times)
|
||||
#
|
||||
# Examples:
|
||||
# ./scripts/install-plugin.sh data-platform ~/projects/personal-portfolio
|
||||
# ./scripts/install-plugin.sh projman /home/user/my-project
|
||||
#
|
||||
# =============================================================================
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
REPO_ROOT="$(dirname "$SCRIPT_DIR")"
|
||||
|
||||
# --- Color Definitions ---
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
CYAN='\033[0;36m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# --- Logging Functions ---
|
||||
log_info() { echo -e "${BLUE}[INFO]${NC} $1"; }
|
||||
log_success() { echo -e "${GREEN}[OK]${NC} $1"; }
|
||||
log_skip() { echo -e "${YELLOW}[SKIP]${NC} $1"; }
|
||||
log_error() { echo -e "${RED}[ERROR]${NC} $1"; }
|
||||
log_warning() { echo -e "${YELLOW}[WARN]${NC} $1"; }
|
||||
|
||||
# --- Track Changes ---
|
||||
CHANGES_MADE=()
|
||||
SKIPPED=()
|
||||
|
||||
# --- Usage ---
|
||||
usage() {
|
||||
echo "Usage: $0 <plugin-name> <target-project-path>"
|
||||
echo ""
|
||||
echo "Install a marketplace plugin to a consumer project."
|
||||
echo ""
|
||||
echo "Arguments:"
|
||||
echo " plugin-name Name of the plugin (e.g., data-platform, viz-platform, projman)"
|
||||
echo " target-project-path Path to the target project (absolute or relative)"
|
||||
echo ""
|
||||
echo "Available plugins:"
|
||||
for dir in "$REPO_ROOT"/plugins/*/; do
|
||||
if [[ -d "$dir" ]]; then
|
||||
basename "$dir"
|
||||
fi
|
||||
done
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 data-platform ~/projects/personal-portfolio"
|
||||
echo " $0 projman /home/user/my-project"
|
||||
exit 1
|
||||
}
|
||||
|
||||
# --- Prerequisite Check ---
|
||||
check_prerequisites() {
|
||||
if ! command -v jq &> /dev/null; then
|
||||
log_error "jq is required but not installed."
|
||||
echo "Install with: sudo apt install jq"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
# --- Validate Plugin Exists ---
|
||||
validate_plugin() {
|
||||
local plugin_name="$1"
|
||||
local plugin_dir="$REPO_ROOT/plugins/$plugin_name"
|
||||
|
||||
if [[ ! -d "$plugin_dir" ]]; then
|
||||
log_error "Plugin '$plugin_name' not found in $REPO_ROOT/plugins/"
|
||||
echo ""
|
||||
echo "Available plugins:"
|
||||
for dir in "$REPO_ROOT"/plugins/*/; do
|
||||
if [[ -d "$dir" ]]; then
|
||||
echo " - $(basename "$dir")"
|
||||
fi
|
||||
done
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [[ ! -f "$plugin_dir/.claude-plugin/plugin.json" ]]; then
|
||||
log_error "Plugin '$plugin_name' missing .claude-plugin/plugin.json"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
log_success "Plugin '$plugin_name' found"
|
||||
}
|
||||
|
||||
# --- Validate Target Project ---
|
||||
validate_target() {
|
||||
local target_path="$1"
|
||||
|
||||
if [[ ! -d "$target_path" ]]; then
|
||||
log_error "Target project path does not exist: $target_path"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
log_success "Target project found: $target_path"
|
||||
|
||||
# Warn if no CLAUDE.md
|
||||
if [[ ! -f "$target_path/CLAUDE.md" ]]; then
|
||||
log_warning "Target project has no CLAUDE.md - will create one"
|
||||
fi
|
||||
}
|
||||
|
||||
# --- Check if MCP Server Exists for Plugin ---
|
||||
has_mcp_server() {
|
||||
local plugin_name="$1"
|
||||
local mcp_dir="$REPO_ROOT/mcp-servers/$plugin_name"
|
||||
|
||||
if [[ -d "$mcp_dir" && -f "$mcp_dir/run.sh" ]]; then
|
||||
return 0
|
||||
fi
|
||||
return 1
|
||||
}
|
||||
|
||||
# --- Update .mcp.json ---
|
||||
update_mcp_json() {
|
||||
local plugin_name="$1"
|
||||
local target_path="$2"
|
||||
local mcp_json="$target_path/.mcp.json"
|
||||
local mcp_server_path="$REPO_ROOT/mcp-servers/$plugin_name/run.sh"
|
||||
|
||||
# Check if plugin has MCP server
|
||||
if ! has_mcp_server "$plugin_name"; then
|
||||
log_skip "Plugin '$plugin_name' has no MCP server - skipping .mcp.json update"
|
||||
SKIPPED+=(".mcp.json: No MCP server for $plugin_name")
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Create .mcp.json if it doesn't exist
|
||||
if [[ ! -f "$mcp_json" ]]; then
|
||||
log_info "Creating new .mcp.json"
|
||||
echo '{"mcpServers":{}}' > "$mcp_json"
|
||||
CHANGES_MADE+=("Created .mcp.json")
|
||||
fi
|
||||
|
||||
# Check if entry already exists
|
||||
if jq -e ".mcpServers[\"$plugin_name\"]" "$mcp_json" > /dev/null 2>&1; then
|
||||
log_skip "MCP server '$plugin_name' already in .mcp.json"
|
||||
SKIPPED+=(".mcp.json: $plugin_name already present")
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Add MCP server entry
|
||||
log_info "Adding MCP server '$plugin_name' to .mcp.json"
|
||||
local tmp_file=$(mktemp)
|
||||
jq ".mcpServers[\"$plugin_name\"] = {\"command\": \"$mcp_server_path\", \"args\": []}" "$mcp_json" > "$tmp_file"
|
||||
mv "$tmp_file" "$mcp_json"
|
||||
|
||||
CHANGES_MADE+=("Added $plugin_name to .mcp.json")
|
||||
log_success "Added MCP server entry for '$plugin_name'"
|
||||
}
|
||||
|
||||
# --- Update CLAUDE.md ---
|
||||
update_claude_md() {
|
||||
local plugin_name="$1"
|
||||
local target_path="$2"
|
||||
local target_claude_md="$target_path/CLAUDE.md"
|
||||
local integration_file="$REPO_ROOT/plugins/$plugin_name/claude-md-integration.md"
|
||||
|
||||
# Check if integration file exists
|
||||
if [[ ! -f "$integration_file" ]]; then
|
||||
log_skip "No claude-md-integration.md for plugin '$plugin_name'"
|
||||
SKIPPED+=("CLAUDE.md: No integration snippet for $plugin_name")
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Create CLAUDE.md if it doesn't exist
|
||||
if [[ ! -f "$target_claude_md" ]]; then
|
||||
log_info "Creating new CLAUDE.md"
|
||||
cat > "$target_claude_md" << 'EOF'
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code when working with code in this repository.
|
||||
|
||||
EOF
|
||||
CHANGES_MADE+=("Created CLAUDE.md")
|
||||
fi
|
||||
|
||||
# Read integration content
|
||||
local integration_content
|
||||
integration_content=$(cat "$integration_file")
|
||||
|
||||
# Extract the first line (# header) to use as marker for detection
|
||||
local header_marker
|
||||
header_marker=$(head -1 "$integration_file")
|
||||
|
||||
# Check if already integrated - look for the integration file's header
|
||||
# Handles both formats: "# {name} Plugin - CLAUDE.md Integration" and "# {name} CLAUDE.md Integration"
|
||||
if grep -qE "^# ${plugin_name}( Plugin)? -? ?CLAUDE\.md Integration" "$target_claude_md" 2>/dev/null; then
|
||||
log_skip "Plugin '$plugin_name' integration already in CLAUDE.md"
|
||||
SKIPPED+=("CLAUDE.md: $plugin_name already present")
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Check for or create Marketplace Plugin Integration section
|
||||
local section_header="## Marketplace Plugin Integration"
|
||||
|
||||
if ! grep -qF "$section_header" "$target_claude_md"; then
|
||||
log_info "Creating '$section_header' section"
|
||||
echo "" >> "$target_claude_md"
|
||||
echo "$section_header" >> "$target_claude_md"
|
||||
echo "" >> "$target_claude_md"
|
||||
echo "The following plugins are installed from the leo-claude-mktplace:" >> "$target_claude_md"
|
||||
echo "" >> "$target_claude_md"
|
||||
fi
|
||||
|
||||
# Append integration content
|
||||
log_info "Adding '$plugin_name' integration to CLAUDE.md"
|
||||
echo "" >> "$target_claude_md"
|
||||
echo "---" >> "$target_claude_md"
|
||||
echo "" >> "$target_claude_md"
|
||||
echo "$integration_content" >> "$target_claude_md"
|
||||
|
||||
CHANGES_MADE+=("Added $plugin_name integration to CLAUDE.md")
|
||||
log_success "Added CLAUDE.md integration for '$plugin_name'"
|
||||
}
|
||||
|
||||
# --- Get Commands for Plugin ---
|
||||
get_plugin_commands() {
|
||||
local plugin_name="$1"
|
||||
local commands_dir="$REPO_ROOT/plugins/$plugin_name/commands"
|
||||
|
||||
if [[ ! -d "$commands_dir" ]]; then
|
||||
return
|
||||
fi
|
||||
|
||||
for cmd_file in "$commands_dir"/*.md; do
|
||||
if [[ -f "$cmd_file" ]]; then
|
||||
local cmd_name
|
||||
cmd_name=$(basename "$cmd_file" .md)
|
||||
echo " /$cmd_name"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# --- Print Summary ---
|
||||
print_summary() {
|
||||
local plugin_name="$1"
|
||||
local target_path="$2"
|
||||
|
||||
echo ""
|
||||
echo "=============================================="
|
||||
echo -e "${GREEN}Installation Summary${NC}"
|
||||
echo "=============================================="
|
||||
echo ""
|
||||
echo -e "${CYAN}Plugin:${NC} $plugin_name"
|
||||
echo -e "${CYAN}Target:${NC} $target_path"
|
||||
echo ""
|
||||
|
||||
if [[ ${#CHANGES_MADE[@]} -gt 0 ]]; then
|
||||
echo -e "${GREEN}Changes Made:${NC}"
|
||||
for change in "${CHANGES_MADE[@]}"; do
|
||||
echo " ✓ $change"
|
||||
done
|
||||
echo ""
|
||||
fi
|
||||
|
||||
if [[ ${#SKIPPED[@]} -gt 0 ]]; then
|
||||
echo -e "${YELLOW}Skipped (already present or N/A):${NC}"
|
||||
for skip in "${SKIPPED[@]}"; do
|
||||
echo " - $skip"
|
||||
done
|
||||
echo ""
|
||||
fi
|
||||
|
||||
# Show available commands
|
||||
echo -e "${CYAN}Commands Now Available:${NC}"
|
||||
local commands
|
||||
commands=$(get_plugin_commands "$plugin_name")
|
||||
if [[ -n "$commands" ]]; then
|
||||
echo "$commands"
|
||||
else
|
||||
echo " (No commands - this plugin may be hooks-only)"
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# MCP tools reminder
|
||||
if has_mcp_server "$plugin_name"; then
|
||||
echo -e "${CYAN}MCP Tools:${NC}"
|
||||
echo " This plugin includes MCP server tools. Use ToolSearch to discover them."
|
||||
echo ""
|
||||
fi
|
||||
|
||||
# Important reminder
|
||||
echo -e "${YELLOW}⚠️ IMPORTANT:${NC}"
|
||||
echo " Restart your Claude Code session for changes to take effect."
|
||||
echo " The .mcp.json changes require a session restart to load MCP servers."
|
||||
echo ""
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Main Execution
|
||||
# =============================================================================
|
||||
|
||||
# Check arguments
|
||||
if [[ $# -lt 2 ]]; then
|
||||
usage
|
||||
fi
|
||||
|
||||
PLUGIN_NAME="$1"
|
||||
TARGET_PATH="$2"
|
||||
|
||||
# Resolve target path to absolute
|
||||
TARGET_PATH=$(cd "$TARGET_PATH" 2>/dev/null && pwd || echo "$TARGET_PATH")
|
||||
|
||||
echo ""
|
||||
echo "=============================================="
|
||||
echo -e "${BLUE}Installing Plugin: $PLUGIN_NAME${NC}"
|
||||
echo "=============================================="
|
||||
echo ""
|
||||
|
||||
# Run checks
|
||||
check_prerequisites
|
||||
validate_plugin "$PLUGIN_NAME"
|
||||
validate_target "$TARGET_PATH"
|
||||
|
||||
echo ""
|
||||
|
||||
# Perform installation
|
||||
update_mcp_json "$PLUGIN_NAME" "$TARGET_PATH"
|
||||
update_claude_md "$PLUGIN_NAME" "$TARGET_PATH"
|
||||
|
||||
# Print summary
|
||||
print_summary "$PLUGIN_NAME" "$TARGET_PATH"
|
||||
Reference in New Issue
Block a user