Files
skillshare/website/docs/reference/commands/ui.md
T
Willie caa525b8aa feat(website): complete website revamp — Diátaxis IA, blog, recipes, quickstarts
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)
2026-02-26 22:27:23 +08:00

7.0 KiB

sidebar_position
sidebar_position
1

ui

Launch the web dashboard for visual skill management.

skillshare ui

Opens http://127.0.0.1:19420 in your default browser.

When to Use

  • Manage skills, targets, and sync through a visual web interface
  • Browse and install skills without memorizing CLI flags
  • Run security audits with a visual findings report
  • Share a dashboard view with team members less comfortable with CLI

Flags

Flag Default Description
-p, --project Run in project mode (uses .skillshare/)
-g, --global Run in global mode (uses ~/.config/skillshare/)
--port <port> 19420 HTTP server port
--host <host> 127.0.0.1 Bind address (use 0.0.0.0 for Docker)
--no-open false Don't open browser automatically
--clear-cache Clear downloaded UI cache and exit

:::tip Auto-Detection If .skillshare/config.yaml exists in the current directory, the dashboard automatically starts in project mode. Use -g to force global mode. :::

Examples

# Default: opens browser on localhost:19420
skillshare ui

# Project mode (manage .skillshare/ skills)
skillshare ui -p

# Custom port
skillshare ui --port 8080

# Docker / remote access
skillshare ui --host 0.0.0.0 --no-open

# Background mode
skillshare ui --no-open &

Dashboard Pages

Page Description
Dashboard Overview cards — skill count, target count, sync mode, version
Skills Searchable skill grid with metadata. Toggle between Grid and Grouped (by directory) views. Click to view SKILL.md content
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 backup list, restore snapshots, and clean up entries
Git Sync Push/pull source repo with dirty-state checks and force pull
Search GitHub skill search with one-click install
Audit Security scan all skills, view findings by severity
Audit Rules Create and edit custom audit-rules.yaml with YAML editor
Trash View soft-deleted skills, restore or permanently delete
Log Operations and audit logs with command/status/time filters
Config YAML config editor with validation

Project Mode Differences

When running in project mode (-p), the dashboard adapts:

  • "Project" badge in the sidebar indicates project mode
  • Git Sync page is hidden (project skills use the project's own git)
  • Backup & Restore page is hidden (use version control instead)
  • Tracked Repos section is hidden from Dashboard (not applicable)
  • Config page shows .skillshare/config.yaml instead of the global config
  • Available targets lists project-level targets (e.g., .claude/skills/ relative to project root)
  • Install automatically reconciles skills: entries in the project config

UI Preview

Install flow Dashboard overview Skills browser Skill detail view Sync controls GitHub search view

REST API

The web dashboard exposes a REST API at /api/. All endpoints return JSON.

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, include/exclude filters, and per-target expected counts
POST /api/targets Add a target
DELETE /api/targets/{name} Remove a target
POST /api/sync Run sync (supports 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/audit Scan all skills for security threats
GET /api/audit/rules Get custom audit rules YAML
PUT /api/audit/rules Save custom audit rules (validates regex)
POST /api/audit/rules Create starter audit-rules.yaml
GET /api/log List log entries with optional filters
GET /api/config Get config as YAML
PUT /api/config Update config YAML

Docker Usage

To use the web UI inside Docker (requires network access for first-time UI download):

make playground

# Inside container:
skillshare ui --host 0.0.0.0 --no-open

Then open http://localhost:19420 on your host machine (port 19420 is mapped automatically).

Project Mode

The web dashboard fully supports project-level skills:

cd my-project
skillshare ui -p

Or simply skillshare ui if .skillshare/config.yaml exists (auto-detected).

The dashboard reads and writes .skillshare/config.yaml, syncs to project-local targets, and reconciles remote skill entries after install — just like the CLI.

Runtime UI Download

skillshare ui automatically downloads pre-built UI assets from the matching GitHub Release on first launch. The assets are cached in ~/.cache/skillshare/ui/<version>/ (respects XDG_CACHE_HOME) so subsequent launches are instant and offline.

  • First run requires an internet connection to download the UI assets (~1 MB)
  • Subsequent runs use the cached assets — no network needed
  • On upgrade, old cached versions are automatically cleaned up; the new UI is pre-downloaded during skillshare upgrade
  • To clear the cache manually, run skillshare ui --clear-cache

Homebrew Note

All install methods (Homebrew, installer script, manual binary) use runtime UI download. When you run skillshare ui, it automatically downloads the UI assets from GitHub on first launch. After that, the cached assets are used offline.

To clear the downloaded UI cache:

skillshare ui --clear-cache

Architecture

The web UI is a single-page React application downloaded at runtime from the matching GitHub Release and served from disk cache (~/.cache/skillshare/ui/<version>/).

skillshare ui
  ├── Go HTTP server (net/http)
  │   ├── /api/*    → REST API handlers
  │   └── /*        → Cached React SPA (runtime download)
  └── Browser opens http://127.0.0.1:19420

See Also