Skip to content

Latest commit

 

History

History
177 lines (117 loc) · 3.23 KB

INSTALLATION.md

File metadata and controls

177 lines (117 loc) · 3.23 KB

Installation Guide

Prerequisites

  • Claude Code CLI installed and configured
  • Git (for cloning)

Installation Methods

Method 1: From GitHub (Recommended)

Add the marketplace and install the plugin:

# Add the marketplace
/plugin marketplace add https://github.com/{{GITHUB_USERNAME}}/{{REPO_NAME}}

# Install the plugin
/plugin install {{PLUGIN_NAME}}@{{PLUGIN_NAME}}-marketplace

Method 2: Local Installation (For Development)

Clone and install locally:

# Clone the repository
git clone https://github.com/{{GITHUB_USERNAME}}/{{REPO_NAME}}.git
cd {{REPO_NAME}}

# Add local marketplace
/plugin marketplace add /absolute/path/to/{{REPO_NAME}}

# Install the plugin
/plugin install {{PLUGIN_NAME}}@{{PLUGIN_NAME}}-marketplace

Note: Plugins must be part of a marketplace to be installed. This template includes both marketplace.json (defines the marketplace) and plugin.json (defines the plugin).

Verification

Verify the plugin is installed:

/plugin list

You should see {{PLUGIN_NAME}} in the list.

Enabling the Plugin

Enable the plugin to use it:

/plugin enable {{PLUGIN_NAME}}

Using the Plugin

Available Skills

List all skills provided by this plugin:

/plugin info {{PLUGIN_NAME}}

Trigger Skills

Use activation phrases to trigger skills. For example:

"run example skill"
"demonstrate example"

See README.md for full list of activation triggers.

Updating

Update from GitHub

/plugin update {{PLUGIN_NAME}}

Update from Local Clone

cd {{REPO_NAME}}
git pull origin main
/plugin update {{PLUGIN_NAME}}

Uninstallation

Remove the plugin:

/plugin uninstall {{PLUGIN_NAME}}

Troubleshooting

Plugin Not Found

Problem: /plugin list doesn't show the plugin

Solution:

  1. Verify installation succeeded
  2. Check for error messages during installation
  3. Try reinstalling: /plugin uninstall {{PLUGIN_NAME}} && /plugin install ...

Skills Not Triggering

Problem: Activation phrases don't work

Solution:

  1. Ensure plugin is enabled: /plugin enable {{PLUGIN_NAME}}
  2. Check exact activation phrases in skill.md files
  3. Try rephrasing your request

Permission Errors

Problem: Permission denied during installation

Solution:

# Ensure scripts are executable
chmod +x scripts/*.sh
chmod +x hooks/*.sh

Validation Failures

Problem: Pre-commit hook rejects changes

Solution:

# Run validation manually
./scripts/validate-all.sh

# Check specific issues
./scripts/validate-naming.sh .
./scripts/validate-json.sh .
./scripts/validate-frontmatter.sh .

Getting Help

Advanced Configuration

Custom Skill Paths

If you've customized skill locations, update .claude-plugin/plugin.json:

{
  "skills": [
    {
      "path": "custom/path/to/skill.md"
    }
  ]
}

Environment Variables

Some plugins may use environment variables. Check the plugin documentation for details.

For development and contributing, see CONTRIBUTING.md.