brain-setup
Creates your Obsidian vault from the developer-os template, or connects an existing vault by adding only what is missing, then points Claude Code at it once you approve the diff.
- Group
- Memory
- Kind
- Action
- Writes
- New vault files;
.gitignorelines (git vaults only); theBrain vault:line in~/.claude/CLAUDE.md;permissions.additionalDirectoriesin~/.claude/settings.json - Asks before
- Connecting a non-empty folder; both config edits, shown as a diff; the
types.jsonmerge
When it runs
When you set up developer-os, when no Brain vault: line exists yet, or when you ask for it:
- set up the vault
- create a vault
- connect my vault
- setup brain
What it does
- Asks for the path and picks the mode. It asks for the vault's absolute path. If your config already has a
Brain vault:line with another path, it shows it and asks which to keep. A missing or empty folder means a new vault; a non-empty one means it asks whether to connect it, and stops if you say no. - New vault. It copies the plugin's vault template into the path: topic folders, inbox, archive, views, the note template and example notes.
- Connect an existing vault. It adds only what is missing and never overwrites, moves or deletes a file: the folders
DEV,INFRA,PROJECTS,QA,TOOLS,_archive,_inbox,_viewsandtemplates, the missing.baseviews andtemplates/note.md..gitignorelines are added only to a vault that is a git repository or already has a.gitignore. Example notes are not copied. In.obsidian/types.jsonit adds only absent keys, after showing the change and asking you to close Obsidian; withoutjqit tells you to set the property types in Obsidian instead. - Points Claude Code at the vault. It shows a diff of two edits in your Claude config directory (
$CLAUDE_CONFIG_DIR, default~/.claude): aBrain vault: <path>line inCLAUDE.mdand the path inpermissions.additionalDirectoriesinsettings.json. It applies them in place only after you approve; ifjqis missing orsettings.jsonis not valid JSON, it changes nothing and shows you the key to add by hand. For Codex it prints the line for~/.codex/AGENTS.mdfor you to add. - Runs a smoke test. It runs brain-search on the new path: in a new vault a search for "webhooks" must find the example note
_inbox/process-webhooks-once-per-event-id.md; in a connected vault it searches for the topic of one existing note. Then it tells you to enable the Bases and Templates core plugins in Obsidian, withtemplatesas the Templates folder.
Boundaries
Stops when
The smoke test is done. The report gives the mode, the vault path, what was created or appended, which config edits were applied or declined, an old vault path still in permissions.additionalDirectories if the path changed (you remove it by hand), the Codex line if printed, and the smoke-test result.
Never
- Copy into a non-empty folder in new-vault mode, or overwrite any existing file in the vault (
.obsidian/, notes,.gitignore,.baseviews). - Edit
CLAUDE.mdorsettings.jsonbefore you approve the diff, rewritesettings.jsonby hand, or replace either file withmv. - Edit
~/.codex/AGENTS.md. - Search the disk for vaults or read notes beyond the smoke test.
Related
- Setup in 5 minutes.
- The vault layout the template creates.
- brain-search and brain-capture use the vault once it is connected.