Skip to content

richfrem/agent-plugins-skills / plugins/agent-memory/.apm/skills/managing-obsidian-vaults

managing-obsidian-vaults

Verified

Interactive 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.

FileKindSize
SKILL.mdskill md5.9 KB
assets/templates/config.yaml.templateother556 B
assets/templates/raw-sources.json.exampleother862 B
assets/templates/wiki-node.template.mdmarkdown410 B
evals/README.mdmarkdown569 B
evals/evals.jsonconfig23.4 KB
evals/legacy/obsidian-bases-manager/evals.jsonconfig692 B
evals/legacy/obsidian-bases-manager/results.tsvother301 B
evals/legacy/obsidian-canvas-architect/evals.jsonconfig731 B
evals/legacy/obsidian-canvas-architect/results.tsvother301 B
evals/legacy/obsidian-graph-traversal/evals.jsonconfig706 B
evals/legacy/obsidian-graph-traversal/results.tsvother301 B
evals/legacy/obsidian-init/evals.jsonconfig667 B
evals/legacy/obsidian-init/results.tsvother301 B
evals/legacy/obsidian-markdown-mastery/evals.jsonconfig652 B
evals/legacy/obsidian-markdown-mastery/results.tsvother301 B
evals/legacy/obsidian-query-agent/evals.jsonconfig767 B
evals/legacy/obsidian-rlm-distiller/evals.jsonconfig685 B
evals/legacy/obsidian-vault-crud/evals.jsonconfig638 B
evals/legacy/obsidian-vault-crud/results.tsvother301 B
evals/legacy/obsidian-wiki-builder/evals.jsonconfig732 B
evals/legacy/obsidian-wiki-linter/evals.jsonconfig1.5 KB
evals/results.tsvother73 B
evals/task-success.jsonconfig3.5 KB
references/acceptance-criteria.mdmarkdown2.9 KB
references/architecture-background.mdmarkdown2.8 KB
references/dependencies.mdmarkdown1.7 KB
references/interactive-setup.mdmarkdown7.0 KB
references/interactive-stack-setup.mdmarkdown5.6 KB
references/kepano-analysis-summary.mdmarkdown1.7 KB
references/obsidian-bases-manager-acceptance-criteria.mdmarkdown628 B
references/obsidian-bases-manager-fallback-tree.mdmarkdown787 B
references/obsidian-bases-manager.mdmarkdown2.1 KB
references/obsidian-canvas-architect-acceptance-criteria.mdmarkdown645 B
references/obsidian-canvas-architect-fallback-tree.mdmarkdown836 B
references/obsidian-canvas-architect.mdmarkdown1.9 KB
references/obsidian-graph-traversal-acceptance-criteria.mdmarkdown690 B
references/obsidian-graph-traversal-fallback-tree.mdmarkdown877 B
references/obsidian-graph-traversal.mdmarkdown2.2 KB
references/obsidian-init-acceptance-criteria.mdmarkdown650 B
references/obsidian-init-fallback-tree.mdmarkdown1.1 KB
references/obsidian-init.mdmarkdown2.0 KB
references/obsidian-markdown-mastery-acceptance-criteria.mdmarkdown700 B
references/obsidian-markdown-mastery-fallback-tree.mdmarkdown889 B
references/obsidian-markdown-mastery.mdmarkdown2.2 KB
references/obsidian-query-agent.mdmarkdown1.8 KB
references/obsidian-rlm-distiller.mdmarkdown1.8 KB
references/obsidian-vault-crud-acceptance-criteria.mdmarkdown833 B
references/obsidian-vault-crud-fallback-tree.mdmarkdown1.1 KB
references/obsidian-vault-crud.mdmarkdown2.2 KB
references/obsidian-vault-onboarding-guide.mdmarkdown3.7 KB
references/obsidian-wiki-builder.mdmarkdown1.8 KB
references/obsidian-wiki-linter.mdmarkdown1.7 KB
references/resource-index.mdmarkdown4.3 KB
references/safety-learnings.mdmarkdown2.7 KB
references/wiki-builder-guide.mdmarkdown2.7 KB
references/wiki-distillation-guide.mdmarkdown1.7 KB
references/wiki-linting-guide.mdmarkdown2.1 KB
references/wiki-query-guide.mdmarkdown2.1 KB
requirements.inother32 B
requirements.txtmanifest463 B
scripts/audit.pyscript9.0 KB
scripts/bases_ops.pyscript7.8 KB
scripts/canvas_gen.pyscript7.9 KB
scripts/canvas_ops.pyscript11.5 KB
scripts/concept_extractor.pyscript10.2 KB
scripts/constants.pyscript908 B
scripts/distill_wiki.pyscript12.9 KB
scripts/graph_ops.pyscript11.7 KB
scripts/ingest.pyscript8.3 KB
scripts/init_vault.pyscript5.7 KB
scripts/lint_wiki.pyscript9.3 KB
scripts/obsidian-parser/parser.pyscript6.5 KB
scripts/obsidian-parser/tests/test_parser.pyscript4.1 KB
scripts/query_wiki.pyscript21.3 KB
scripts/raw_manifest.pyscript14.3 KB
scripts/vault_ops.pyscript13.4 KB
scripts/wiki_builder.pyscript14.3 KB

scripts/init_vault.py

