mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-18 18:04:17 +00:00
Command pages updated (7 files): - list: 'skillshare list agents', [A] badge - install: --kind agent, -a flag, auto-detection - sync: agent sync with all three modes, supported targets - check: 'skillshare check agents' drift detection - audit: 'skillshare audit agents' - enable: --kind agent routes to .agentignore - uninstall: --kind agent flag Getting started updated: - first-sync: link to agents concepts in What's Next - quick-reference: agent management command table + agents source path Commands index: added agents row to What do you want to do table.
183 lines
6.2 KiB
Markdown
183 lines
6.2 KiB
Markdown
---
|
|
sidebar_position: 3
|
|
---
|
|
|
|
# check
|
|
|
|
Check for available updates to tracked repositories and installed skills without applying changes.
|
|
|
|
```bash
|
|
skillshare check # Check all repos and skills
|
|
skillshare check my-skill # Check a single skill
|
|
skillshare check a b c # Check multiple skills
|
|
skillshare check --group frontend # Check all skills in frontend/
|
|
skillshare check x -G backend # Mix names and groups
|
|
skillshare check --json # Machine-readable output
|
|
```
|
|
|
|
## When to Use
|
|
|
|
### Before Updating
|
|
|
|
Preview what would change before running `update`:
|
|
|
|
```bash
|
|
skillshare check # See what has updates
|
|
skillshare update --all # Apply updates
|
|
skillshare sync # Distribute changes
|
|
```
|
|
|
|
### CI/CD Pipeline
|
|
|
|
Check for stale skills in CI:
|
|
|
|
```bash
|
|
result=$(skillshare check --json)
|
|
# Parse JSON to detect outdated skills
|
|
```
|
|
|
|
## What It Does
|
|
|
|
`check` inspects your source directory and reports update status for:
|
|
|
|
1. **Tracked repositories** — Fetches from origin, shows how many commits you're behind
|
|
2. **Installed skills (with metadata)** — Compares installed version against the remote HEAD
|
|
3. **Stale skills** — Detects skills whose subdirectory was deleted from the upstream repository
|
|
4. **Local skills** — Marks as "local source" (no remote to compare)
|
|
5. **Skill-level `targets` validation** — Warns about unknown target names in SKILL.md `targets` frontmatter fields
|
|
|
|
Unlike `update`, `check` never modifies any files.
|
|
|
|
## Example Output
|
|
|
|
```
|
|
skillshare check
|
|
|
|
Tracked Repos
|
|
─────────────────────────────────────────
|
|
✓ _team-skills up to date
|
|
⬇ _shared-rules 3 commits behind
|
|
! _design-system has uncommitted changes
|
|
|
|
Installed Skills (remote)
|
|
─────────────────────────────────────────
|
|
✓ pdf up to date anthropics/skills
|
|
⬇ commit update available anthropics/skills
|
|
⚠ old-helper stale (deleted upstream)
|
|
• local-skill local source
|
|
|
|
⚠ 1 skill(s) stale (deleted upstream) — run 'skillshare update --all --prune' to remove
|
|
Summary: 1 repo + 1 skill have updates available
|
|
Run 'skillshare update <name>' or 'skillshare update --all'
|
|
```
|
|
|
|
## Check Specific Skills
|
|
|
|
You can check one or more skills by name instead of scanning everything:
|
|
|
|
```bash
|
|
skillshare check my-skill # Single skill
|
|
skillshare check skill-a skill-b # Multiple skills
|
|
```
|
|
|
|
Use `--group` / `-G` to check all updatable skills in a group directory:
|
|
|
|
```bash
|
|
skillshare check --group frontend # All skills under frontend/
|
|
skillshare check -G frontend -G backend # Multiple groups
|
|
skillshare check my-skill -G frontend # Mix names and groups
|
|
```
|
|
|
|
If a positional name matches a group directory (not a repo or skill itself), it is automatically expanded:
|
|
|
|
```bash
|
|
skillshare check frontend # Auto-detected as group
|
|
```
|
|
|
|
Skills without metadata (local-only) are skipped when expanding groups.
|
|
|
|
## Options
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--group`, `-G` `<name>` | Check all updatable skills in a group (repeatable) |
|
|
| `--project`, `-p` | Check project-level skills (`.skillshare/`) |
|
|
| `--global`, `-g` | Check global skills (`~/.config/skillshare`) |
|
|
| `--json` | Output as JSON (for scripting/CI) |
|
|
| `--help`, `-h` | Show help |
|
|
|
|
:::tip Auto-detection
|
|
If neither `--project` nor `--global` is specified, skillshare auto-detects: if `.skillshare/config.yaml` exists in the current directory, it defaults to project mode; otherwise global mode.
|
|
:::
|
|
|
|
## JSON Output
|
|
|
|
```bash
|
|
skillshare check --json
|
|
```
|
|
|
|
```json
|
|
{
|
|
"tracked_repos": [
|
|
{"name": "_team-skills", "status": "up_to_date", "behind": 0, "branch": "main"},
|
|
{"name": "_shared-rules", "status": "behind", "behind": 3, "branch": "develop"}
|
|
],
|
|
"skills": [
|
|
{"name": "pdf", "source": "anthropics/skills", "version": "a1b2c3d",
|
|
"status": "up_to_date", "installed_at": "2024-06-01T10:00:00Z"},
|
|
{"name": "commit", "source": "anthropics/skills", "version": "x9y8z7w",
|
|
"status": "update_available", "installed_at": "2024-05-15T08:30:00Z"},
|
|
{"name": "old-helper", "source": "anthropics/skills", "version": "d4e5f6g",
|
|
"status": "stale", "installed_at": "2024-03-10T09:00:00Z"},
|
|
{"name": "local-skill", "source": "", "version": "",
|
|
"status": "local", "installed_at": "2024-04-20T12:00:00Z"}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Status Indicators
|
|
|
|
| Icon | Meaning |
|
|
|------|---------|
|
|
| `✓` | Up to date |
|
|
| `⬇` | Update available (tracked repo: commits behind; skill: newer version) |
|
|
| `⚠` | Stale — subdirectory deleted or renamed upstream |
|
|
| `!` | Has uncommitted changes |
|
|
| `•` | Local source (no remote to compare) |
|
|
|
|
:::info Stale skills
|
|
When a skill's subdirectory was renamed or deleted upstream, `check` reports it as **stale**. Use `update --prune` to clean up stale skills.
|
|
:::
|
|
|
|
:::tip Monorepo awareness
|
|
For skills installed from a subdirectory, `check` only reports "update available" when that specific directory changed — not when unrelated parts of the repo have new commits.
|
|
:::
|
|
|
|
## Project Mode
|
|
|
|
```bash
|
|
skillshare check -p # Check all project skills
|
|
skillshare check -p my-skill # Check specific project skill
|
|
skillshare check -p --group frontend # Check project group
|
|
skillshare check -p --json # JSON output for project
|
|
```
|
|
|
|
## Agent Support
|
|
|
|
`skillshare check agents` scopes the check to agents only, reporting drift and update status for `.md` files in the agents source directory:
|
|
|
|
```bash
|
|
skillshare check agents # Check all agents
|
|
skillshare check agents --json # JSON output for agents
|
|
skillshare check agents -p # Check project agents
|
|
```
|
|
|
|
Without the `agents` argument, `check` operates on skills only (default behavior). See [Agents](/docs/understand/agents) for background.
|
|
|
|
## See Also
|
|
|
|
- [update](/docs/reference/commands/update) — Apply updates
|
|
- [list](/docs/reference/commands/list) — View installed skills
|
|
- [status](/docs/reference/commands/status) — Show sync status
|
|
- [Agents](/docs/understand/agents) — Agent concepts
|