Files
My-Brain-Is-Full-Crew/docs/vault-mapping.md
Shachar Borenstein 340be6e497 feat: vault path tokenization — make the Crew work with any vault structure (#22)
All 8 agents and 14 skills now use vault-role tokens ({{inbox}}, {{projects}},
{{areas}}, etc.) instead of hardcoded folder paths. Each file reads
Meta/vault-map.md at runtime to resolve tokens to the user's actual folder
names. Full backward compatibility: if vault-map.md is absent, agents fall
back to built-in defaults.

- Add Vault Path Resolution preamble to all 22 agent/skill files
- Replace ~365 hardcoded folder paths with 11 vault-role tokens
- Add docs/vault-mapping.md explaining the system and customization
- Add Vault Path Resolution section to all dispatcher files
- Add vault-token contributor rules to CONTRIBUTING.md
- Update README.md with vault-mapping references
- Add dispatcher backup logic to scripts/lib.sh

Based on the approach by @sborenst, re-implemented on the current codebase.

Co-authored-by: gnekt <dima9610@gmail.com>
Co-authored-by: Shachar Borenstein <sborenst@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-05-10 13:04:11 +02:00

56 lines
1.8 KiB
Markdown

# Vault Mapping
The Crew adapts to your existing folder structure — you don't have to rename anything.
## How it works
During onboarding, the Architect scans your vault and asks about any ambiguous folders. It then creates `Meta/vault-map.md`, which maps logical roles to your actual folder names:
```yaml
---
inbox: 00-Inbox
projects: 01-Projects
areas: 02-Areas
resources: 03-Resources
archive: 04-Archive
people: 05-People
meetings: 06-Meetings
daily: 07-Daily
templates: Templates
meta: Meta
moc: MOC
---
```
Every agent and skill reads this file at runtime from the fixed path `Meta/vault-map.md` and resolves vault-role tokens to your actual paths before acting. Only the 11 tokens listed below are substituted — other `{{...}}` patterns (like `{{date}}`, `{{Name}}`) are template placeholders and are left unchanged.
## Customizing
Edit `Meta/vault-map.md` directly. For example, if your inbox is called `Inbox/`:
```yaml
inbox: Inbox
```
Changes take effect immediately — no restart needed.
## Available tokens
| Token | Default | Purpose |
|-------|---------|---------|
| `{{inbox}}` | `00-Inbox` | New notes land here first |
| `{{projects}}` | `01-Projects` | Active projects |
| `{{areas}}` | `02-Areas` | Life areas (Work, Health, etc.) |
| `{{resources}}` | `03-Resources` | Reference material |
| `{{archive}}` | `04-Archive` | Completed or historical notes |
| `{{people}}` | `05-People` | Person notes |
| `{{meetings}}` | `06-Meetings` | Meeting notes |
| `{{daily}}` | `07-Daily` | Daily notes |
| `{{templates}}` | `Templates` | Note templates |
| `{{meta}}` | `Meta` | Crew config files |
| `{{moc}}` | `MOC` | Maps of Content |
## If vault-map.md is missing
Each agent falls back to the defaults above and warns you once. Existing users are unaffected — the Crew works exactly as before until you run onboarding.