mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 12:23:22 +00:00
297 lines
16 KiB
Markdown
297 lines
16 KiB
Markdown
<p align="center" style="margin-bottom: 0;">
|
|
<img src=".github/assets/logo.png" alt="skillshare" width="280">
|
|
</p>
|
|
|
|
<h1 align="center" style="margin-top: 0.5rem; margin-bottom: 0.5rem;">skillshare</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://skillshare.runkids.cc"><img src="https://img.shields.io/badge/Website-skillshare.runkids.cc-blue?logo=docusaurus" alt="Website"></a>
|
|
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
|
<a href="https://github.com/runkids/skillshare/releases"><img src="https://img.shields.io/github/v/release/runkids/skillshare" alt="Release"></a>
|
|
<img src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-blue" alt="Platform">
|
|
<a href="https://goreportcard.com/report/github.com/runkids/skillshare"><img src="https://goreportcard.com/badge/github.com/runkids/skillshare" alt="Go Report Card"></a>
|
|
<a href="https://deepwiki.com/runkids/skillshare"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/runkids/skillshare/stargazers"><img src="https://img.shields.io/github/stars/runkids/skillshare?style=social" alt="Star on GitHub"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://trendshift.io/repositories/21835" target="_blank"><img src="https://trendshift.io/api/badge/repositories/21835" alt="runkids%2Fskillshare | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<strong>One source of truth for AI CLI skills, agents, rules, commands & more. Sync everywhere with one command — from personal to organization-wide.</strong><br>
|
|
Codex, Claude Code, OpenClaw, OpenCode & 60+ more.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<img src=".github/assets/demo.gif" alt="skillshare demo" width="960">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://skillshare.runkids.cc">Website</a> •
|
|
<a href="#installation">Install</a> •
|
|
<a href="#quick-start">Quick Start</a> •
|
|
<a href="#highlights">Highlights</a> •
|
|
<a href="#cli-and-ui-preview">Screenshots</a> •
|
|
<a href="https://skillshare.runkids.cc/docs">Docs</a>
|
|
</p>
|
|
|
|
> [!NOTE]
|
|
> **Latest**: [v0.20.0](https://github.com/runkids/skillshare/releases/tag/v0.20.0) — choose what `commit`/`push`/`pull` version with **git_root scope** (skills, agents, extras, or all together in one repo); extras **extension transforms** convert Markdown to native formats (Gemini TOML commands, Codex TOML agents) during sync. [All releases →](https://github.com/runkids/skillshare/releases)
|
|
|
|
## Why skillshare
|
|
|
|
Every AI CLI has its own skills directory.
|
|
You edit in one, forget to copy to another, and lose track of what's where.
|
|
|
|
skillshare fixes this:
|
|
|
|
- **One source, every agent** — sync to Claude, Cursor, Codex & 60+ more with `skillshare sync`
|
|
- **Agent management** — sync custom agents alongside skills to agent-capable targets
|
|
- **More than skills** — manage rules, commands, prompts & any file-based resource with [extras](https://skillshare.runkids.cc/docs/reference/targets/configuration#extras)
|
|
- **Install from anywhere** — GitHub, GitLab, Bitbucket, Azure DevOps, or any self-hosted Git
|
|
- **Built-in security** — audit skills for prompt injection and data exfiltration before use
|
|
- **Team-ready** — project skills in `.skillshare/`, org-wide skills via tracked repos
|
|
- **Local & lightweight** — single binary, no registry, no telemetry, fully offline-capable
|
|
- **Fine-grained filtering** — control which skills reach which targets with [`.skillignore`](https://skillshare.runkids.cc/docs/how-to/daily-tasks/filtering-skills), SKILL.md `targets`, and per-target include/exclude
|
|
|
|
> Coming from another tool? [Migration Guide](https://skillshare.runkids.cc/docs/how-to/advanced/migration) · [Comparison](https://skillshare.runkids.cc/docs/understand/philosophy/comparison)
|
|
|
|
## How It Works
|
|
|
|
- macOS / Linux: `~/.config/skillshare/`
|
|
- Windows: `%AppData%\skillshare\`
|
|
|
|
```
|
|
┌─────────────────────────────────────────────────────────────┐
|
|
│ Source Directory │
|
|
│ ~/.config/skillshare/skills/ ← skills (SKILL.md) │
|
|
│ ~/.config/skillshare/agents/ ← agents │
|
|
│ ~/.config/skillshare/extras/ ← rules, commands, etc. │
|
|
└─────────────────────────────────────────────────────────────┘
|
|
│ sync
|
|
┌───────────────┼───────────────┐
|
|
▼ ▼ ▼
|
|
┌───────────┐ ┌───────────┐ ┌───────────┐
|
|
│ Claude │ │ OpenCode │ │ OpenClaw │ ...
|
|
└───────────┘ └───────────┘ └───────────┘
|
|
```
|
|
|
|
| Platform | Skills Source | Agents Source | Extras Source | Link Type |
|
|
|----------|---------------|---------------|---------------|-----------|
|
|
| macOS/Linux | `~/.config/skillshare/skills/` | `~/.config/skillshare/agents/` | `~/.config/skillshare/extras/` | Symlinks |
|
|
| Windows | `%AppData%\skillshare\skills\` | `%AppData%\skillshare\agents\` | `%AppData%\skillshare\extras\` | NTFS Junctions (no admin required) |
|
|
|
|
| | Imperative (install-per-command) | Declarative (skillshare) |
|
|
|---|---|---|
|
|
| **Source of truth** | Skills copied independently | Single source → symlinks (or copies) |
|
|
| **New machine setup** | Re-run every install manually | `git clone` config + `sync` |
|
|
| **Security audit** | None | Built-in `audit` + auto-scan on install/update |
|
|
| **Web dashboard** | None | `skillshare ui` |
|
|
| **Runtime dependency** | Node.js + npm | None (single Go binary) |
|
|
|
|
> [Full comparison →](https://skillshare.runkids.cc/docs/understand/philosophy/comparison)
|
|
|
|
## CLI and UI Preview
|
|
|
|
| Skill Detail | Security Audit |
|
|
|---|---|
|
|
| <img src=".github/assets/skill-detail-tui.png" alt="CLI sync output" width="480" height="300"> | <img src=".github/assets/audit-tui.png" alt="CLI install with security audit" width="480" height="300"> |
|
|
|
|
| UI Dashboard | UI Skills |
|
|
|---|---|
|
|
| <img src=".github/assets/ui/web-dashboard-demo.png" alt="Web dashboard overview" width="480"> | <img src=".github/assets/ui/web-skills-demo.png" alt="Web UI skills page" width="480"> |
|
|
|
|
## Installation
|
|
|
|
### macOS / Linux
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/runkids/skillshare/main/install.sh | sh
|
|
```
|
|
|
|
### Windows PowerShell
|
|
|
|
```powershell
|
|
irm https://raw.githubusercontent.com/runkids/skillshare/main/install.ps1 | iex
|
|
```
|
|
|
|
### Homebrew
|
|
|
|
```bash
|
|
brew install skillshare
|
|
```
|
|
|
|
> **Tip:** Run `skillshare upgrade` to update to the latest version. It auto-detects your install method and handles the rest.
|
|
|
|
### GitHub Actions
|
|
|
|
```yaml
|
|
- uses: runkids/setup-skillshare@v1
|
|
with:
|
|
source: ./skills
|
|
- run: skillshare sync
|
|
```
|
|
|
|
See [`setup-skillshare`](https://github.com/marketplace/actions/setup-skillshare) for all options (audit, project mode, version pinning).
|
|
|
|
### Shorthand (Optional)
|
|
|
|
Add an alias to your shell config (`~/.zshrc` or `~/.bashrc`):
|
|
|
|
```bash
|
|
alias ss='skillshare'
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
skillshare init # Create config, source, and detected targets
|
|
skillshare sync # Sync skills to all targets
|
|
```
|
|
|
|
## Highlights
|
|
|
|
**Install & update skills** —from GitHub, GitLab, or any Git host
|
|
|
|
```bash
|
|
skillshare install github.com/reponame/skills
|
|
skillshare update --all
|
|
skillshare target claude --mode copy # if symlinks don't work
|
|
```
|
|
|
|
**Symlink issues?** — switch to copy mode per target
|
|
|
|
```bash
|
|
skillshare target <name> --mode copy
|
|
skillshare sync
|
|
```
|
|
|
|
**Security audit** —scan before skills reach your agent
|
|
|
|
```bash
|
|
skillshare audit
|
|
```
|
|
|
|
**Project skills** —per-repo, committed with your code
|
|
|
|
```bash
|
|
skillshare init -p && skillshare sync
|
|
```
|
|
|
|
**Agents** —sync custom agents to agent-capable targets
|
|
|
|
```bash
|
|
skillshare sync agents # sync agents only
|
|
skillshare sync --all # sync skills + agents + extras together
|
|
```
|
|
|
|
**Extras** —manage rules, commands, prompts & more
|
|
|
|
```bash
|
|
skillshare extras init rules # create a "rules" extra
|
|
skillshare sync --all # sync skills + extras together
|
|
skillshare extras collect rules # collect local files back to source
|
|
```
|
|
|
|
**Shell completion** —tab-complete commands, flags, and subcommands
|
|
|
|
```bash
|
|
skillshare completion bash --install # also: zsh, fish, powershell, nushell
|
|
```
|
|
|
|
**Local checkpoints** — commit source changes without pushing
|
|
|
|
```bash
|
|
skillshare commit -m "Update review skill"
|
|
skillshare commit --dry-run
|
|
```
|
|
|
|
**Web dashboard** — visual control panel
|
|
|
|
```bash
|
|
skillshare ui
|
|
```
|
|
|
|
[All commands & guides →](https://skillshare.runkids.cc/docs/reference/commands)
|
|
|
|
## Contributing
|
|
|
|
Contributions welcome! Open an issue first, then submit a draft PR with tests.
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for setup details.
|
|
|
|
```bash
|
|
git clone https://github.com/runkids/skillshare.git && cd skillshare
|
|
make check # format + lint + test
|
|
```
|
|
|
|
> [!TIP]
|
|
> Not sure where to start? Browse [open issues](https://github.com/runkids/skillshare/issues) or try the [Playground](https://skillshare.runkids.cc/docs/learn/with-playground) for a zero-setup dev environment.
|
|
|
|
## Contributors
|
|
|
|
Thanks to everyone who helped shape skillshare.
|
|
|
|
<a href="https://github.com/leeeezx"><img src="https://github.com/leeeezx.png" width="50" style="border-radius:50%" alt="leeeezx"></a>
|
|
<a href="https://github.com/Vergil333"><img src="https://github.com/Vergil333.png" width="50" style="border-radius:50%" alt="Vergil333"></a>
|
|
<a href="https://github.com/romanr"><img src="https://github.com/romanr.png" width="50" style="border-radius:50%" alt="romanr"></a>
|
|
<a href="https://github.com/xocasdashdash"><img src="https://github.com/xocasdashdash.png" width="50" style="border-radius:50%" alt="xocasdashdash"></a>
|
|
<a href="https://github.com/philippe-granet"><img src="https://github.com/philippe-granet.png" width="50" style="border-radius:50%" alt="philippe-granet"></a>
|
|
<a href="https://github.com/terranc"><img src="https://github.com/terranc.png" width="50" style="border-radius:50%" alt="terranc"></a>
|
|
<a href="https://github.com/benrfairless"><img src="https://github.com/benrfairless.png" width="50" style="border-radius:50%" alt="benrfairless"></a>
|
|
<a href="https://github.com/nerveband"><img src="https://github.com/nerveband.png" width="50" style="border-radius:50%" alt="nerveband"></a>
|
|
<a href="https://github.com/EarthChen"><img src="https://github.com/EarthChen.png" width="50" style="border-radius:50%" alt="EarthChen"></a>
|
|
<a href="https://github.com/gdm257"><img src="https://github.com/gdm257.png" width="50" style="border-radius:50%" alt="gdm257"></a>
|
|
<a href="https://github.com/skovtunenko"><img src="https://github.com/skovtunenko.png" width="50" style="border-radius:50%" alt="skovtunenko"></a>
|
|
<a href="https://github.com/TyceHerrman"><img src="https://github.com/TyceHerrman.png" width="50" style="border-radius:50%" alt="TyceHerrman"></a>
|
|
<a href="https://github.com/1am2syman"><img src="https://github.com/1am2syman.png" width="50" style="border-radius:50%" alt="1am2syman"></a>
|
|
<a href="https://github.com/thealokkr"><img src="https://github.com/thealokkr.png" width="50" style="border-radius:50%" alt="thealokkr"></a>
|
|
<a href="https://github.com/JasonLandbridge"><img src="https://github.com/JasonLandbridge.png" width="50" style="border-radius:50%" alt="JasonLandbridge"></a>
|
|
<a href="https://github.com/masonc15"><img src="https://github.com/masonc15.png" width="50" style="border-radius:50%" alt="masonc15"></a>
|
|
<a href="https://github.com/richardwhatever"><img src="https://github.com/richardwhatever.png" width="50" style="border-radius:50%" alt="richardwhatever"></a>
|
|
<a href="https://github.com/reneleonhardt"><img src="https://github.com/reneleonhardt.png" width="50" style="border-radius:50%" alt="reneleonhardt"></a>
|
|
<a href="https://github.com/ndeybach"><img src="https://github.com/ndeybach.png" width="50" style="border-radius:50%" alt="ndeybach"></a>
|
|
<a href="https://github.com/hhh2210"><img src="https://github.com/hhh2210.png" width="50" style="border-radius:50%" alt="hhh2210"></a>
|
|
<a href="https://github.com/leoarry"><img src="https://github.com/leoarry.png" width="50" style="border-radius:50%" alt="leoarry"></a>
|
|
<a href="https://github.com/salmonumbrella"><img src="https://github.com/salmonumbrella.png" width="50" style="border-radius:50%" alt="salmonumbrella"></a>
|
|
<a href="https://github.com/daylamtayari"><img src="https://github.com/daylamtayari.png" width="50" style="border-radius:50%" alt="daylamtayari"></a>
|
|
<a href="https://github.com/dstotijn"><img src="https://github.com/dstotijn.png" width="50" style="border-radius:50%" alt="dstotijn"></a>
|
|
<a href="https://github.com/ipruning"><img src="https://github.com/ipruning.png" width="50" style="border-radius:50%" alt="ipruning"></a>
|
|
<a href="https://github.com/massukio"><img src="https://github.com/massukio.png" width="50" style="border-radius:50%" alt="massukio"></a>
|
|
<a href="https://github.com/kevincobain2000"><img src="https://github.com/kevincobain2000.png" width="50" style="border-radius:50%" alt="kevincobain2000"></a>
|
|
<a href="https://github.com/StephenPAdams"><img src="https://github.com/StephenPAdams.png" width="50" style="border-radius:50%" alt="StephenPAdams"></a>
|
|
<a href="https://github.com/mk-imagine"><img src="https://github.com/mk-imagine.png" width="50" style="border-radius:50%" alt="mk-imagine"></a>
|
|
<a href="https://github.com/Curtion"><img src="https://github.com/Curtion.png" width="50" style="border-radius:50%" alt="Curtion"></a>
|
|
<a href="https://github.com/amdoi7"><img src="https://github.com/amdoi7.png" width="50" style="border-radius:50%" alt="amdoi7"></a>
|
|
<a href="https://github.com/jessica-engel"><img src="https://github.com/jessica-engel.png" width="50" style="border-radius:50%" alt="jessica-engel"></a>
|
|
<a href="https://github.com/AlimuratYusup"><img src="https://github.com/AlimuratYusup.png" width="50" style="border-radius:50%" alt="AlimuratYusup"></a>
|
|
<a href="https://github.com/thor-shuang"><img src="https://github.com/thor-shuang.png" width="50" style="border-radius:50%" alt="thor-shuang"></a>
|
|
<a href="https://github.com/bishopmatthew"><img src="https://github.com/bishopmatthew.png" width="50" style="border-radius:50%" alt="bishopmatthew"></a>
|
|
<a href="https://github.com/chaosky"><img src="https://github.com/chaosky.png" width="50" style="border-radius:50%" alt="chaosky"></a>
|
|
<a href="https://github.com/iFwu"><img src="https://github.com/iFwu.png" width="50" style="border-radius:50%" alt="iFwu"></a>
|
|
<a href="https://github.com/ildunari"><img src="https://github.com/ildunari.png" width="50" style="border-radius:50%" alt="ildunari"></a>
|
|
<a href="https://github.com/aestilog"><img src="https://github.com/aestilog.png" width="50" style="border-radius:50%" alt="aestilog"></a>
|
|
<a href="https://github.com/xarthurx"><img src="https://github.com/xarthurx.png" width="50" style="border-radius:50%" alt="xarthurx"></a>
|
|
<a href="https://github.com/m0cun"><img src="https://github.com/m0cun.png" width="50" style="border-radius:50%" alt="m0cun"></a>
|
|
<a href="https://github.com/bit3125"><img src="https://github.com/bit3125.png" width="50" style="border-radius:50%" alt="bit3125"></a>
|
|
<a href="https://github.com/eekryuos"><img src="https://github.com/eekryuos.png" width="50" style="border-radius:50%" alt="eekryuos"></a>
|
|
<a href="https://github.com/Bongseop-Kim"><img src="https://github.com/Bongseop-Kim.png" width="50" style="border-radius:50%" alt="Bongseop-Kim"></a>
|
|
<a href="https://github.com/sophodex"><img src="https://github.com/sophodex.png" width="50" style="border-radius:50%" alt="sophodex"></a>
|
|
|
|
---
|
|
|
|
If you find skillshare useful, consider giving it a ⭐
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/#runkids/skillshare&type=date&legend=top-left)
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
MIT
|