Files
skillshare/website/docs/getting-started/quick-reference.md
T
Willie f16a28d678 docs: restructure website documentation with scenario-driven navigation
- Add version command page and fix commands index (missing check, trash, hub)
- Document target aliases and XDG base directory layout
- Rewrite all 9 section index pages with "What do you want to do?" tables
- Standardize all 24 command docs with "When to Use" and "See Also" sections
- Enhance intro with role-based paths (individual / team / migration)
- Add "What Just Happened?" explainer to first-sync getting-started page
- Add practical context callouts (:::tip) to all concept pages
- Add See Also cross-references to all guide and workflow pages

59 files changed, 547 insertions(+), 163 deletions(-)
2026-02-16 17:01:06 +08:00

162 lines
4.1 KiB
Markdown

---
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 a skill |
| `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 |
| `mise run test:docker` | Run offline Docker sandbox tests |
| `mise run test:docker:online` | Run optional online Docker tests |
| `mise run sandbox:up` | Start persistent playground container |
| `mise run sandbox:shell` | Enter playground shell |
| `mise run sandbox:down` | Stop playground container |
| `make test-docker` | Run offline Docker sandbox tests |
| `make test-docker-online` | Run optional online Docker tests |
| `make sandbox-up` | Start persistent playground container |
| `make sandbox-shell` | Enter playground shell |
| `make sandbox-down` | Stop playground container |
| `mise run ui:build` | Build frontend + copy to embed |
| `mise run build:all` | Full binary with embedded frontend |
| `make ui-build` | Build frontend + copy to embed |
| `make build-all` | Full binary with embedded frontend |
---
## Common Workflows
### Install and sync a skill
```bash
skillshare install anthropics/skills/skills/pdf
skillshare sync
```
### Create and deploy a skill
```bash
skillshare new my-skill
# Edit ~/.config/skillshare/skills/my-skill/SKILL.md
skillshare sync
```
### Cross-machine sync
```bash
# Machine A: push changes
skillshare push -m "Add new skill"
# Machine B: pull and sync
skillshare pull
```
### Team skill sharing
```bash
# Install team repo
skillshare install github.com/team/skills --track
# Update from team
skillshare update --all
skillshare sync
```
### Sandbox playground session
```bash
mise run sandbox:up
mise run sandbox:shell
skillshare --help
ss status
mise run sandbox:down
```
```bash
make sandbox-up
make sandbox-shell
skillshare --help
ss status
make sandbox-down
```
---
## Key Paths
| Path | Description |
|------|-------------|
| `~/.config/skillshare/config.yaml` | Configuration file |
| `~/.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](/docs/commands) — Full command documentation
- [Concepts](/docs/concepts) — Core concepts explained