mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-19 02:17:09 +00:00
* docs(proposals): propose agent-specific skill variants Tracked repositories can ship different files for the same skill across agents. Counting and syncing each copy independently sends incompatible instructions to every target unless users maintain routing filters. Propose repository-scoped logical identity and exact variant routing while preserving source files, explicit controls, and existing naming behavior. Leave activation and compatibility decisions for maintainer review. Refs #648 * docs(proposals): clarify variant routing compatibility Explain how recognition affects universal-only targets and how existing per-variant overrides preserve the desired routing. Fix the precedence between variant identity and generic host-style path inference. Include analyze, move, and catalog consumers while preserving physical identifiers and actual context-cost accounting. Refs #648 * docs(proposals): clarify activation assumptions and scope Make acceptance cases conditional on maintainer-approved recognition being enabled for the tracked source. Separate the provisional implementation estimate from this proposal-only PR so its size is clear. Refs #648 * docs(proposals): qualify naming and opt-in assumptions State that the reproduced routing behavior uses default flat target naming. Leave any opt-in surface with the maintainer's activation decision without ruling out future CLI or config fields. Refs #648 * feat: recognize and route tracked agent skill variants Count tracked variants as logical skills in source and repository summaries, while preserving physical paths, sync operations, and context costs. Select matching canonical agent variants, including account targets, through shared discovery and selection with existing explicit routing precedence. Refs #648 * fix: count logical skills in sync inventory summaries Use shared logical and physical inventory counts in global and project sync closing lines while preserving each target's operation totals. Refs #648 * fix: preserve variant routing diagnostics across previews Resolve target selections once so CLI and server previews keep ambiguity reasons and physical skip counts. Explain managed variants removed by automatic agent routing, and report logical inventory in doctor. Keep warning rows read-only, document upgrade recovery in translated filtering references, and remove the optional README-only addition. Refs #648 * fix: align sync matrix previews with shared variant selection Classify the full source selection once per target so matrix previews honor canonical aliases, account identity, exact-agent routing, and ambiguous variant skips. Preserve each rejected physical path's existing diagnostic and draft filter disambiguation; skipped preview rows remain read-only. Refs #648 * test: expect singular skill wording in doctor source checks Keep the undiscovered-link count assertion aligned with logical source inventory formatting for one skill in global and project mode. Refs #648 * fix: retain selection diagnostics in catalog and diff verdicts Report warning-only diff targets as requiring attention while preserving local-only folder semantics. Reuse shared per-path selection diagnostics in target-scoped catalogs without applying target naming to served paths. Compute source counts once in summary callers and require variant counts in the source status formatter. Refs #648 * test: tighten tracked variant preview fixtures Use a real committed tracked repository for status counts, verify sync preview banners retain server warnings, and use emitted ambiguity reason text in target preview fixtures. Refs #648 * fix(sync): keep agent variants in shared target folders Compatible targets sharing a skills folder need a combined selection so Codex and universal do not prune one another in merge or copy mode. Carry every shared reader through selection, pruning and previews, including project targets, account identities and path aliases. Require a matching skill suffix under two distinct agents before inferring variants, keeping ordinary agent-named categories unrestricted. Separate naming warnings from ambiguous selection in diff and explain ambiguous removals. Add global/project regression coverage for repeated sync, target-only sync, status JSON, diff and API consumers. * fix(variants): align consumer counts, hints and diagnostics Use logical source counts in list, tracked install and init summaries while matching audit caches against physical variants. Restore localized dashboard skip hints and explain symlink routing limits in status and doctor, including project and JSON output. Document paired-agent detection and compatible shared-folder selection in the proposal, built-in skill and English plus translated command pages. Add focused regressions for the affected consumers. * fix(sync): cover initial sync and ignored variant diagnostics Init syncs a fresh in-memory config, so resolve shared target identities before its first sync as well as when loading saved configuration. A whole-directory symlink exposes ignored skills too. Diagnose agent variants using physical inventory when active discovery has none, while keeping logical counts and merge/copy selection restricted to enabled skills. Cover global/project JSON status and doctor with regressions. Reuse sourcewalk directory and canonical-path helpers so traversal guards remain enforced and path resolution has a single existing owner. * fix(variants): address conversion, counts and selection diagnostics Ignore runtime agent identities when comparing convertible project targets and count logical skills during init. Keep selection warnings separate from naming warnings and preserve agent-named parent skills as ordinary skills. Cover account sync/prune, project ambiguity and overrides in merge/copy modes, and init/status agreement. Focused verification ran in an isolated Linux Codex container, not the devcontainer, as authorized. * refactor(variants): remove obsolete selection helpers Remove the unused FilterSkillsByTarget wrapper and prune agent parameter, cache canonical target aliases once, and restore catalog skip ordering to avoid an unrelated behavior change. Completes the optional cleanup from PR 649 review. * fix(ui): expose localized variant selection diagnostics Show target warnings with source paths, localize ambiguity across preview and detail consumers, and let skipped preview rows add a physical exclude pattern. Show tracked repository variant counts alongside logical skills. Drop display-only rendered cases while retaining mutation protection and plain TypeScript logic coverage. Inspect target states in Clean/Playful light/dark and Traditional Chinese. * docs(variants): explain diagnostics and add sync runbook Document doctor variant_routing and logical/physical counts, diff selection skips, and the nested parent-skill boundary. Keep all four command translations aligned and add isolated account/project E2E scenarios. Both runbook steps passed in the authorized Linux Codex container with separate HOME/XDG/TMPDIR fixtures. Website typecheck and all five locale builds passed. * test(config): use native paths in project conversion fixture The shared-agent regression fixture appended slash-separated suffixes to Windows temporary paths, so project path matching returned no candidates. Build each path with filepath.Join and preserve all conversion assertions. Focused project configuration tests passed in the authorized isolated Linux Codex container, not the devcontainer. Windows CI verifies the platform-specific fixture correction. * fix(ui): recompute shared skill routing for filter previews Evaluate edited include/exclude settings in the complete target map before classifying the draft, so a formerly shared folder no longer keeps its old union when the filters differ. Preserve the saved target configuration. * fix(mcp): keep parent skills when peer variants route elsewhere Do not treat an otherwise eligible variant for another agent as an unserved nested skill. Continue blocking parent publication for explicitly filtered, disabled, ambiguous, or invalid children so filters still hide their files. * fix(ui): distinguish agent selection from naming skips Expose separate naming and selection skip counts on target summaries. Show each applicable remedy in target details and sync previews so ambiguity keeps its filter/override guidance alongside naming and collision hints. * fix(list): include disabled rows in tracked repository counts Count the complete inventory that list displays, including ignored skills and physical variants, without changing the enabled counts used by status, install, or sync. Clone rows before counting to preserve disabled state. * docs: align variant counts and routing recovery guidance Show logical skill and physical variant counts in list/install documentation and keep the four translations aligned with the filtering examples. Explain that agent-named skill parents keep ordinary nested skills and retain the devcontainer-only runbook environment. Removal warnings now recommend a source-local override, since include filters cannot undo agent routing. * fix(mcp): preserve explicit target restrictions on nested variants Limit the differently routed child exemption to automatic layout inference. Frontmatter targets and dashboard source-local overrides must still prevent a parent from publishing files explicitly restricted to another target. * fix(ui): fill target name in naming warning guidance Pass the current target name when rendering localized warning hints so the same naming guidance shown beside the controls does not expose a placeholder in the warning banner. Verified in the populated target preview. --------- Co-authored-by: Willie <egg358358@gmail.com>
749 lines
27 KiB
Markdown
749 lines
27 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
---
|
|
|
|
# sync
|
|
|
|
Push skills from source to all targets.
|
|
|
|
Use `skillshare sync hooks` for native hooks (see [hooks](./hooks.md)).
|
|
Use `skillshare sync mcp` for MCP connection settings, or `skillshare sync --all`
|
|
to include skills, agents, extras, MCP and hooks. MCP synchronization uses entry
|
|
ownership and conflict checks rather than skill symlinks. See [mcp](/docs/reference/commands/mcp).
|
|
|
|
:::info Why is sync a separate command?
|
|
Operations like `install` and `uninstall` only modify source — sync propagates to targets. This lets you batch changes, preview with `--dry-run`, and control when targets update. See [Why Sync is a Separate Step](/docs/understand/source-and-targets#why-sync-is-a-separate-step).
|
|
:::
|
|
|
|
## Agent-specific skill variants
|
|
|
|
In a tracked repository, `skills/<known-agent>/<skill-path>/SKILL.md` is recognized as an agent-specific variant only when the same complete skill path exists under at least two distinct canonical agents beneath the same `skills/` parent. Aliases of one agent alone do not qualify. A lone category such as `skills/agents/planner` remains an ordinary skill.
|
|
|
|
In merge/copy mode, variants route to the matching agent, including aliases and account targets. Compatible targets sharing one skills folder select the union of their agent identities: Codex and `universal` sharing `~/.agents/skills` keep the Codex variants. Each reader sees that shared union; incompatible settings still produce overlap/conflict diagnostics. Explicit source-local target overrides and frontmatter routing retain precedence, and ignores and include/exclude filters still apply.
|
|
|
|
Source and repository summaries count logical skills once and show physical variants separately, for example `2 skills, 4 variants`. Per-target sync operations remain physical counts. Whole-directory symlink mode exposes every variant; `status` and `doctor` explain this limitation and recommend merge or copy for automatic routing.
|
|
|
|
## When to Use
|
|
|
|
- After installing, uninstalling, or editing skills — propagate changes to all targets
|
|
- After changing a target's sync mode — apply the new mode
|
|
- Periodically to ensure all targets are in sync
|
|
|
|
## Command Overview
|
|
|
|
| Type | Command | Direction |
|
|
|------|---------|-----------|
|
|
| **Local sync** | `sync` / `collect` | Source ↔ Targets |
|
|
| **Remote sync** | `push` / `pull` | Source ↔ Git Remote |
|
|
|
|
- `sync` = Distribute from Source to Targets
|
|
- `collect` = Collect from Targets back to Source
|
|
- `push` = Push to git remote
|
|
- `pull` = Pull from git remote and sync
|
|
|
|
## Overview
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
REMOTE["`Remote
|
|
(git)`"]
|
|
SOURCE["`SOURCE
|
|
~/.config/skillshare/skills/`"]
|
|
CLAUDE["Claude"]
|
|
CURSOR["Cursor"]
|
|
CODEX["Codex"]
|
|
|
|
SOURCE -- push --> REMOTE
|
|
REMOTE -- pull --> SOURCE
|
|
SOURCE -- sync --> CLAUDE
|
|
SOURCE -- sync --> CURSOR
|
|
SOURCE -- sync --> CODEX
|
|
CLAUDE -- collect --> SOURCE
|
|
CURSOR -- collect --> SOURCE
|
|
CODEX -- collect --> SOURCE
|
|
```
|
|
|
|
| Command | Direction | Description |
|
|
|---------|-----------|-------------|
|
|
| `sync` | Source → Targets | Push skills to all targets |
|
|
| `collect <target>` | Target → Source | Collect skills from target to source |
|
|
| `push` | Source → Remote | Commit and push to git |
|
|
| `pull` | Remote → Source → Targets | Pull from git, then sync |
|
|
|
|
---
|
|
|
|
## Project Mode
|
|
|
|
When `.skillshare/config.yaml` exists in the current directory, sync auto-detects project mode:
|
|
|
|
```bash
|
|
cd my-project/
|
|
skillshare sync # Auto-detected project mode
|
|
skillshare sync -p # Explicit project mode
|
|
```
|
|
|
|
**Project sync** defaults to merge mode (per-skill symlinks), but each target can be set to copy or symlink mode via `skillshare target <name> --mode copy -p`. Backup is not created (project targets are reproducible from source).
|
|
|
|
When sync adopts a hand-moved declared skill, only that skill's project entry,
|
|
ignore rule and existing lock pin follow the move. A stale install record alone
|
|
does not change `config.yaml`, `.gitignore` or `skills.lock.json`, and other
|
|
remote installs in the source are not added to the project's `skills:` list.
|
|
|
|
```
|
|
.skillshare/skills/ .claude/skills/
|
|
├── my-skill/ ────────► ├── my-skill/ → (symlink)
|
|
├── pdf/ ────────► ├── pdf/ → (symlink)
|
|
└── ... └── local/ (preserved)
|
|
```
|
|
|
|
### Cleanup after a default path moves {#project-path-cleanup}
|
|
|
|
A project config stores target names, not paths, so a target follows its built-in
|
|
default. When a tool changes that default — as goose and openhands did when they
|
|
adopted `.agents/skills` — the skills skillshare wrote to the old directory stay
|
|
behind, and the tool reads both locations and lists every skill twice.
|
|
|
|
Project sync removes them. For each target without an explicit `path:`, it looks
|
|
at the directories that target's runtime also scans, and in any of them that no
|
|
configured target writes to, it removes the entries skillshare created. Folders
|
|
you made yourself and symlinks pointing outside the project are never touched.
|
|
|
|
```
|
|
Cleaned 1 leftover skill from .goose/skills: the default path for 'goose' moved to .agents/skills
|
|
```
|
|
|
|
Setting an explicit `path:` for a target opts it out of the cleanup, and
|
|
`--dry-run` previews what would be removed without changing anything.
|
|
|
|
---
|
|
|
|
## Sync
|
|
|
|
Push skills from source to all targets.
|
|
|
|
```bash
|
|
skillshare sync # Sync skills to all targets
|
|
skillshare sync agents # Sync agents only
|
|
skillshare sync --all # Sync skills + agents + extras + MCP + hooks
|
|
skillshare sync --dry-run # Preview changes
|
|
skillshare sync -n # Short form
|
|
skillshare sync --force # Overwrite all managed skills
|
|
skillshare sync -f # Short form
|
|
```
|
|
|
|
| Flag | Short | Description |
|
|
|------|-------|-------------|
|
|
| `--all` | | Also sync agents, extras, MCP and hooks after skills (excludes plugins) |
|
|
| `--dry-run` | `-n` | Preview changes without writing |
|
|
| `--force` | `-f` | Overwrite all managed entries regardless of checksum (copy mode) or replace existing directories with symlinks (merge mode) |
|
|
| `--json` | | Output as JSON |
|
|
| `--quiet` | `-q` | Suppress token summary and budget warnings |
|
|
|
|
### JSON Output
|
|
|
|
```bash
|
|
skillshare sync --json
|
|
```
|
|
|
|
```json
|
|
{
|
|
"targets": 3,
|
|
"linked": 12,
|
|
"local": 2,
|
|
"updated": 0,
|
|
"pruned": 1,
|
|
"ignored_count": 2,
|
|
"ignored_skills": ["_team/vendor/lib", "test-draft"],
|
|
"dry_run": false,
|
|
"duration": "0.234s",
|
|
"warnings": ["source link _dev-skills not followed: target is missing; kept existing target entries, nothing pruned this run"],
|
|
"details": [
|
|
{
|
|
"name": "claude",
|
|
"mode": "merge",
|
|
"linked": 8,
|
|
"local": 2,
|
|
"updated": 0,
|
|
"pruned": 1
|
|
},
|
|
{
|
|
"name": "cursor",
|
|
"mode": "merge",
|
|
"linked": 4,
|
|
"local": 0,
|
|
"updated": 0,
|
|
"pruned": 0
|
|
}
|
|
],
|
|
"context_cost": {
|
|
"groups": [
|
|
{
|
|
"targets": ["claude", "cursor"],
|
|
"always_loaded_tokens": 12400,
|
|
"on_demand_tokens": 58200
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
The `ignored_count` and `ignored_skills` fields show skills excluded by `.skillignore` (and `.skillignore.local` if present). These are filtered at discovery time and never reach any target. When `.skillignore.local` is active, the text output includes a `.local` source hint. See [.skillignore](/docs/reference/appendix/file-structure#skillignore-optional) for pattern syntax.
|
|
|
|
`warnings` appears only when a first-level source link was not followed (see [`follow_source_links`](../targets/configuration.md#follow_source_links)). A run that kept target entries because the link's target was unavailable says so there; `pruned` is `0` in that case by design.
|
|
|
|
### What Happens
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
TITLE["skillshare sync"]
|
|
S1["1. Backup targets (global only)"]
|
|
S2["2. For each target"]
|
|
MERGE["merge mode"]
|
|
SYMLINK["symlink mode"]
|
|
S3["3. Report results"]
|
|
TITLE --> S1 --> S2
|
|
COPY["copy mode"]
|
|
S2 --> MERGE --> S3
|
|
S2 --> COPY --> S3
|
|
S2 --> SYMLINK --> S3
|
|
```
|
|
|
|
### When a target fails {#when-a-target-fails}
|
|
|
|
Sync runs every target; one failed target does not stop the others. A target fails when syncing it hits an error, or when its own settings in the config are invalid, for example its skills path is a file instead of a folder or its `mode` is unknown. A target with invalid settings is skipped for skills and agents in that run. Each failed target is reported (`✗ <target> invalid config: …` in text output, `error` in its `--json` `details` entry), and the command exits non-zero after the other targets have synced.
|
|
|
|
Problems with the config as a whole still stop sync before any target runs: a missing or invalid source folder, an invalid global `mode` or `target_naming`, an invalid `git_root`, or invalid extras.
|
|
|
|
### Example Output
|
|
|
|
```text
|
|
$ skillshare sync
|
|
✓ Backup claude, claude-work, cursor, gemini, opencode, universal → ~/.local/share/skillshare/backups/2026-09-28_12-52-50
|
|
✓ claude 43 linked · 1 pruned
|
|
✓ claude-work 43 linked · 1 pruned
|
|
✓ cursor 43 linked · 1 local · 1 pruned
|
|
✓ gemini 43 linked · 1 pruned
|
|
✓ opencode 43 linked · 1 pruned
|
|
✓ universal 43 linked · 1 pruned
|
|
|
|
✓ Synced 43 skills to 6 targets · 0.0s
|
|
Context ~1.2K tokens always loaded · ~18.5K on demand
|
|
```
|
|
|
|
When a folder you made already sits on the name a skill syncs to, sync keeps your folder and does not install the skill. Each target with such folders gets one line naming the first few (`kept local: a, b (sync --force replaces them)`), and they count as `local` instead of `up to date`. `skillshare diff` lists them as `Local override`.
|
|
|
|
---
|
|
|
|
## Collect
|
|
|
|
Collect skills from a target back to source.
|
|
|
|
```bash
|
|
skillshare collect claude # Collect from Claude
|
|
skillshare collect claude --dry-run # Preview
|
|
skillshare collect --all # Collect from all targets
|
|
```
|
|
|
|
**When to use**: You created/edited a skill directly in a target (e.g., `~/.claude/skills/`) and want to bring it to source.
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
TITLE["skillshare collect claude"]
|
|
S1["1. Find local skills in target"]
|
|
S2["2. Copy to source"]
|
|
S3["3. Replace with symlink"]
|
|
TITLE --> S1 --> S2 --> S3
|
|
```
|
|
|
|
**After collecting:**
|
|
```bash
|
|
skillshare collect claude
|
|
skillshare sync # ← Distribute to other targets
|
|
```
|
|
|
|
---
|
|
|
|
## Pull
|
|
|
|
Pull from git remote and sync to all targets.
|
|
|
|
```bash
|
|
skillshare pull # Pull from git remote
|
|
skillshare pull --dry-run # Preview
|
|
```
|
|
|
|
**When to use**: You pushed changes from another machine and want to sync them here.
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
TITLE["skillshare pull"]
|
|
S1["1. git pull"]
|
|
S2["2. skillshare sync"]
|
|
TITLE --> S1 --> S2
|
|
```
|
|
|
|
---
|
|
|
|
## Push
|
|
|
|
Commit and push source to git remote.
|
|
|
|
```bash
|
|
skillshare push # Auto-generated message
|
|
skillshare push -m "Add pdf" # Custom message
|
|
```
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
TITLE["skillshare push -m 'Add pdf skill'"]
|
|
S1["`cd source
|
|
git add → commit → push`"]
|
|
TITLE --> S1
|
|
```
|
|
|
|
**Conflict handling:**
|
|
- If remote is ahead, `push` fails → run `pull` first
|
|
|
|
---
|
|
|
|
## Dotfiles Manager Compatibility {#dotfiles-manager-compatibility}
|
|
|
|
If you use a dotfiles manager (GNU Stow, chezmoi, yadm, bare-git) that symlinks your source or target directories, skillshare handles it transparently:
|
|
|
|
```
|
|
# Dotfiles manager creates:
|
|
~/.config/skillshare/skills/ → ~/dotfiles/ss-skills/ # symlinked source
|
|
~/.claude/skills/ → ~/dotfiles/claude-skills/ # symlinked target
|
|
```
|
|
|
|
- **Symlinked source** — all commands (`sync`, `update`, `uninstall`, `list`, `diff`, `install`) resolve the symlink before walking, so skills are discovered correctly. Chained symlinks (link → link → real dir) also work.
|
|
- **Symlinked target** — `sync` detects that the target symlink was **not** created by skillshare and preserves it. Skills are synced into the resolved directory.
|
|
- **Status/collect** — `status` and `collect` follow external target symlinks instead of reporting conflicts.
|
|
|
|
:::info How sync decides
|
|
When a target directory is a symlink, sync checks whether it points to the skillshare source directory. Only symlinks created by skillshare's own symlink mode are removed during mode conversion — external symlinks (from dotfiles managers) are always preserved.
|
|
:::
|
|
|
|
---
|
|
|
|
## Sync Modes
|
|
|
|
| Mode | Behavior | Use case |
|
|
|------|----------|----------|
|
|
| `merge` | Each skill symlinked individually | **Default.** Preserves local skills. |
|
|
| `copy` | Each skill copied as real files | Compatibility-first setups, vendoring skills into a project repo, or environments where symlink behavior is unreliable. |
|
|
| `symlink` | Entire directory is one symlink | Exact copies everywhere. |
|
|
|
|
Per-target override remains the primary tuning knob:
|
|
|
|
```bash
|
|
skillshare target <name> --mode copy
|
|
skillshare sync
|
|
```
|
|
|
|
The compatibility hint is printed by [`doctor`](./doctor.md), not by `sync`. Its example target is chosen in this priority:
|
|
`cursor` → `antigravity` → `copilot` → `opencode`.
|
|
If none of these targets exist (or they already run `copy`), no compatibility hint is shown.
|
|
|
|
See [Sync Modes](/docs/understand/sync-modes) for a neutral decision matrix.
|
|
|
|
### Per-target include/exclude filters {#per-target-includeexclude-filters}
|
|
|
|
In merge and copy modes, each target can define `include` / `exclude` patterns in config:
|
|
|
|
```yaml
|
|
targets:
|
|
codex:
|
|
path: ~/.codex/skills
|
|
include: [codex-*]
|
|
claude:
|
|
path: ~/.claude/skills
|
|
exclude: [codex-*]
|
|
```
|
|
|
|
- Matching is against flat target names (for example `team__frontend__ui`)
|
|
- An `include` pattern that matches no skill is reported, because such a target syncs nothing and drops what a previous pattern linked. Filters keep using flat names even when `target_naming: standard` or `prefixed` names the target entry after `SKILL.md`
|
|
- `include` is applied first, then `exclude`
|
|
- `diff`, `status`, `doctor`, and UI drift all use the filtered expected set
|
|
- In symlink mode, filters are ignored
|
|
- In copy mode, filters work the same way as merge mode
|
|
- `sync` removes existing source-linked or managed entries that are now excluded
|
|
- Targets that share one folder need the same filters, mode and target naming (filters and naming don't matter when both use `symlink` mode); otherwise each sync undoes the other and `sync` warns (see [`sync` keeps showing the same changes](/docs/troubleshooting/common-errors#sync-keeps-showing-the-same-changes))
|
|
|
|
See [Configuration](/docs/reference/targets/configuration#include--exclude-target-filters) for full details.
|
|
|
|
:::tip
|
|
These are just one of three filtering layers. See [Filtering Skills](/docs/how-to/daily-tasks/filtering-skills) for a complete guide covering `.skillignore`, SKILL.md `targets`, and target filters.
|
|
:::
|
|
|
|
### Filter behavior examples {#filter-behavior-examples}
|
|
|
|
Assume source contains:
|
|
- `core-auth`
|
|
- `core-docs`
|
|
- `codex-agent`
|
|
- `codex-experimental`
|
|
- `team__frontend__ui`
|
|
|
|
#### `include` only
|
|
|
|
```yaml
|
|
targets:
|
|
codex:
|
|
path: ~/.codex/skills
|
|
include: [codex-*, core-*]
|
|
```
|
|
|
|
After `sync`, codex receives:
|
|
- `core-auth`
|
|
- `core-docs`
|
|
- `codex-agent`
|
|
- `codex-experimental`
|
|
|
|
Use this when a target should receive only a curated subset.
|
|
|
|
#### `exclude` only
|
|
|
|
```yaml
|
|
targets:
|
|
claude:
|
|
path: ~/.claude/skills
|
|
exclude: [codex-*, *-experimental]
|
|
```
|
|
|
|
After `sync`, claude receives:
|
|
- `core-auth`
|
|
- `core-docs`
|
|
- `team__frontend__ui`
|
|
|
|
Use this when a target should get "almost everything" except specific groups.
|
|
|
|
#### `include` + `exclude`
|
|
|
|
```yaml
|
|
targets:
|
|
cursor:
|
|
path: ~/.cursor/skills
|
|
include: [core-*, codex-*]
|
|
exclude: [*-experimental]
|
|
```
|
|
|
|
After `sync`, cursor receives:
|
|
- `core-auth`
|
|
- `core-docs`
|
|
- `codex-agent`
|
|
|
|
`codex-experimental` is first included, then removed by `exclude`.
|
|
|
|
#### What gets removed when filters change
|
|
|
|
When a filter is updated and `sync` runs:
|
|
- Links skillshare created for source skills that are now filtered out are pruned
|
|
- A live symlink/junction into the source that skillshare never tracked is preserved and counted as local
|
|
- Local non-symlink folders already in target are preserved
|
|
|
|
### Merge Mode (Default)
|
|
|
|
```
|
|
Source Target (claude)
|
|
─────────────────────────────────────────────────────────────
|
|
skills/ ~/.claude/skills/
|
|
├── my-skill/ ────────► ├── my-skill/ → (symlink)
|
|
├── another/ ────────► ├── another/ → (symlink)
|
|
└── ... ├── local-only/ (preserved)
|
|
└── .skillshare-manifest.json
|
|
```
|
|
|
|
### Copy Mode
|
|
|
|
```
|
|
Source Target (cursor)
|
|
─────────────────────────────────────────────────────────────
|
|
skills/ ~/.cursor/skills/
|
|
├── my-skill/ ────copy► ├── my-skill/ (real files)
|
|
├── another/ ────copy► ├── another/ (real files)
|
|
└── ... ├── local-only/ (preserved)
|
|
└── .skillshare-manifest.json
|
|
```
|
|
|
|
Both merge and copy modes write `.skillshare-manifest.json` to track managed skills. In copy mode, checksums enable incremental sync (unchanged skills are skipped); `--force` overwrites all.
|
|
|
|
### Symlink Mode
|
|
|
|
```
|
|
Source Target (claude)
|
|
─────────────────────────────────────────────────────────────
|
|
skills/ ────────► ~/.claude/skills → (symlink to source)
|
|
├── my-skill/
|
|
├── another/
|
|
└── ...
|
|
```
|
|
|
|
### Change Mode
|
|
|
|
```bash
|
|
skillshare target claude --mode merge
|
|
skillshare target claude --mode copy
|
|
skillshare target claude --mode symlink
|
|
skillshare sync # Apply change
|
|
```
|
|
|
|
### Safety Warning
|
|
|
|
> **In symlink mode, deleting through target deletes source!**
|
|
> ```bash
|
|
> rm -rf ~/.claude/skills/my-skill # ❌ Deletes from SOURCE
|
|
> skillshare target remove claude # ✅ Safe way to unlink
|
|
> ```
|
|
|
|
---
|
|
|
|
## Backup
|
|
|
|
Backups are created **automatically** before `sync` and `target remove`.
|
|
|
|
Location: `~/.local/share/skillshare/backups/<timestamp>/`
|
|
|
|
A snapshot captures only **local** target content. Merge-mode symlinks are skipped — they point into your source and `sync` recreates them — so snapshots stay small no matter how large your skills are. Retention is applied automatically after each sync. See [What Gets Backed Up](/docs/reference/commands/backup#what-gets-backed-up) and [Backups & Disk Space](/docs/reference/commands/backup#backups--disk-space).
|
|
|
|
### Manual Backup
|
|
|
|
```bash
|
|
skillshare backup # Backup all targets
|
|
skillshare backup claude # Backup specific target
|
|
skillshare backup --list # List all backups
|
|
skillshare backup --cleanup # Remove old snapshots and abandoned incomplete directories
|
|
skillshare backup --dry-run # Preview
|
|
```
|
|
|
|
### Example Output
|
|
|
|
```
|
|
$ skillshare backup --list
|
|
|
|
Backups
|
|
─────────────────────────────────────────
|
|
2026-01-20_15-30-00/
|
|
claude/ 5 skills, 2.1 MB
|
|
cursor/ 5 skills, 2.1 MB
|
|
2026-01-19_10-00-00/
|
|
claude/ 4 skills, 1.8 MB
|
|
```
|
|
|
|
---
|
|
|
|
## Restore
|
|
|
|
Restore targets from backup.
|
|
|
|
```bash
|
|
skillshare restore claude # Latest backup
|
|
skillshare restore claude --from 2026-01-19_10-00-00 # Specific backup
|
|
skillshare restore claude --dry-run # Preview
|
|
```
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
CMD["skillshare restore claude"]
|
|
FIND["1. Find latest backup"]
|
|
REMOVE["2. Remove current target"]
|
|
COPY["3. Copy backup to target"]
|
|
CMD --> FIND --> REMOVE --> COPY
|
|
```
|
|
|
|
---
|
|
|
|
## Agent Sync {#agent-sync}
|
|
|
|
Agents are synced separately from skills. Use `sync agents` for agent-only sync, or `sync --all` to include skills, agents, extras, MCP, and hooks:
|
|
|
|
```bash
|
|
skillshare sync # Sync skills only (default)
|
|
skillshare sync agents # Sync agents only
|
|
skillshare sync --all # Sync skills + agents + extras + MCP + hooks
|
|
```
|
|
|
|
Agent sync supports all three modes (merge, copy, symlink), matching the target's configured mode. On Windows without Developer Mode, merge mode copies agent files instead of linking them and prints `! <target>: agents file links need Windows Developer Mode; copying instead`; see [Windows troubleshooting](/docs/troubleshooting/windows#file-links-need-windows-developer-mode-copying-instead). Only targets with an `agents` path definition receive agent syncs — currently Claude, Cursor, OpenCode, and Augment. See [Agents — Supported Targets](/docs/understand/agents#supported-targets) for the full list.
|
|
|
|
Orphan cleanup, `.agentignore` filtering, and per-target include/exclude filters all work the same way as for skills. In merge mode, orphan cleanup removes only broken links and links that point into the agents source; live links to agent files elsewhere and local files are preserved.
|
|
|
|
---
|
|
|
|
## Sync Plugins
|
|
|
|
`sync plugins [name]` is an alias for [`plugin sync`](./plugin.md). Plugins are
|
|
**excluded from `sync --all`** and use native installation operations instead of
|
|
skill sync modes.
|
|
|
|
```bash
|
|
skillshare sync plugins --dry-run --json
|
|
skillshare sync plugins demo --target claude --no-tui
|
|
```
|
|
|
|
`plugin enable` and `plugin disable` save target selection only. The next plugin
|
|
sync installs selected bindings and uninstalls deselected ones while keeping their
|
|
definitions. Unmanaged plugins are unaffected. Plugin sync accepts `--target`,
|
|
`--dry-run`, `--json`, `--no-tui`, `--revision`, and mode flags; ordinary sync options
|
|
such as `--force`, `--quiet`, and `--all` do not apply. See [plugin](./plugin.md) for
|
|
native client requirements, project scope, and partial-failure recovery.
|
|
|
|
## Sync Extras {#sync-extras}
|
|
|
|
Sync non-skill resources (rules, commands, prompts, etc.) to arbitrary directories. Extras are configured separately from skills and have their own source directories.
|
|
|
|
```bash
|
|
skillshare sync extras # Sync all configured extras
|
|
skillshare sync extras --dry-run # Preview changes
|
|
skillshare sync extras --force # Overwrite conflicting files
|
|
skillshare sync --all # Sync skills + agents + extras + MCP + hooks
|
|
```
|
|
|
|
| Flag | Short | Description |
|
|
|------|-------|-------------|
|
|
| `--dry-run` | `-n` | Preview changes without writing |
|
|
| `--force` | `-f` | Overwrite conflicting files at target |
|
|
|
|
`--json` returns a non-zero exit status when extras sync has errors. `sync --all` also exits
|
|
non-zero when an extras target fails, with or without `--json`. An extra whose source
|
|
directory does not exist is skipped with a hint, not created. For single-file extras,
|
|
`--dry-run` also reports edits that would be backed up before replacement.
|
|
|
|
:::info Both modes supported
|
|
`sync extras` works in both global and project mode. Use `sync --all` to sync skills, agents, extras, MCP, and hooks together, or `sync extras` to sync extras only. In project mode, extras source is `.skillshare/extras/<name>/`.
|
|
:::
|
|
|
|
### Configuration
|
|
|
|
Add an `extras` section to your config (`~/.config/skillshare/config.yaml` for global, `.skillshare/config.yaml` for project):
|
|
|
|
```yaml
|
|
extras:
|
|
- name: rules
|
|
targets:
|
|
- path: ~/.claude/rules
|
|
- path: ~/.cursor/rules
|
|
mode: copy
|
|
- name: commands
|
|
targets:
|
|
- path: ~/.claude/commands
|
|
```
|
|
|
|
Each extra has:
|
|
- **`name`** — directory name under `extras/` in your config directory
|
|
- **`targets`** — list of target paths with optional `mode`
|
|
|
|
Source files live under the `extras/` subdirectory:
|
|
|
|
```
|
|
~/.config/skillshare/
|
|
├── config.yaml
|
|
├── skills/ ← skill source
|
|
└── extras/ ← extras source root
|
|
├── rules/ ← extras: rules
|
|
│ ├── coding.md
|
|
│ └── testing.md
|
|
└── commands/ ← extras: commands
|
|
└── deploy.md
|
|
```
|
|
|
|
### Sync modes
|
|
|
|
| Mode | Behavior |
|
|
|------|----------|
|
|
| `merge` | Per-file symlink from target to source **(default)** |
|
|
| `copy` | Per-file copy |
|
|
| `symlink` | Entire source directory symlinked to target path |
|
|
|
|
In merge mode, only broken symlinks and symlinks into the extra's source are pruned — user-created local files and live links to other locations are preserved.
|
|
|
|
On Windows without Developer Mode, merge mode (and a [single-file extra](./extras.md#single-file-extras) in symlink mode) copies files instead, reports the target as `(copy)`, and prints `file links need Windows Developer Mode; copying instead` under it. These copies are updated and pruned like links, and replaced with links once file links work.
|
|
|
|
Identical local files are reported as `local preserved`; `sync extras` does not suggest `--force` for them. They remain local files, not managed links.
|
|
|
|
### What happens
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
CMD["skillshare sync extras"]
|
|
WALK["1. Discover files in source"]
|
|
EACH["2. For each target"]
|
|
SYNC["Sync files (symlink/copy)"]
|
|
PRUNE["3. Prune orphans"]
|
|
CMD --> WALK --> EACH --> SYNC --> PRUNE
|
|
```
|
|
|
|
1. Walks the source directory (`~/.config/skillshare/extras/<name>/`)
|
|
2. For each target, creates symlinks or copies per configured mode
|
|
3. Removes orphan files in the target that no longer exist in source
|
|
|
|
### Example output
|
|
|
|
```
|
|
$ skillshare sync extras
|
|
|
|
Extras
|
|
✓ rules ~/.claude/rules 2 files linked
|
|
✓ rules ~/.cursor/rules 2 files copied
|
|
✓ commands ~/.claude/commands 1 files linked
|
|
|
|
✓ Synced 2 extras to 3 folders · 0.0s
|
|
```
|
|
|
|
---
|
|
|
|
## Context Cost {#context-cost}
|
|
|
|
After syncing, skillshare displays a token cost summary:
|
|
|
|
```
|
|
✓ Synced 47 skills to 4 targets · 0.3s
|
|
Context ~12.4K tokens always loaded · ~58.2K on demand
|
|
```
|
|
|
|
- **Always-loaded**: frontmatter name + description (loaded every request)
|
|
- **On-demand**: skill body (loaded when triggered)
|
|
|
|
Targets with identical token counts are grouped on one line.
|
|
|
|
### Budget Warnings
|
|
|
|
Configure warning thresholds in your config:
|
|
|
|
```yaml
|
|
context_budget:
|
|
warn_always_loaded_tokens: 10000 # default; 0 = disabled
|
|
warn_on_demand_tokens: 100000 # default; 0 = disabled
|
|
```
|
|
|
|
When a threshold is exceeded, a warning appears with the top 3 offenders:
|
|
|
|
```
|
|
! Always-loaded context is ~50,123 tokens (budget: 10,000)
|
|
Top 3:
|
|
• my-big-skill ~8,200 tokens
|
|
• another-verbose-skill ~6,400 tokens
|
|
• chatgpt-system-prompt ~5,100 tokens
|
|
Run `skillshare analyze` for details.
|
|
```
|
|
|
|
### Quiet Mode
|
|
|
|
Use `--quiet` or `-q` to suppress token summary and budget warnings:
|
|
|
|
```bash
|
|
skillshare sync --quiet
|
|
```
|
|
|
|
JSON output (`--json`) always includes `context_cost` regardless of `--quiet`.
|
|
|
|
---
|
|
|
|
## See Also
|
|
|
|
- [status](/docs/reference/commands/status) — Show sync state
|
|
- [diff](/docs/reference/commands/diff) — Show differences
|
|
- [Targets](/docs/reference/targets) — Manage targets
|
|
- [Cross-Machine Sync](/docs/how-to/sharing/cross-machine-sync) — Sync across computers
|
|
- [install](/docs/reference/commands/install) — Install skills
|
|
- [Configuration](/docs/reference/targets/configuration#extras) — Extras config reference
|