csync
CLAUDE.md2 starsChanged 59 days agoMITView on GitHub
This repository is the skill — SKILL.md, references/, scripts/, templates/. It is public and MIT-licensed. The user's data lives in a separate private repo (the sync repo, ~/.csync on this machine). Never conflate the two: this one holds the mechanism, that one holds their global instructions, memory and workspaces. ~/.claude/skills/csync is a symlink to this directory, so an edit here changes the installed skill immediately, before any commit. - SKILL.md and references/ are loaded at session start. Editing them does…
In this repositoryOne other file it gives its agents.
- csyncSkill
The file
We split this CLAUDE.md into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 21
Do not "test" a script by running it plainly to see what happens.
- Very specific: line 98
If it is empty, ask which identity to use.
- Very specific: line 122
Keep them apart. Procedure does not go in README.md, and installation prose does not go in SKILL.md.
≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Working in the csync tool repo
This repository is the skill — SKILL.md, references/, scripts/,
templates/. It is public and MIT-licensed. The user's data lives in a separate
private repo (the sync repo, ~/.csync on this machine). Never conflate the
two: this one holds the mechanism, that one holds their global instructions,
memory and workspaces.
This clone is live
~/.claude/skills/csync is a symlink to this directory, so an edit here changes
the installed skill immediately, before any commit.
SKILL.mdandreferences/are loaded at session start. Editing them does not change the session already running. Say so rather than proceeding as if the new rule were in force.scripts/act on the user's real environment.install.shanduninstall.shtake--dry-run, and that is the only correct first invocation — of the two,install.shis the one that moves the user's actual~/.claude/CLAUDE.mdinto a git repo.- Do not "test" a script by running it plainly to see what happens.
This repository is public, and nothing personal belongs in it
Everything committed here ships to people who share nothing with the user but the tool. Keep all of this out:
- names — the user, their machines, their git identity, their private remote
- their projects, in any form — repo names, module names, a domain from their work, a real ticket or branch name
- paths under their home — including the directory names between
$HOMEand a project, which are their layout and not a convention — and theirworkspace_dirwhen it is not the default - assumptions from their setup — how many machines they run, what language they speak, which editor or toolchain they happen to use
- conventions inherited from their own global rules. This repo's conventions are the sections above and nothing else
Examples use placeholders: ~/dev/my-project, you/your-sync-repo, ~/.csync.
Check the staged diff before every commit
The rule above is not enough by itself. It was already in force when a real
project name reached SKILL.md as a worked example, and when the private repo's
name reached this file — both read as perfectly natural prose, which is exactly
why prose review misses them. Derive the pattern from the machine so that no real
name has to be written down here:
REPO="$(cd -P ~/.claude/csync-repo && pwd)"
# the directory names between $HOME and a project — derived, never written here
tree=$( { sed "s#^$HOME/##" ~/.claude/csync-projects 2>/dev/null; echo "${PWD#$HOME/}"; } |
sed 's#/[^/]*$##' | tr '/' '\n' | grep -v '^$' | sort -u )
talt=$(printf '%s\n' "$tree" | paste -sd'|' - )
pat=$( { echo "$HOME"; hostname -s
git config --global user.email; git config --local user.email
ls "$REPO/global/memory" | sed -E "s#^(($talt)-)+##" |
awk -F- '{print; if (NF>1) print $1}'
git -C "$REPO" remote get-url origin | sed 's#.*[/:]##; s#\.git$##'
ws=$(sed -n 's/^ *workspace_dir *= *//p' "$REPO/csync.conf")
[ "$ws" = .csync ] || echo "$ws"
} | grep -v '^$' | grep -vxE 'csync|csync-tool|csync-repo' | awk 'length >= 4' |
sed 's/[][^$.*\\/]/\\&/g' | sort -u | paste -sd'|' - )
# the tree itself — matched only where it reads as a path or a memory key, so an
# ordinary English word that happens to be a directory name does not swamp the run
tpat=$(printf '%s\n' "$tree" | awk 'length >= 3' | sed 's#.*#[/~-]&[/-]#' | paste -sd'|' - )
git diff --cached | grep -i -nE "$pat|$tpat"It only knows what it can derive: memory-directory keys, the directory names
between $HOME and a project, the sync remote, the hostname, the git identity,
$HOME, a non-default workspace_dir. A project the sync repo holds no memory
for is invisible to it, and so is anything the user mentioned only in
conversation. A clean run is one check passed, not clearance — read the diff
too.
⚠️ Nothing in this snippet may be a real name. It has to derive every one of
them, including the shape of the user's home directory tree — an earlier version
hardcoded that tree into its own sed, so the check that exists to keep personal
structure out of this repo was itself the thing leaking it. When the derivation
gets awkward, make it more awkward; do not paste in the value.
Commit identity
The author field is as public as the diff, and git resolves it per-clone: a fresh clone has no local setting and falls back to whatever global identity the machine happens to carry. That is how a work address once reached three commits here, and the staged-diff scan above cannot catch it — the scan reads the diff, not the commit header.
The identity this repo commits under is a deliberate choice, never the machine default. Before the first commit in a clone:
git config --local user.email # empty means the next commit uses the global identityIf it is empty, ask which identity to use. Do not infer one and do not fall
through to the global value — that address may be one the user does not want
attached to a public repository. Both user.name and user.email are set
locally, together.
Language
Documentation, comments and commit messages are English — this repo is distributed to people who do not share the user's language. The private data repo is Korean; do not carry that convention across.
Remote operations
The standing permission to commit and push without asking applies only to the user's private sync repo. Here, report the commit message before committing, and do not push, tag or publish a release unless asked.
Two documents, two audiences
| file | written for | contains |
README.md | a person installing or evaluating csync | what it does, how to set it up, what gets pushed, what to do when something looks wrong |
SKILL.md | Claude, at runtime | the rules a session may need without knowing it, and enough of each subcommand to name and suggest it; references/ holds what a session reads only once it is doing that thing |
Keep them apart. Procedure does not go in README.md, and installation prose
does not go in SKILL.md. The same split governs the sync repo's own two root
files — see its CLAUDE.md and README.md.
references/workspace.md is the source of truth for how a workspace is
organised. When a rule about plans/, notes/, docs/ or backlog.md changes, it
changes there — not in a second copy inside SKILL.md.
What may move to references/
SKILL.md loads whole, on every trigger, in sessions that will run list and
open and nothing else. A reference loads only when something sends a session to
it. So the axis is not length — it is how a session learns it needs the file:
- A verb the user typed —
setup,config,update,uninstall. The dispatch already routes there.SKILL.mdkeeps the command's name, what it will do to the user's files, and a pointer: enough to suggest the command, never enough to run it from memory - A value the procedure already reads —
openprobescsync_auto_titlebefore it needs any title rule, so the probe stays and the rules move - A symptom, with no verb — the workspace showing up untracked,
/csyncno longer being a command, a gap abin/wrapper would close. Nobody invokes anything; the session has to recognise it unprompted. ⚠️ These cannot move at any length. Filed where it is found only by someone already looking for it, a rule fires after the mistake instead of before it
A ⚠️ guard stays where the damage happens even when the section around it moves.
setup's privacy probes are in references/setup.md; "do not merely ask" is
not. Splitting a section is normal; splitting it at the guard is the point.
Judge a move by SKILL.md's own size afterwards. Total bytes across the repo
going up is expected — pointers cost something, and that is the trade.
No workspace here
Neither this repo nor the sync repo gets a workspace directory of its own; bare
/csync always means sync inside them. csync work memory attaches to this
repo's own project key, because this is where those sessions are opened.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

