move claude-marketplace to ai-proj-helper
This commit is contained in:
129
SETUP.md
Normal file
129
SETUP.md
Normal file
@@ -0,0 +1,129 @@
|
||||
# Setup Guide
|
||||
|
||||
## 1. Create Repository on Gitea
|
||||
|
||||
Go to https://gitea.pipexerp.com and create a new repository:
|
||||
- Name: `claude-marketplace`
|
||||
- Visibility: Private or Public (your choice)
|
||||
- **Do NOT** initialize with README (we already have one)
|
||||
|
||||
## 2. Push to Gitea
|
||||
|
||||
```bash
|
||||
cd /Users/junhuang/coolbuy/claude-marketplace
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
## 3. Test Installation
|
||||
|
||||
### Add the marketplace
|
||||
```bash
|
||||
# SSH (recommended)
|
||||
/plugin marketplace add git@gitea.pipexerp.com:huangjun/claude-marketplace.git
|
||||
|
||||
# OR HTTPS (requires credential configuration)
|
||||
/plugin marketplace add https://gitea.pipexerp.com/huangjun/claude-marketplace.git
|
||||
```
|
||||
|
||||
### List available plugins
|
||||
```bash
|
||||
/plugin marketplace list coolbuy-claude-plugins
|
||||
```
|
||||
|
||||
### Install a plugin
|
||||
```bash
|
||||
/plugin install ai-proj-plugin@coolbuy-claude-plugins
|
||||
```
|
||||
|
||||
### Test the plugin
|
||||
```bash
|
||||
# Skills are auto-invoked by Claude when relevant, or use:
|
||||
/help
|
||||
# Check for your installed plugins
|
||||
```
|
||||
|
||||
## 4. Update Plugins Later
|
||||
|
||||
When you make changes and push updates:
|
||||
|
||||
```bash
|
||||
cd /Users/junhuang/coolbuy/claude-marketplace
|
||||
|
||||
# Make changes to plugins
|
||||
# ...
|
||||
|
||||
# Regenerate marketplace.json if needed
|
||||
python3 generate-marketplace.py
|
||||
|
||||
# Commit and push
|
||||
git add .
|
||||
git commit -m "Update plugins"
|
||||
git push
|
||||
```
|
||||
|
||||
Users update with:
|
||||
```bash
|
||||
/plugin marketplace update coolbuy-claude-plugins
|
||||
/plugin update ai-proj-plugin@coolbuy-claude-plugins
|
||||
```
|
||||
|
||||
## 5. Private Repository Setup
|
||||
|
||||
If your Gitea repo is private, users need authentication:
|
||||
|
||||
**For manual operations** (install, update):
|
||||
- SSH: Configure SSH keys in Gitea
|
||||
- HTTPS: Will prompt for credentials
|
||||
|
||||
**For background auto-updates**:
|
||||
```bash
|
||||
# Add to ~/.zshrc or ~/.bashrc
|
||||
export GITEA_TOKEN="your-gitea-personal-access-token"
|
||||
```
|
||||
|
||||
To create a Gitea token:
|
||||
1. Go to https://gitea.pipexerp.com/user/settings/applications
|
||||
2. Generate New Token
|
||||
3. Give it "Read repository" permissions
|
||||
4. Copy the token and add to your environment
|
||||
|
||||
## 6. Structure Overview
|
||||
|
||||
```
|
||||
claude-marketplace/
|
||||
├── .claude-plugin/
|
||||
│ └── marketplace.json # Catalog of all plugins
|
||||
├── plugins/
|
||||
│ ├── ai-proj-plugin/
|
||||
│ │ ├── .claude-plugin/
|
||||
│ │ │ └── plugin.json # Plugin metadata
|
||||
│ │ └── skills/
|
||||
│ │ └── SKILL.md # Skill definition
|
||||
│ └── [33 more plugins...]
|
||||
├── README.md # User documentation
|
||||
├── SETUP.md # This file
|
||||
└── convert-skills.sh # Conversion script (reference)
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ Push to Gitea: `git push -u origin main`
|
||||
2. ✅ Test locally: `/plugin marketplace add <url>`
|
||||
3. ✅ Install plugins: `/plugin install <name>@coolbuy-claude-plugins`
|
||||
4. ✅ Share with team: Send them the repository URL
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"Failed to clone repository"**
|
||||
- Check SSH key configuration: `ssh -T git@gitea.pipexerp.com -p 10022`
|
||||
- Or use HTTPS with credentials
|
||||
|
||||
**"Plugin not found"**
|
||||
- Verify marketplace added: `/plugin marketplace list`
|
||||
- Check plugin name is correct
|
||||
- Ensure marketplace.json is valid: `cat .claude-plugin/marketplace.json | jq`
|
||||
|
||||
**"Skills not working"**
|
||||
- Skills are Agent Skills (auto-invoked by Claude when relevant)
|
||||
- They don't create slash commands
|
||||
- Check plugin installation: `/plugin list`
|
||||
Reference in New Issue
Block a user