synapse-vault

synapse-vault

The public, generic protocol-layer template for Synapse — a personal management system where an AI CLI agent operates on an Obsidian-style vault of notes, tasks, links, and reminders, driven by Synapse Engine.

Synapse Vault

The public, generic protocol-layer template for Synapse — a personal management system where an AI CLI agent (Claude Code, Antigravity CLI, or Gemini CLI) operates on an Obsidian-style vault of notes, tasks, links, and reminders, driven by Synapse Engine.

This repo ships operating manuals and module protocols only — no personal data. Clone it to start your own private vault.

Learn more: synapse — a plain-language overview of what this system actually does.

Vault Profile Pic

What this is

synapse-vault is a starter template, not a live vault. It contains:

  • CLAUDE.md / GEMINI.md — the operating manual read automatically by each AI CLI: how to classify requests, route them to the right module, format output, and handle errors.
  • One PROTOCOL.md per module (tasks/, links/, reminders/, calendar/, stocks/, groceries/, email/, projects/) — the specific rules for that domain.
  • Empty starter data files (tasks/master_todos.md, reminders/reminders.json, etc.) so the vault works immediately after cloning.
  • .claude/agents/stock-researcher.md — a sub-agent definition used by the stocks module.

The PERSONAL.md pattern

CLAUDE.md and GEMINI.md are both fully generic — neither contains your name, family, or location. Instead, both import a single file via @PERSONAL.md (a syntax Claude Code and Gemini CLI both support). One source of personal context feeds both providers, instead of duplicating it into two files that could drift apart.

Run ./setup.sh after cloning to fill in your own PERSONAL.md interactively, or edit the file directly by hand.

Using this vault

The main way: pair it with Synapse Engine — it runs the AI CLI against this vault non-interactively, wired to Email, Telegram, and scheduled reminders, so the assistant is reachable from wherever you are. Point its VAULT_PATH at your clone.

Local options, if you want them: cd into this vault and run claude (or gemini) directly for an interactive session — both auto-discover CLAUDE.md/GEMINI.md in the current directory, no other setup required. Or just open it in Obsidian to browse and edit your notes like any other vault, with graph view and backlinks, independent of any AI tooling.

Getting started with your own private vault

This repo is a public template — don't use it as your live vault directly. Instead:

  1. Clone it:
    git clone git@github.com:kristianolsson/synapse-vault.git my-vault
    cd my-vault
    
  2. Run ./setup.sh to fill in your PERSONAL.md with your name, location, and any other context. It's a normal tracked file, just like everything else in this vault — no special git handling needed.
  3. Detach it from this repo and point it at your own private repo:
    rm -rf .git
    git init
    git add .
    git commit -m "Initial vault from synapse-vault template"
    git remote add origin <your-private-repo-url>
    git branch -M main
    git push -u origin main
    
  4. Replace the placeholder E*TRADE account in stocks/options_config.yaml (accounts.default: "1234") with your real account suffix before using the stocks/options tooling — see stocks/PROTOCOL.md for how it's used.
  5. Point Synapse Engine's VAULT_PATH at your new vault directory.

Structure

  • daily/: Daily log files (YYYY-MM-DD.md) — created automatically on first use, not seeded here.
  • tasks/: Task management module with master_todos.md and task SOPs.
  • links/: Link repository module with links.md and link SOPs.
  • reminders/: Reminder module with reminders.json and reminder SOPs.
  • calendar/: Calendar module with calendar SOPs (data via the calendar CLI tool).
  • stocks/: Stock market module with market/options watchlists and stock SOPs (data via the etrade and options-bot CLI tools).
    • stocks/options_config.yaml ships with a placeholder E*TRADE account number (1234) — replace accounts.default with your real account suffix before using the options/stocks tooling.
  • groceries/: Grocery module with grocery_history.json and grocery SOPs (data via the amazon-fresh CLI tool).
  • email/: Email module with email SOPs (via the gmail CLI tool).
  • projects/: Project notes structure — PROTOCOL.md and templates/project_template.md. Category subfolders (coding, family, finance, home, etc.) are created on demand.
  • .claude/agents/: Sub-agent definitions available to Claude Code.
  • CLAUDE.md / GEMINI.md: Operating manuals — see "The PERSONAL.md pattern" above for why personal context is split out.

How to Install

  1. Download the ZIP or clone the repository
  2. Open the folder as a vault in Obsidian (File → Open Vault)
  3. Obsidian will prompt you to install required plugins

Stats

Stars

0

Forks

0

Last updated 1mo ago