richfrem/agent-plugins-skills / plugins/agent-memory/.apm/skills/managing-obsidian-vaults
managing-obsidian-vaults
VerifiedInteractive vault, wiki and Super-RAG setup in the main conversation. Use for "set up my wiki", "initialize the full knowledge stack" or combined RLM/vector/wiki setup. Manage Obsidian vaults and LLM wikis: initialize vaults, author Markdown and wikilinks, safely edit notes and Bases, create Canvas diagrams, traverse graphs, build concept wikis, distill summary/bullets/deep layers, query and lint knowledge.
references/obsidian-vault-onboarding-guide.md
View on GitHub# Obsidian Vault Onboarding & Initialization Guide
## Contents
- [Prerequisites Installation](#prerequisites-installation)
- [Vault Initialization](#vault-initialization)
- [Exclusion Configuration](#exclusion-configuration)
- [Post-Init Verification](#post-init-verification)
- [Wiki Engine Guided Discovery](#wiki-engine-guided-discovery)
- [Portability & Quick Reference](#portability--quick-reference)
---
## Prerequisites Installation
### 1. Obsidian Desktop Application (Required)
The Obsidian desktop app must be installed on the host machine as the visual interface for browsing, editing, and viewing the Graph and Canvas.
- **macOS (Homebrew):**
```bash
brew install --cask obsidian
```
- **Manual Download:** https://obsidian.md/download
- **Verify:**
```bash
ls /Applications/Obsidian.app
```
### 2. Obsidian CLI v1.12+ (Recommended)
Communicates with running Obsidian instance via IPC lock for programmatic vault operations.
- **npm (global install):**
```bash
npm install -g obsidian-cli
```
- **Verify:**
```bash
obsidian --version
```
### 3. ruamel.yaml
Required for lossless YAML frontmatter parsing and preservation:
```bash
pip install ruamel.yaml
```
### 4. Optional Community Plugins
- **Dataview:** Structured database-style queries over frontmatter metadata.
- **Canvas:** Built-in visual boards adhering to JSON Canvas Spec 1.0.
- **Bases:** Table, grid, and card views from YAML properties.
---
## Vault Initialization
### Command Execution
```bash
# Interactive initialization
python ./init_vault.py --vault-root <path>
# With custom exclusions
python ./init_vault.py --vault-root <path> --exclude "custom_dir/" "*.tmp"
# Dry run validation only
python ./init_vault.py --vault-root <path> --validate-only
```
### Initialization Actions
1. **Validates** directory exists and contains markdown files.
2. **Creates** `.obsidian/` configuration directory.
3. **Writes** `app.json` with sensible developer defaults.
4. **Updates** `.gitignore` to exclude `.obsidian/`.
5. **Reports** next steps for opening vault in Obsidian desktop.
---
## Exclusion Configuration
### Default Exclusions
| Pattern | Reason |
|:--------|:-------|
| `node_modules/` | NPM dependencies |
| `.worktrees/` | Git worktree isolation |
| `.vector_data/` | ChromaDB binary storage |
| `.git/` | Git internal metadata |
| `venv/`, `.venv/` | Python virtual environments |
| `__pycache__/` | Python bytecode cache |
| `*.json`, `*.jsonl` | Data payloads and export bundles |
| `*_packet.md`, `*_digest.md` | Machine-generated context bundles |
*Rationale:* Machine-generated files create thousands of false backlinks and pollute graph connectivity.
---
## Post-Init Verification
1. Open Obsidian -> "Open Folder as Vault" -> select vault root.
2. Verify indexing: Confirm structural folders appear in sidebar.
3. Test wikilinks: Click `[[wikilink]]` references to confirm bidirectional resolution.
4. Set environment variable: `export VAULT_PATH=/path/to/vault`.
---
## Wiki Engine Guided Discovery
After vault initialization, configure the LLM Wiki Engine source manifest (`rlm_wiki_raw_sources_manifest.json`):
### Running Discovery
```bash
python ./scripts/raw_manifest.py --init --wiki-root /path/to/wiki-root
```
### Manifest Schema
```json
{
"description": "Source raw content for Obsidian Wiki",
"include": [
"plugins/",
"docs/"
],
"exclude": [
".git/",
"node_modules/",
".venv/",
"__pycache__/"
],
"recursive": true
}
```
---
## Portability & Quick Reference
```bash
# 1. Install prerequisites
brew install --cask obsidian
npm install -g obsidian-cli
pip install ruamel.yaml
# 2. Initialize vault
python ./init_vault.py --vault-root /path/to/your/project
# 3. Export environment
export VAULT_PATH=/path/to/your/project
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |