Files
skillshare/website/docs/understand/sync-modes.md
T
Willie c638b46096 fix(sync): replace copy-mode copies with links when switching back to merge (#506)
* fix(sync): replace copy-mode copies with links when switching back to merge

Switching a target from copy back to merge left every copy whose entry name
did not change as a real folder. Merge sync treated it as the user's own
folder, so status and doctor kept saying "run skillshare sync" while sync
changed nothing, and only `sync --force` turned it into a link.

Copy mode already replaces merge-mode links with copies on its own, so merge
sync now replaces a folder the manifest records with a checksum (a copy-mode
copy) with a link, without --force. Folders the manifest does not record, or
records as a link, stay untouched. The pre-sync target backup is unchanged.

The CLI and dashboard diffs name these entries as copies sync replaces
instead of suggesting --force, and the sync-modes docs describe the switch.

* fix(sync): keep copy-mode copies the user edited when switching to merge

The first version replaced any folder the manifest recorded as a copy-mode
copy. The manifest checksum is only a record, so a copy edited since copy
mode made it was deleted too, and `sync --json` and project-mode dashboard
sync take no pre-sync backup to restore it from.

Replace the folder only while it still hashes to the recorded checksum
(Manifest.OwnsCopy). An edited copy is kept and `sync --force` still
replaces it; diff keeps suggesting --force for it. A copy whose name: was
rewritten by prefixed naming, or that was made with custom ignore patterns,
no longer hashes to the source checksum and is kept the same way.

* fix(ui): say a copy-mode copy in a merge target is replaced by a link

The Sync page picks a row's text from the diff item's action alone. The
copy-mode copy that merge sync now replaces comes from the server as an
update, which the page worded as "Link is broken or points elsewhere. Will
be relinked" even though no link exists yet.

Match the server's reason and show "Copy made by copy mode. Will be replaced
by a link" instead, in all eleven dashboard languages.

* docs(sync): say only unedited copy-mode copies are replaced on merge sync

The sync-modes paragraph promised that copies copy mode made are replaced
with links without --force. Merge sync keeps a copy that no longer hashes to
the checksum copy mode recorded, so an edited copy, or one whose name: copy
mode rewrote for prefixed naming, still needs --force.

State the three cases in sync-modes and qualify the diff Modified and Local
override labels, in English and the ja, ko, zh-Hans and zh-Hant copies.

* fix(sync): keep the copy until its replacement link exists

Replacing a copy-mode copy removed the folder first and then created the
link. If creating the link failed (no symlink or junction rights on a
Windows or network filesystem), sync returned an error with the skill gone
from the target. This path now also runs on a plain sync, not only on
--force.

Park the folder beside the entry, create the link, then delete the parked
folder; on failure the folder is moved back. A parked folder left by a run
that died mid-way may be the only copy, so the next sync stops with a message
instead of deleting it. The manifest also forgets the copy-mode mtime and
naming records of an entry that is now a link.

* test(sourcefs): register replaceWithLink's target writes in the raw-write ratchet

The previous commit moved the merge-mode folder replacement into
replaceWithLink, which the ratchet reports as new raw os calls and the old
os.RemoveAll allowance as stale. All of them act on the sync target, not the
skills source, like the neighbouring entries.

* fix(sync): bound the parked copy's name and document the naming exception

The folder parked while a link is created was named after the entry, so an
entry near the 255-byte filename limit (a long flattened nested skill)
could not be moved aside and its replacement failed. The parked name is now
a fixed-length hash of the entry name.

sync-modes also says what happens when `target_naming` changes in the same
sync: the copy gets a new entry name and the prune pass removes it as an
orphan whether or not it was edited, as it did before this change.
2026-10-10 00:13:29 +08:00

16 KiB
Raw Blame History

sidebar_position
sidebar_position
3

Sync Modes

How skillshare links source to targets.

:::tip When does this matter? Choose merge mode (default) when you want per-skill symlinks and to preserve local skills in targets. Choose copy mode when you need real files instead of symlinks (portability, CI, or personal preference). Choose symlink mode when you want the entire directory linked and don't need local target skills. :::

Overview

Mode Behavior Use Case
merge Each skill symlinked individually Default. Preserves local skills.
copy Each skill copied as real files Portability, CI/sandboxed environments, or when you prefer real files over symlinks.
symlink Entire directory is one symlink Exact copies everywhere.

Decision Matrix (Neutral)

Use this table to pick based on your constraints, not target brand names:

Decision axis merge copy symlink
Compatibility across different AI CLIs Medium High Low–Medium
Edit-once immediate reflection High Low (requires sync) High
Disk usage Low High Low
Safety against accidental delete-from-target High High Low
Operational simplicity Medium Medium High
Per-target filtering (include/exclude) Yes Yes No

If you are unsure, start with merge and switch specific targets to copy as needed.


Merge Mode (Default)

Each skill is symlinked individually. Local skills in the target are preserved.

Source                          Target (claude)
─────────────────────────────────────────────────────────────
skills/                         ~/.claude/skills/
├── my-skill/        ────────►  ├── my-skill/ → (symlink)
├── another/         ────────►  ├── another/  → (symlink)
└── ...                         ├── local-only/  (preserved)
                                └── .skillshare-manifest.json

Advantages:

  • Keep target-specific skills (not synced)
  • Mix installed and local skills
  • Granular control
  • Per-target include/exclude filtering
  • Manifest-based orphan cleanup (safely removes non-symlink residue after uninstall)

:::info Relative symlinks in project mode In project mode (-p), symlinks are created as relative paths (e.g., ../../.skillshare/skills/my-skill) instead of absolute paths. This makes the project portable — move or rename the directory and symlinks continue to work. In global mode, absolute paths are used since source and targets are in different locations. :::

When to use:

  • You want some skills only in specific AI CLIs
  • You want to try local skills before syncing
  • You want one source but different skill subsets per target

Filter strategy in merge mode

include and exclude are evaluated per target in this order:

  1. include keeps matching names
  2. exclude removes from that kept set

Quick choices:

  • Use include when the target should get only a small subset
  • Use exclude when the target should get almost everything
  • Use include + exclude when you need a broad subset with explicit carve-outs

Behavior when rules change:

  • Previously synced source-linked entries that become filtered out are removed on next sync
  • Existing local non-symlink folders in target are preserved

See Target Configuration for full examples.


Copy Mode

Each skill is copied as real files to the target directory. A .skillshare-manifest.json file tracks which skills are managed and their checksums, so local skills are preserved.

Source                          Target (cursor)
─────────────────────────────────────────────────────────────
skills/                         ~/.cursor/skills/
├── my-skill/        ────copy►  ├── my-skill/    (real files)
├── another/         ────copy►  ├── another/     (real files)
└── ...                         ├── local-only/  (preserved)
                                └── .skillshare-manifest.json

Why copy mode?

Even when your AI CLI handles symlinks correctly, copy mode provides value:

  • Defensive design — not every AI CLI guarantees symlink support, especially on Windows where symlink behavior varies by platform and permission level
  • Sandboxed environments — strict CI pipelines, containers, and air-gapped setups may not follow symlinks across filesystem boundaries
  • User preference — some users and teams simply prefer real files over symlinks for transparency and portability

Advantages:

  • Works everywhere — no symlink support required from the AI CLI or OS
  • Preserves local skills (same as merge mode)
  • Per-target include/exclude filtering
  • Checksum-based skip: unchanged skills are not re-copied

When to use:

  • Your AI CLI reports "skill not found" or cannot read symlinked skills
  • You want to vendor skills into a project repo — copy mode in project mode lets the team commit real skill files to git, so teammates don't need skillshare installed
  • You need self-contained skill directories that work without a central source (portable setups, CI pipelines, air-gapped environments)
  • You want the same filtering behavior as merge mode but with real files
  • Common first candidates for copy: cursor, antigravity, copilot, opencode

How updates work

On each skillshare sync, the checksum of each source skill is compared to the value stored in the manifest:

  • Same checksum → skill is skipped (fast)
  • Different checksum → skill is overwritten with the new version
  • --force → all managed skills are overwritten regardless of checksum

Manifest lifecycle

Both merge and copy modes write .skillshare-manifest.json to track managed skills:

  • Merge mode: records skill names with value "symlink" — used to safely prune orphan real directories (e.g., copy-mode residue) after uninstall
  • Copy mode: records skill names with SHA-256 checksums — used for incremental sync and orphan detection
  • Removed automatically when switching to symlink mode
  • If manually deleted, the next sync rebuilds it

The entire target directory is a single symlink to source.

Source                          Target (claude)
─────────────────────────────────────────────────────────────
skills/              ────────►  ~/.claude/skills → (symlink to source)
├── my-skill/
├── another/
└── ...

Advantages:

  • All targets are identical
  • Simpler to manage
  • No orphaned symlinks

When to use:

  • You want all AI CLIs to have exactly the same skills
  • You don't need target-specific skills

Warning: In symlink mode, deleting through target deletes source!

rm -rf ~/.claude/skills/my-skill  # ❌ Deletes from SOURCE
skillshare target remove claude   # ✅ Safe way to unlink

Changing Mode

Per-target

# Switch to copy mode (for AI CLIs that can't read symlinks)
skillshare target cursor --mode copy
skillshare sync

# Switch to symlink mode
skillshare target claude --mode symlink
skillshare sync

# Switch back to merge mode
skillshare target claude --mode merge
skillshare sync

Unedited copies that copy mode made are replaced with links on that sync, without --force. Everything else is kept until you run sync --force: a folder you made yourself (the manifest does not record it) and a copy you edited after copy mode made it. A copy whose name: copy mode rewrote for prefixed naming also counts as edited. If the same sync also changes target_naming, a copy gets a new entry name and is removed as an orphan, edited or not; the backup of a plain sync holds it.

You do not need one global mode for every target. A common pattern is:

mode: merge
targets:
  claude:
    path: ~/.claude/skills
    # inherits merge
  cursor:
    path: ~/.cursor/skills
    mode: copy
  codex:
    path: ~/.codex/skills
    mode: symlink

Use per-target overrides when one target needs compatibility-first behavior (copy) while others keep instant reflection (merge/symlink).

Default mode

Set in config for new targets:

# ~/.config/skillshare/config.yaml
mode: merge  # or symlink or copy

targets:
  claude:
    path: ~/.claude/skills
    # inherits default mode

  cursor:
    path: ~/.cursor/skills
    mode: copy  # real files for Cursor

  codex:
    path: ~/.codex/skills
    mode: symlink  # override default

Target Naming

Controls how skill directories are named in targets when using merge or copy mode.

Naming Behavior
flat (default) Nested skills flattened with __ separators: frontend/dev → frontend__dev
standard Uses the SKILL.md name field: frontend/dev → dev
prefixed Copy mode only. standard, plus the tracked repo name in front: _mattpocock-skills/skills/prototype → mattpocock-skills-prototype

Set globally or per-target:

target_naming: standard    # global default
targets:
  claude:
    skills:
      target_naming: flat  # per-target override

Or via CLI:

skillshare target claude --target-naming standard
skillshare sync

Standard mode follows the Agent Skills specification, which requires the SKILL.md name field to match the parent directory name. A valid name has at most 64 lowercase letters (in any script), digits and single hyphens, and does not start or end with -; underscores are not allowed. Skills with invalid names or name collisions are warned and skipped.

Prefixed mode is for tracked repos that ship skills with the same name. Under standard two prototype skills from different repos collide and both are skipped; under prefixed each skill inside a tracked repo becomes <repo>-<name>, so both reach the tool. <repo> is the tracked repo folder without its leading _, lowercased, with every character other than a letter or digit (in any script) turned into -. The prefixed name is used for the folder and written to name: in the copied SKILL.md; the source is never changed.

  • A name that already starts with the repo name is not prefixed again: _bmad/skills/bmad-ux stays bmad-ux.
  • Skills outside tracked repos keep their name.
  • The source skill must pass the standard checks first. A prefixed name longer than 64 characters is skipped with a warning, and names that still collide are skipped as in standard. A tracked skill cannot be renamed in SKILL.md, so sync then suggests renaming the other skill or re-tracking the repo with --name.
  • For a shorter prefix, track the repo under a short name: skillshare install <repo> --track --name mp gives mp-prototype.
  • Relative links to sibling skills (../other-skill/) are not rewritten, the same as flat in copy mode.
  • The name becomes what the tool shows; in Claude Code it is the slash command, e.g. /mattpocock-skills-prototype.

prefixed needs copy mode because merge links point at the source, where name: cannot change. A target that resolves to prefixed in merge or symlink mode fails validation and is skipped by sync. When a new target would inherit prefixed in a mode other than copy (a project target defaults to merge), target add gives it copy mode. target add says so when it does, and status and doctor flag a target that resolves to prefixed without copy mode before you sync, and so does target list for the targets in targets:; the fix is mode: copy on the target, or projects.<root>.skills.mode: copy for a target a projects: entry expands into.

targets:
  universal:
    skills:
      mode: copy
      target_naming: prefixed

Migration: Switching between flat, standard and prefixed renames existing managed entries in place. In copy mode the manifest records which naming made each copy, so a renamed copy is copied again and its name: matches the new naming, even when the source did not change. If a local skill already occupies the new name, the old managed entry is preserved.

Symlink mode: flat and standard are ignored — the entire directory is linked as-is. prefixed fails validation, as above.


Mode Comparison

Aspect Merge Copy Symlink
Local skills preserved ✅ Yes ✅ Yes ❌ No
Symlink-compatible ✅ Yes ❌ Real files ✅ Yes
All targets identical ❌ Can differ ❌ Can differ ✅ Yes
Per-target include/exclude ✅ Yes ✅ Yes ❌ Ignored
Orphan cleanup needed ✅ Yes ✅ Yes ❌ No
Delete safety ✅ Safe ✅ Safe ⚠️ Caution
Disk usage Low (symlinks) Higher (copies) Low (symlinks)

Orphan Cleanup

In both merge and copy modes, sync automatically prunes orphans:

  • Symlinks pointing to deleted source skills are always removed
  • Real directories are removed if they appear in .skillshare-manifest.json (previously managed by skillshare)
  • Unknown directories not in the manifest are preserved with a warning (assumed to be user-created)

This means that after uninstall + sync, even non-symlink residue (e.g., directories left from a previous copy mode) is safely cleaned up.

$ skillshare sync
✓ claude    5 linked · 2 local · 1 pruned
✓ cursor    3 copied · 2 up to date · 1 pruned

:::info Agents follow the same modes All three modes (merge, copy, symlink) apply to agent sync as well. Agent orphan cleanup, per-target include/exclude filtering, and mode conversion behave identically to skills — the only difference is that agents are single .md files instead of directories. Agent-capable targets (Claude, Cursor, Augment, OpenCode) honor the same mode setting on their agents: sub-key. See Agents for details. :::


Extras Sync Modes

Extras (non-skill resources like rules, commands, prompts) also use merge and copy modes. Each extras target can specify its own mode:

extras:
  - name: rules
    targets:
      - path: ~/.claude/rules          # merge (default): per-file symlinks
      - path: ~/.cursor/rules
        mode: copy                     # copy: real file copies

The behavior is the same as skill sync modes — merge creates per-file symlinks, copy creates real file copies.

:::note Windows without Developer Mode Merge mode links single files, which Windows allows only with Developer Mode. Without it, agents and extras in merge mode are copied instead, and those copies are updated and pruned like links. Skills are folders, so they are linked (with junctions) either way. See Windows troubleshooting.

Identical local files that skillshare does not own are preserved. In copy fallback, agent counts show them separately as local preserved, for example 0/1 linked, 1 local preserved. :::


See Also