mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 12:23:22 +00:00
docs: add web dashboard to built-in skillshare skill
Add "web dashboard", "skillshare ui" triggers to description for skill activation. Add Web UI row to commands table. Create references/ui.md with usage, flags, dashboard pages, project mode differences, REST API endpoints, and Docker instructions.
This commit is contained in:
@@ -36,8 +36,8 @@ docker compose -f "$COMPOSE_FILE" --profile playground exec --user "$(id -u):$(i
|
||||
mkdir -p "$DEMO"
|
||||
cd "$DEMO"
|
||||
|
||||
# Initialize project mode with claude target (non-interactive)
|
||||
skillshare init -p --targets claude
|
||||
# Initialize project mode with claude-code target (non-interactive)
|
||||
skillshare init -p --targets claude-code
|
||||
|
||||
# Create a sample skill
|
||||
mkdir -p .skillshare/skills/hello-world
|
||||
|
||||
@@ -9,7 +9,9 @@ description: |
|
||||
"push/pull skills", "add/remove target", "find a skill for X", "is there a skill that can...",
|
||||
"how do I do X with skills", "skillshare init", "skillshare upgrade", "skill not syncing",
|
||||
"diagnose skillshare", "doctor", "project skills", "init project", "project setup",
|
||||
"scope skills to repo", "share skills via git", or any skill/target management across AI tools.
|
||||
"scope skills to repo", "share skills via git", "web dashboard", "skillshare ui",
|
||||
"launch dashboard", "open ui", "visual skill management",
|
||||
or any skill/target management across AI tools.
|
||||
argument-hint: "[command] [target] [--dry-run] [-p|-g]"
|
||||
---
|
||||
|
||||
@@ -46,6 +48,7 @@ skillshare sync
|
||||
| **Skills** | `new`, `install`, `uninstall`, `update`, `search` | ✓ (`-p`) |
|
||||
| **Targets** | `target add/remove/list` | ✓ (`-p`) |
|
||||
| **Backup** | `backup`, `restore` | ✗ |
|
||||
| **Web UI** | `ui` | ✓ (`-p`) |
|
||||
| **Upgrade** | `upgrade [--cli\|--skill]` | — |
|
||||
|
||||
**Workflow:** Most commands require `sync` afterward to distribute changes.
|
||||
@@ -96,4 +99,5 @@ skillshare search <query> --json # JSON output
|
||||
| Status/diff/list/search | [status.md](references/status.md) |
|
||||
| Target management | [targets.md](references/targets.md) |
|
||||
| Backup/restore | [backup.md](references/backup.md) |
|
||||
| Web dashboard (UI) | [ui.md](references/ui.md) |
|
||||
| Troubleshooting | [TROUBLESHOOTING.md](references/TROUBLESHOOTING.md) |
|
||||
|
||||
@@ -0,0 +1,83 @@
|
||||
# Web Dashboard (`skillshare ui`)
|
||||
|
||||
Launch a browser-based dashboard for visual skill management. Single binary — no extra setup.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
skillshare ui # Global mode (auto-opens browser)
|
||||
skillshare ui -p # Project mode
|
||||
skillshare ui -g # Force global mode
|
||||
```
|
||||
|
||||
Auto-detects project mode when `.skillshare/config.yaml` exists in cwd.
|
||||
|
||||
## Flags
|
||||
|
||||
| Flag | Default | Description |
|
||||
|------|---------|-------------|
|
||||
| `-p, --project` | | Project mode (`.skillshare/`) |
|
||||
| `-g, --global` | | Global mode (`~/.config/skillshare/`) |
|
||||
| `--port <port>` | `19420` | HTTP server port |
|
||||
| `--host <host>` | `127.0.0.1` | Bind address (`0.0.0.0` for Docker/remote) |
|
||||
| `--no-open` | `false` | Don't open browser automatically |
|
||||
|
||||
## Dashboard Pages
|
||||
|
||||
| Page | Description |
|
||||
|------|-------------|
|
||||
| **Dashboard** | Overview cards — skill count, target count, sync mode, version |
|
||||
| **Skills** | Searchable skill grid with metadata. Click to view SKILL.md |
|
||||
| **Install** | Install from local path, git URL, or GitHub shorthand |
|
||||
| **Targets** | Target list with status badges. Add/remove targets |
|
||||
| **Sync** | Sync controls with dry-run toggle. Diff preview |
|
||||
| **Collect** | Scan targets and collect selected skills back to source |
|
||||
| **Backup** | View/restore/cleanup backups (global only) |
|
||||
| **Git Sync** | Push/pull source repo (global only) |
|
||||
| **Search** | GitHub skill search with one-click install |
|
||||
| **Config** | YAML config editor with validation |
|
||||
|
||||
## Project Mode Differences
|
||||
|
||||
When running with `-p`, the dashboard adapts:
|
||||
|
||||
- **Git Sync** and **Backup** pages are hidden
|
||||
- **Config** edits `.skillshare/config.yaml`
|
||||
- **Install** reconciles remote skill entries in project config
|
||||
- **"Project" badge** in the sidebar indicates mode
|
||||
|
||||
## REST API
|
||||
|
||||
All endpoints at `/api/`, returning JSON:
|
||||
|
||||
```bash
|
||||
# Examples
|
||||
curl http://127.0.0.1:19420/api/overview
|
||||
curl http://127.0.0.1:19420/api/skills
|
||||
curl -X POST http://127.0.0.1:19420/api/sync -d '{"dryRun":true}'
|
||||
```
|
||||
|
||||
| Method | Path | Description |
|
||||
|--------|------|-------------|
|
||||
| GET | `/api/overview` | Skill/target counts, mode, version |
|
||||
| GET | `/api/skills` | List all skills with metadata |
|
||||
| GET | `/api/skills/{name}` | Skill detail + SKILL.md content |
|
||||
| DELETE | `/api/skills/{name}` | Uninstall a skill |
|
||||
| GET | `/api/targets` | List targets with status |
|
||||
| POST | `/api/targets` | Add a target |
|
||||
| DELETE | `/api/targets/{name}` | Remove a target |
|
||||
| POST | `/api/sync` | Run sync (`dryRun`, `force`) |
|
||||
| GET | `/api/diff` | Diff between source and targets |
|
||||
| GET | `/api/search?q=` | Search GitHub for skills |
|
||||
| POST | `/api/install` | Install a skill from source |
|
||||
| GET | `/api/config` | Get config as YAML |
|
||||
| PUT | `/api/config` | Update config YAML |
|
||||
|
||||
## Docker / Remote
|
||||
|
||||
```bash
|
||||
skillshare ui --host 0.0.0.0 --no-open # Global
|
||||
skillshare ui -p --host 0.0.0.0 --no-open # Project
|
||||
```
|
||||
|
||||
Access from host: `http://localhost:19420`
|
||||
Reference in New Issue
Block a user