mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-19 02:17:09 +00:00
Restructure the entire documentation site following the Diátaxis framework (Learn / How-to / Understand / Reference) with new content across 110 files. ## Information Architecture (M1) - Move all docs to Diátaxis directory structure (learn/, how-to/, understand/, reference/) - Add client-redirects plugin for old URL compatibility - Rewrite sidebar, navbar, and footer to match new IA - Update all internal cross-references ## Homepage + Quickstarts (M2) - Add scenario entry cards to homepage with hand-drawn design - 5 quickstart pages: Claude Code, GitHub Copilot (with copy mode recommendation), Codex, Multiple Tools, Dev Containers, Playground ## Blog + Changelog (M3) - Enable Docusaurus blog plugin with authors.yml - 5 blog posts: 5-min tutorial, managing 50+ skills, skillshare vs vercel/skills comparison, team sharing patterns, write your first skill - Static /changelog page from CHANGELOG.md ## Recipes + Philosophy (M4) - 5 recipe pages: CI/CD validation, enterprise skills, project setup, cross-machine sync, team onboarding - 3 philosophy pages: why-local-first, security-first, sync-modes-explained ## Content Polish - Cross-validate all content against CLI source (19 inaccuracies fixed) - Lowercase "skillshare" throughout (avoid brand conflict with Skillshare Inc.) - Add registry.yaml to file structure and Key Paths docs - Highlight multi-platform git support (GitHub, GitLab, Bitbucket, Gitea, Azure DevOps, AtomGit, Codeberg) - Standardize brew install command - Add AsciinemaPlayer component (cast recordings pending)
4.2 KiB
4.2 KiB
sidebar_position
| sidebar_position |
|---|
| 4 |
Quick Reference
Command cheat sheet for skillshare.
Core Commands
| Command | Description |
|---|---|
init |
First-time setup |
install <source> |
Add a skill |
uninstall <name>... |
Remove one or more skills |
list |
List all skills |
search <query> |
Search for skills |
sync |
Push to all targets |
status |
Show sync state |
Skill Management
| Command | Description |
|---|---|
new <name> |
Create a new skill |
update <name> |
Update a skill (git pull) |
update --all |
Update all tracked repos |
check |
Check for skill updates |
check --json |
Check for updates (JSON output) |
upgrade |
Upgrade CLI and built-in skill |
hub list |
List configured skill hubs |
hub add <url> |
Add a skill hub |
Target Management
| Command | Description |
|---|---|
target list |
List all targets |
target <name> |
Show target details |
target <name> --mode <mode> |
Change sync mode |
target add <name> <path> |
Add custom target |
target remove <name> |
Remove target safely |
diff [target] |
Show differences |
Sync Operations
| Command | Description |
|---|---|
collect <target> |
Collect skills from target to source |
collect --all |
Collect from all targets |
backup [target] |
Create backup |
backup --list |
List backups |
restore <target> |
Restore from backup |
push [-m "msg"] |
Push to git remote |
pull |
Pull from git and sync |
trash list |
List soft-deleted skills |
trash restore <name> |
Restore a soft-deleted skill |
Utilities
| Command | Description |
|---|---|
doctor |
Diagnose issues |
log |
View operations and audit logs |
ui |
Launch web dashboard on localhost:19420 |
ui -p |
Launch web dashboard in project mode |
version |
Show CLI version |
make test-docker |
Run offline Docker sandbox tests |
make playground |
Start playground + enter shell (one step) |
make playground-down |
Stop and remove playground |
./scripts/sandbox.sh <cmd> |
Advanced sandbox management (up/down/shell/reset/status/logs/bare) |
make ui-build |
Build frontend |
make build-all |
Full binary with frontend |
Common Workflows
Install and sync a skill
skillshare install anthropics/skills/skills/pdf
skillshare sync
Create and deploy a skill
skillshare new my-skill
# Edit ~/.config/skillshare/skills/my-skill/SKILL.md
skillshare sync
Cross-machine sync
# Setup (pick one)
# Interactive (guided prompts)
skillshare init --remote git@github.com:you/my-skills.git
# Non-interactive (no prompts, auto-detect installed targets)
skillshare init --remote git@github.com:you/my-skills.git --no-copy --all-targets --no-skill
# Machine A: push changes
skillshare push -m "Add new skill"
# Machine B: pull and sync
skillshare pull
Optional later (only if you install additional AI CLIs after setup):
skillshare init --discover
With mode override during discover, only newly added targets are affected:
skillshare init --discover --select cursor --mode copy
Team skill sharing
# Install team repo
skillshare install github.com/team/skills --track
# Update from team
skillshare update --all
skillshare sync
Sandbox playground session
make playground # start + enter shell
skillshare --help
ss status
exit # leave shell
make playground-down # stop container
Key Paths
| Path | Description |
|---|---|
~/.config/skillshare/config.yaml |
Configuration file |
~/.config/skillshare/registry.yaml |
Installed skill registry (auto-managed) |
~/.config/skillshare/skills/ |
Source directory |
~/.local/state/skillshare/logs/ |
Operation and audit logs |
~/.local/share/skillshare/backups/ |
Backup directory |
Flags Available on Most Commands
| Flag | Description |
|---|---|
--dry-run, -n |
Preview without making changes |
--help, -h |
Show help |
See Also
- Commands Reference — Full command documentation
- Concepts — Core concepts explained