Skip to content

SETUP.md

Latest commit

 

History

History
217 lines (159 loc) · 5.86 KB

SETUP.md

File metadata and controls

217 lines (159 loc) · 5.86 KB
Raw

Setup Instructions for Claude Code Plugins Repository

Current Status

Your repository structure has been created successfully with:

  • Main marketplace catalog source (.claude-plugin/marketplace.extended.json + sync script that generates .claude-plugin/marketplace.json)
  • 3 Complete example plugins (hello-world, auto-formatter, security-reviewer)
  • 4 Plugin templates (minimal, command, agent, full)
  • 6 Documentation files
  • GitHub workflows and issue templates
  • README.md, CONTRIBUTING.md, LICENSE

Final Setup Steps

Step 1: Make Scripts Executable

cd /home/jeremy/projects/claude-code-plugins

# Make all shell scripts executable
find . -type f -name "*.sh" -exec chmod +x {} \;

# Verify
find . -type f -name "*.sh" -ls

Step 2: Initialize Git Repository

cd /home/jeremy/projects/claude-code-plugins

# Initialize git
git init

# Add all files
git add .

# Create initial commit
git commit -m "Initial commit: Claude Code Plugin Marketplace

- Complete marketplace structure with 3 example plugins
- hello-world: Basic slash command example
- auto-formatter: Hook-based code formatting
- security-reviewer: Specialized security agent
- 4 plugin templates for developers
- Comprehensive documentation (6 docs files)
- GitHub workflows and issue templates
- CONTRIBUTING.md with submission guidelines
- Professional README with badges and clear structure

 Generated with Claude Code"

Step 3: Create GitHub Repository

  1. Go to GitHub: https://github.com/new
  2. Repository name: claude-code-plugins
  3. Description: The comprehensive marketplace and learning hub for Claude Code plugins
  4. Visibility: Public
  5. DO NOT initialize with README, .gitignore, or license (we already have these)
  6. Click Create repository

Step 4: Push to GitHub

cd /home/jeremy/projects/claude-code-plugins

# Add remote origin
git remote add origin https://github.com/jeremylongshore/claude-code-plugins.git

# Rename branch to main
git branch -M main

# Push to GitHub
git push -u origin main

Step 5: Configure GitHub Repository Settings

After pushing, configure your repository on GitHub:

  1. Add Topics (Settings → General → Topics):

    • claude-code
    • plugins
    • marketplace
    • anthropic
    • ai
    • developer-tools

  2. Enable Discussions (Settings → Features → Discussions)

  3. Enable Issues (Should be enabled by default)

  4. Set Description: "The comprehensive marketplace and learning hub for Claude Code plugins"

  5. Add Website: https://github.com/jeremylongshore/claude-code-plugins

Step 6: Test the Marketplace

# Test installing from your new marketplace
/plugin marketplace add jeremylongshore/claude-code-plugins

# If you previously added this marketplace, remove the old slug first:
# /plugin marketplace remove claude-code-plugins

# Try installing a plugin
/plugin install hello-world@claude-code-plugins-plus

# Test the command
/hello

What Was Created

Directory Structure

claude-code-plugins/
├── .claude-plugin/
│   ├── marketplace.extended.json            Source catalog (full metadata)
│   └── marketplace.json                     Generated CLI catalog
├── plugins/
│   ├── examples/
│   │   ├── hello-world/                     Command example
│   │   ├── auto-formatter/                  Hook example
│   │   └── security-reviewer/               Agent example
│   └── community/                           Ready for submissions
├── templates/                               4 templates
├── docs/                                    6 documentation files
├── .github/                                 Workflows & templates
├── README.md                                Professional homepage
├── CONTRIBUTING.md                          Contribution guide
├── LICENSE                                  MIT License
└── .gitignore                               Git ignore rules

Example Plugins

  1. hello-world - Basic slash command

    • /hello or /h
    • Perfect for learning plugin structure

  2. auto-formatter - PostToolUse hooks

    • Auto-formats JS, TS, JSON, CSS, MD, HTML, Python
    • Uses Prettier and Black

  3. security-reviewer - Specialized agent

    • Expert security code review
    • Vulnerability detection
    • OWASP compliance

Templates

  • minimal-plugin/ - Bare minimum structure
  • command-plugin/ - With slash commands
  • agent-plugin/ - With AI agent
  • full-plugin/ - All features (commands, agents, hooks)

Next Steps

After setup is complete:

  1. Share on social media:

    • Twitter/X with #ClaudeCode
    • LinkedIn
    • Reddit (r/ClaudeAI)

  2. Join Claude Developers Discord:

  3. Monitor for:

    • Plugin submissions via Pull Requests
    • Issues from users
    • Community feedback

  4. Maintain:

    • Review and merge community plugins
    • Update docs as Claude Code evolves
    • Add more example plugins over time

Troubleshooting

Scripts not executable:

chmod +x plugins/examples/auto-formatter/scripts/format.sh
chmod +x templates/full-plugin/scripts/example.sh

Git not tracking hidden files:

git add .claude-plugin/
git add plugins/*/.claude-plugin/
git commit -m "Add hidden .claude-plugin directories"

JSON validation errors:

# Validate all JSON files
find . -name "*.json" -exec sh -c 'echo "Checking {}"; jq empty {}' \;

Support

If you encounter issues:

  • Check the troubleshooting section above
  • Review files in the repository
  • Ask in Claude Developers Discord
  • Create an issue in your GitHub repo

You're all set!

Your Claude Code Plugin Marketplace is ready to launch. Execute the steps above and you'll have a production-ready plugin hub on GitHub!