| name | setup-vault-tools |
| description | Configure vault-tools for first-time use or change the vault path. Covers both note management and plan archival. Triggers: "setup vault-tools", "configure vault-tools", "set vault path", "install vault-tools", "get started with vault-tools", "setup plan archival", or when vault path is not configured. |
Vault Tools Setup
Guide the user through configuring the vault-tools plugin. This covers both vault management (notes, search, maintenance) and automatic plan archival on ExitPlanMode.
Workflow
-
Check current state: Read $CLAUDE_PLUGIN_OPTION_VAULT_PATH. If already set, tell the user and ask if they want to change it.
-
Auto-detect vaults: Search common locations:
find ~/Vaults ~/Documents ~/OneDrive -maxdepth 2 -name ".obsidian" -type d 2>/dev/null | sed 's|/.obsidian$||'
Present found vaults as options.
-
Ask the user which vault to use, or let them provide a custom path. Verify the path exists and has a Notes/ directory with type subfolders.
-
Apply: Tell the user to run:
Go to /plugin → select vault-tools → Configure options → set vault_path to: <chosen path>
Note: Plugin options cannot be set programmatically — the user must configure via the plugin menu.
-
Verify: After user confirms, check $CLAUDE_PLUGIN_OPTION_VAULT_PATH. A /reload-plugins may be needed.
-
Confirm rules bootstrapping: Check .claude/rules/ in vault for expected rule files.
-
Plan archival setup: Verify Notes/plan/ exists in the vault (the archival hook creates it if missing, but confirm now so the user knows where plans will land). If the vault has a CLAUDE.md defining valid note types, check that plan is in the list — warn the user to add it if missing, otherwise the frontmatter validator will flag every archived plan.
-
Offer bulk import: Ask whether the user wants to import any existing plans from ~/.claude/plans/ into the vault via /vault-tools:import-plans. Skip if ~/.claude/plans/ is empty.
-
Remind: This plugin replaces .claude/skills/, .claude/hooks/, .claude/rules/ in the vault — they're provided by the plugin on every machine. The ExitPlanMode hook archives new plans automatically once vault_path is set.