Skip to content

PUBLISHING.md

Latest commit

 

History

History
220 lines (155 loc) · 5.7 KB

PUBLISHING.md

File metadata and controls

220 lines (155 loc) · 5.7 KB

Publishing Guide: Edmund's Claude Code Plugin

Complete step-by-step instructions for publishing your Claude Code plugin to GitHub and making it available for others to install.

Prerequisites

  • GitHub account
  • Git installed locally
  • Repository renamed to edmunds-claude-code ✅
  • All configuration files updated ✅

Step 1: Create GitHub Repository

1.1 Create New Repository on GitHub

  1. Go to https://github.com/new
  2. Fill in the details:
    • Repository name: edmunds-claude-code
    • Description: "Edmund's personal Claude Code setup with 14 productivity commands and 11 specialized AI agents for modern web development"
    • Visibility: Public (so others can install it)
    • Initialize: ❌ Don't add README, .gitignore, or license (we already have these)
  3. Click "Create repository"

1.2 Push Your Local Repository

Once the GitHub repository is created, run these commands:

cd ~/Documents/GitHub/edmunds-claude-code

# Add the GitHub remote
git remote add origin https://github.com/edmund-io/edmunds-claude-code.git

# Push your code
git push -u origin main

If you encounter authentication issues:

Step 2: Verify Installation Works

Test that your plugin can be installed:

# Install from your GitHub repo
/plugin install edmund-io/edmunds-claude-code

# Verify commands are available
/code-explain
/feature-plan

# Verify agents are available (they'll activate automatically based on context)

To uninstall and test again:

/plugin uninstall edmunds-claude-code

Step 3: Share Your Plugin

Your README already includes your GitHub username edmund-io, so users can copy-paste commands directly!

Option A: Share Direct Installation Command

Share this command with others:

/plugin install edmund-io/edmunds-claude-code

Option B: Submit to Community Marketplaces

Claude Code Plugins Marketplace

  1. Visit https://claudecodemarketplace.com/
  2. Follow their submission guidelines
  3. Share your plugin details

CC Plugins Curated Marketplace

  1. Visit https://github.com/ccplugins/marketplace
  2. Fork the repository
  3. Add your plugin to their marketplace.json
  4. Create a Pull Request with this format:
{
  "name": "edmunds-claude-code",
  "source": "edmund-io/edmunds-claude-code",
  "description": "Personal Claude Code configuration with 14 productivity commands and 11 specialized AI agents for modern web development",
  "version": "1.0.0",
  "author": "Edmund",
  "tags": ["productivity", "nextjs", "supabase", "typescript", "react", "development"]
}

Claude Code Plugins Plus

  1. Visit https://github.com/jeremylongshore/claude-code-plugins-plus
  2. Follow their contribution guidelines
  3. Submit your plugin details

Option C: Share on Social Media

Example post:

🚀 Just published my Claude Code setup as a plugin!

14 slash commands + 11 specialized AI agents for productive web development

Install with:
/plugin install edmund-io/edmunds-claude-code

Features:
✅ API scaffolding (/api-new)
✅ Code optimization (/code-optimize)
✅ Feature planning (/feature-plan)
✅ Tech research agent
✅ Architecture agents
✅ Security & performance agents

Perfect for Next.js, React, TypeScript, and Supabase projects!

GitHub: https://github.com/edmund-io/edmunds-claude-code

Step 5: Maintain Your Plugin

Updating Your Plugin

When you make changes to your local setup:

cd ~/Documents/GitHub/edmunds-claude-code

# Make your changes to commands/agents
# Then commit and push

git add .
git commit -m "Add new command: /new-command-name"

# Update version in plugin.json
# Bump version: 1.0.0 -> 1.1.0

git add .claude-plugin/plugin.json
git commit -m "Bump version to 1.1.0"

git push

Users can update to the latest version:

/plugin update edmunds-claude-code

Versioning Guidelines

  • 1.0.x - Bug fixes and minor tweaks
  • 1.x.0 - New commands or agents added
  • x.0.0 - Major restructuring or breaking changes

Troubleshooting

Issue: Plugin Won't Install

Check:

  • Repository is public on GitHub
  • .claude-plugin/plugin.json exists in the repo root
  • JSON files have valid syntax (no trailing commas, proper quotes)

Issue: Commands Don't Appear

Check:

  • Command file paths in plugin.json match actual file locations
  • Command files have .md extension
  • Command files are not empty

Issue: Agents Don't Activate

Check:

  • Agent file paths in plugin.json match actual file locations
  • Agent files have proper frontmatter with name and description
  • Agents activate based on context, not commands

Advanced: Creating Releases

For major versions, create GitHub releases:

  1. Go to your repo: https://github.com/edmund-io/edmunds-claude-code
  2. Click "Releases" → "Create a new release"
  3. Tag version: v1.0.0
  4. Release title: v1.0.0 - Initial Release
  5. Description: List of features/changes
  6. Click "Publish release"

Users can install specific versions:

/plugin install edmund-io/edmunds-claude-code@v1.0.0

Success Metrics

Track your plugin's success:

  • ⭐ GitHub stars
  • 👁️ GitHub watchers
  • 🍴 GitHub forks
  • 💬 Issues and discussions
  • 📊 Clone/download counts (GitHub Insights)

Getting Help

If you run into issues:

Congratulations! Once published, your plugin will be available for the Claude Code community to use and learn from. Happy sharing! 🎉