Add README with setup and sync instructions
This commit is contained in:
87
README.md
Normal file
87
README.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# Claude Code Skills
|
||||
|
||||
Shared repository for Claude Code skills synced via Skillshare across machines and AI tools.
|
||||
|
||||
## 📦 What is This?
|
||||
|
||||
This repository contains skills (task definitions) that are automatically synced to:
|
||||
- **Claude Code** (`~/.claude/skills`)
|
||||
- **Moltbot** (`/mnt/nvme/projects/active/moltbot/skills`)
|
||||
- Any other AI CLI tools you configure
|
||||
|
||||
## 🎯 How Skillshare Works
|
||||
|
||||
```
|
||||
Git Remote (Gitea) ← You are here
|
||||
↕ skillshare push/pull
|
||||
Source: ~/.config/skillshare/skills
|
||||
↕ skillshare sync
|
||||
Targets: ~/.claude/skills, moltbot/skills, etc.
|
||||
```
|
||||
|
||||
## 📝 Current Skills
|
||||
|
||||
- **skillshare** (v0.6.4) - Meta-skill for AI-assisted skill management
|
||||
|
||||
## 🚀 Setup on New Machine
|
||||
|
||||
```bash
|
||||
# Install Skillshare
|
||||
curl -fsSL https://raw.githubusercontent.com/runkids/skillshare/main/install.sh | sh
|
||||
|
||||
# Initialize with this repo
|
||||
skillshare init --source ~/.config/skillshare/skills \
|
||||
--all-targets \
|
||||
--git \
|
||||
--remote https://admin:PASSWORD@gitea.pressmess.duckdns.org/admin/claude-skills.git
|
||||
|
||||
# Pull skills and sync to all AI tools
|
||||
skillshare pull --remote
|
||||
```
|
||||
|
||||
## 🔄 Daily Usage
|
||||
|
||||
### Get Latest Skills
|
||||
```bash
|
||||
skillshare pull --remote # Pulls from Gitea and syncs to all AI tools
|
||||
```
|
||||
|
||||
### Share Your Skills
|
||||
```bash
|
||||
skillshare new my-skill # Create new skill
|
||||
nano ~/.config/skillshare/skills/my-skill/SKILL.md # Edit
|
||||
skillshare sync # Test locally
|
||||
skillshare push -m "Add my-skill" # Share with other machines
|
||||
```
|
||||
|
||||
### Check Status
|
||||
```bash
|
||||
skillshare status # See all targets and sync state
|
||||
```
|
||||
|
||||
## 📚 Skill Structure
|
||||
|
||||
Each skill is a directory with:
|
||||
```
|
||||
skillname/
|
||||
├── SKILL.md # Main skill definition (required)
|
||||
├── README.md # Documentation (optional)
|
||||
├── examples/ # Usage examples (optional)
|
||||
├── references/ # Reference docs (optional)
|
||||
└── scripts/ # Helper scripts (optional)
|
||||
```
|
||||
|
||||
## 🌐 Repository
|
||||
|
||||
**Gitea**: https://gitea.pressmess.duckdns.org/admin/claude-skills
|
||||
**Clone**: `https://gitea.pressmess.duckdns.org/admin/claude-skills.git`
|
||||
|
||||
## 📖 Full Documentation
|
||||
|
||||
**Complete Guide**: `/home/jon/SKILLS-SYNC-GUIDE.md` (on server-ai)
|
||||
|
||||
## 🔗 Related
|
||||
|
||||
- **Agents Repo**: https://gitea.pressmess.duckdns.org/admin/claude-agents
|
||||
- **Skillshare Project**: https://github.com/runkids/skillshare
|
||||
- **Server Docs**: `/home/jon/SERVER-DOCUMENTATION.md`
|
||||
Reference in New Issue
Block a user