View on GitHub
"""
init_vault.py (CLI)
=====================================

Purpose:
    Bootstrap any project directory as an Obsidian Vault.
    Creates .obsidian/app.json with sensible exclusion filters for developer repos.

Layer: Core Operations

Usage Examples:
    pythoninit_vault.py --vault-root /path/to/vault
    pythoninit_vault.py --vault-root /path/to/vault --validate-only

Supported Object Types:
    - .obsidian/app.json

CLI Arguments:
    --vault-root: Root directory for the vault.
    --exclude: Additional exclusion patterns.
    --validate-only: Check without making changes.

Input Files:
    - Project directories containing .md files.

Output:
    - JSON results indicating initialization status.

Key Functions:
    init_vault(): Initialize an Obsidian Vault.
    count_markdown_files(): Count .md files in the vault.

Script Dependencies:
    os, sys, json, argparse, pathlib

Consumed by:
    - obsidian-init skill
"""
import os
import sys
import json
import argparse
from pathlib import Path
from typing import Optional, List, Dict, Any

DEFAULT_EXCLUSIONS = [
    "node_modules/",
    ".worktrees/",
    ".vector_data/",
    ".git/",
    "venv/",
    "__pycache__/",
    "*.json",
    "*.jsonl",
    "learning_package_snapshot.md",
    "bootstrap_packet.md",
    "learning_debrief.md",
    "*_packet.md",
    "*_digest.md",
    "dataset_package/",
    "rlm_summary_cache*",
    "rlm_tool_cache*"
]


def count_markdown_files(vault_root: Path) -> int:
    """Count .md files in the vault (non-recursive top-level scan for speed)."""
    count = 0
    for root, dirs, files in os.walk(vault_root):
        # Skip .git and other hidden dirs
        dirs[:] = [d for d in dirs if not d.startswith('.')]
        for f in files:
            if f.endswith('.md'):
                count += 1
    return count


def _write_app_json(app_json: Path, exclusions: List[str]) -> None:
    """Merge exclusions into app.json's userIgnoreFilters and write it (preserving other keys)."""
    app_config: Dict[str, Any] = {}
    if app_json.exists():
        try:
            app_config = json.loads(app_json.read_text())
        except json.JSONDecodeError:
            pass

    app_config["userIgnoreFilters"] = exclusions
    app_json.write_text(json.dumps(app_config, indent=2) + "\n")


def _ensure_gitignore_excludes_obsidian(vault_root: Path) -> Optional[str]:
    """Append or create .gitignore's .obsidian/ exclusion. Returns 'updated', 'created', or None."""
    gitignore = vault_root / ".gitignore"
    if gitignore.exists():
        content = gitignore.read_text()
        if ".obsidian/" not in content:
            with open(gitignore, 'a') as f:
                f.write("\n# Obsidian local config (user-specific)\n.obsidian/\n")
            return "updated"
        return None
    gitignore.write_text("# Obsidian local config (user-specific)\n.obsidian/\n")
    return "created"


def _finalize_init_result(result: Dict[str, Any], vault_root: Path, exclusions: List[str]) -> Dict[str, Any]:
    """Populate the final 'initialized' status fields (status, exclusions_applied, next_steps, env_hint)."""
    result["status"] = "initialized"
    result["exclusions_applied"] = len(exclusions)
    result["next_steps"] = [
        "Open the Obsidian desktop app",
        f"Click 'Open Folder as Vault' and select: {vault_root}",
        "All non-excluded .md files will be indexed automatically"
    ]
    if not os.environ.get("VAULT_PATH"):
        result["env_hint"] = f"Consider setting: export VAULT_PATH={vault_root}"
    return result


def init_vault(vault_root: Path, extra_exclusions: Optional[List[str]] = None, validate_only: bool = False) -> Dict[str, Any]:
    """Initialize an Obsidian Vault at the given root."""
    vault_root = vault_root.resolve()

    if not vault_root.exists():
        return {"error": f"Directory does not exist: {vault_root}"}

    if not vault_root.is_dir():
        return {"error": f"Not a directory: {vault_root}"}

    # Count markdown files
    md_count = count_markdown_files(vault_root)
    if md_count == 0:
        return {"error": f"No .md files found in {vault_root}. Is this the right directory?"}

    obsidian_dir = vault_root / ".obsidian"
    app_json = obsidian_dir / "app.json"

    result = {
        "vault_root": str(vault_root),
        "markdown_files_found": md_count,
        "obsidian_dir_exists": obsidian_dir.exists(),
        "app_json_exists": app_json.exists(),
    }

    if validate_only:
        result["mode"] = "validate_only"
        if obsidian_dir.exists():
            result["status"] = "vault_already_initialized"
        else:
            result["status"] = "ready_to_initialize"
        return result

    # Build exclusion list
    exclusions = list(DEFAULT_EXCLUSIONS)
    if extra_exclusions:
        exclusions.extend(extra_exclusions)

    # Create .obsidian directory
    obsidian_dir.mkdir(exist_ok=True)
    _write_app_json(app_json, exclusions)

    gitignore_status = _ensure_gitignore_excludes_obsidian(vault_root)
    if gitignore_status:
        result[f"gitignore_{gitignore_status}"] = True

    return _finalize_init_result(result, vault_root, exclusions)


def main() -> None:
    """Parse CLI args, run init_vault, print the JSON result, and exit(1) on error."""
    parser = argparse.ArgumentParser(description="Initialize an Obsidian Vault")
    parser.add_argument('--vault-root', required=True, help='Root directory for the vault')
    parser.add_argument('--exclude', nargs='*', help='Additional exclusion patterns')
    parser.add_argument('--validate-only', action='store_true', help='Check without making changes')

    args = parser.parse_args()
    result = init_vault(Path(args.vault_root), args.exclude, args.validate_only)
    print(json.dumps(result, indent=2))

    if "error" in result:
        sys.exit(1)


if __name__ == '__main__':
    main()
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
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: 194kUpdated Claude CodeCodexVerifiedInstall