vault-setup

v2026.09.24

Interactive Obsidian vault configurator. USE WHEN setting up obsidian vault, creating second brain, initializing knowledge base, new vault, vault bootstrap, configure obsidian, obsidian setup, OR personal knowledge management setup.

GitHub
安装命令
npx skhub add julianobarbosa/vault-setup
Markdown
SKILL.md

vault-setup-skill

Interactive vault configurator — asks one free-text question, infers your role and folders, builds a personalized Obsidian vault with CLAUDE.md and companion skill links.

Directory Structure

vault-setup-skill/
├── SKILL.md                          # This file (routing + quick ref)
├── RoleTemplates.md                  # Keyword-to-folder mapping table
├── PluginRecommendations.md          # Obsidian plugins by role type
├── Workflows/
│   ├── Setup.md                      # Main 6-step setup flow
│   ├── ImportFiles.md                # File import guidance
│   └── Verify.md                     # Post-setup verification
├── Tools/
│   ├── VaultBuilder.py               # CLI: create, verify, inject-global
│   └── VaultBuilder.help.md          # Tool documentation
└── scripts/
    └── process_docs_to_obsidian.py   # Bulk file import to inbox/

Workflow Routing

IntentWorkflowTool
Set up a new vaultWorkflows/Setup.mdTools/VaultBuilder.py create
Import existing filesWorkflows/ImportFiles.mdscripts/process_docs_to_obsidian.py
Verify vault setupWorkflows/Verify.mdTools/VaultBuilder.py verify
Add vault to global contextWorkflows/Setup.md Step 5Tools/VaultBuilder.py inject-global
Choose Obsidian pluginsPluginRecommendations.md—
Understand folder mappingRoleTemplates.md—

Examples

"Set up my Obsidian vault"              → Workflows/Setup.md
"I want to create a second brain"       → Workflows/Setup.md
"Import my documents into the vault"    → Workflows/ImportFiles.md
"Verify my vault is set up correctly"   → Workflows/Verify.md
"What plugins should I install?"        → PluginRecommendations.md
"Add this vault to my global config"    → Workflows/Setup.md Step 5

Quick Reference

Base folders (always created): inbox/, daily/, projects/, archive/

Additional folders detected from keywords — see RoleTemplates.md for full mapping.

Companion skills (linked, not created): daily-skill, tldr-skill, obsidian-master-skill

Troubleshooting

ProblemCauseFix
click not found when running VaultBuilder.pyMissing dependencypip install click
Vault folders created but Obsidian doesn't see themObsidian not pointed at vault rootOpen Obsidian → "Open folder as vault" → select the vault directory
inject-global says "Already configured" but Claude doesn't see contextVault path in CLAUDE.md doesn't match exactlyCheck ~/.claude/CLAUDE.md for the vault path — it must be the resolved absolute path
Symlink shows [BROKEN] in verifyTarget skill directory was moved or deletedRe-create the symlink: ln -sf /path/to/skill ~/.claude/skills/skill-name
process_docs_to_obsidian.py shows encoding warningsSource files contain non-UTF-8 charactersReview warned files manually; convert source encoding with iconv if needed

Edge Cases

  • Empty keywords: If --role-keywords is empty, only base folders are created (inbox, daily, projects, archive)
  • Vault path doesn't exist: VaultBuilder creates it automatically via mkdir -p
  • Running create twice: Safe — folders use exist_ok=True, CLAUDE.md is overwritten (back up first if customized)

Gotchas

  • inject-global mutates ~/.claude/CLAUDE.md with absolute path: If you later move the vault, the global config still points to the old path and Claude silently loads nothing. Re-run inject-global after any vault relocation.
  • Re-running create overwrites a customized CLAUDE.md: Folder creation uses exist_ok=True (safe) but CLAUDE.md is unconditionally rewritten. Back up first if you've hand-edited vault-level instructions.
  • process_docs_to_obsidian.py silently skips non-UTF-8 files: Latin-1 or Windows-1252 source files emit a warning and are not imported. The summary report doesn't flag them as failures — grep stderr for "encoding" before trusting the count.
  • Symlinks to companion skills break on PAI directory restructure: Verify shows [BROKEN] only if the symlink target is missing entirely; a renamed-but-existing target appears valid yet routes to the wrong skill. Re-run verify after any PAI skill reorganization.
  • Empty --role-keywords is not an error: The vault gets only base folders (inbox/daily/projects/archive) with no warning. If you expected role-specific folders, check the inferred keywords in the setup transcript.
  • Obsidian doesn't see the vault until "Open folder as vault": Creating the directory tree is not enough — Obsidian must be pointed at the vault root explicitly. New users often think the script failed because Obsidian shows an empty workspace.
发现
标签

此技能尚未发布标签。

版本
最新版本元数据

版本

v2026.09.24

发布时间

2026年9月24日

分类

未分类

许可证

MIT

源路径

skills/vault-setup

默认分支

main

最新提交

515755d

Tree SHA

fca30ca