agentleFS
graphlitgraphlit/vault-sync/skill.md

vault-sync

Skill2 starsChanged 7 months agoMITView on GitHub

Use when a user wants an AI agent to install Vault Sync, mirror an existing Vault Git repository to local files, keep it refreshed, or consume an already-synced Vault with normal filesystem tools.

5 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions5 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 5

    1. bybren-llc/safe-agentic-workflow★ 405same name
    2. Kanevry/session-orchestrator★ 53same name
    3. hootbu/llm-wiki-mind★ 1same name
    4. Mahermenix/vault-sync★ 1same name
    5. tejask0/agent-skills★ 0same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 4 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 4 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Check for bash and git. rg is optional but useful after sync.

    line 13
  2. Very specific:

    Ask for the Vault Git repository URL and local folder if the user did not provide them.

    line 22
  3. Very specific:

    Do not infer the local Vault path from the current working directory, app name, or repository owner.

    line 23
  4. Distinctive:

    If the user wants recurring refreshes, install a pull schedule:

    line 32
  5. Very specific:

    Use ordinary filesystem tools: ls, rg, sed, cat, and native file reads.

    line 48
  6. Distinctive:

    Treat the Vault as read-only unless the user explicitly asks to edit local files.

    line 49
  7. Distinctive:

    If QMD is installed and the user wants a stronger local search helper, add the synced Vault folder as a QMD collection:

    line 53
  8. Distinctive:

    Use QMD to find likely files.

    line 61

“Common” is measured: kept by at least 6 in 10 of the 4 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
skill.md

Vault Sync

Vault Sync mirrors an existing Vault Git repository onto the user's local filesystem. Use it only for file sync and local readiness. Do not use it for search, query, chat, indexing, Vault creation, or Vault management.

When Setting Up

  1. Confirm the environment is macOS, Linux, or WSL2. Native Windows PowerShell and Command Prompt are out of scope.
  2. Check for bash and git. rg is optional but useful after sync.
  3. Install vault-sync if it is not already on PATH:
mkdir -p ~/.local/bin
curl -fsSL https://raw.githubusercontent.com/graphlit/vault-sync/main/bin/vault-sync -o ~/.local/bin/vault-sync
chmod +x ~/.local/bin/vault-sync
  1. Ask for the Vault Git repository URL and local folder if the user did not provide them. Use ~/vaults/<repo-name> as the default.
  2. Do not infer the local Vault path from the current working directory, app name, or repository owner. Do not invent hidden app folders such as ~/.zine/vault, ~/.dossium/vault, or ~/.graphlit/vault.
  3. Run:
vault-sync init <vault-repo-url> <path>
vault-sync pull <path>
vault-sync doctor <path>
  1. If the user wants recurring refreshes, install a pull schedule:
vault-sync schedule install <path> --every 5m

When Using A Synced Vault

  1. Refresh first when practical:
vault-sync pull <path>
  1. Read <path>/README.md first.
  2. Ignore hidden control folders such as .git, .zine, .dossium, .graphlit, .claude, and .codex.
  3. Use ordinary filesystem tools: ls, rg, sed, cat, and native file reads.
  4. Treat the Vault as read-only unless the user explicitly asks to edit local files.

Optional QMD Search Companion

If QMD is installed and the user wants a stronger local search helper, add the synced Vault folder as a QMD collection:

qmd collection add <path> --name <name> --mask "**/*.md"
qmd context add qmd://<name> "Local Vault synced by Vault Sync"
qmd embed

Use QMD to find likely files; use file reads for the full source.

Vault Sync is the mirror. The agent is the reader.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.