obsidian-project-bootstrap

Bootstraps an Obsidian knowledge base structure for a research code repository.

Updated Oct 7, 2022
One-click install
npx skills add https://github.com/tamagusko/linux-cfg --skill obsidian-project-bootstrap-tamagusko
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-project-bootstrap
Source: https://github.com/tamagusko/linux-cfg/tree/main/dotfiles/claude/skills/obsidian-project-bootstrap
Command: npx skills add https://github.com/tamagusko/linux-cfg --skill obsidian-project-bootstrap-tamagusko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Setting up a structured research knowledge base for an existing code-plus-Markdown repository is manual and inconsistent. This Skill automates the initial binding between a repository and an Obsidian vault, creating the canonical note structure without importing heavy artifacts. ## Core Features & Use Cases - Preflight Detection: Runs a detect step to check whether the repository is already bound or research-like before making changes. - Automated Bootstrap: Generates a registry, project memory file, and a compact vault structure (Hub, Plan, Knowledge, Papers, Experiments, Results, Writing, Daily, Archive). - Agent-First Enrichment: After bootstrap, synthesizes durable notes from repo docs and code entry points instead of leaving placeholder notes. - Use Case: You have a machine learning research repo with code and Markdown docs. Ask to import it into Obsidian, and the Skill creates a linked knowledge base with a source inventory and codebase overview, ready for ongoing research notes. ## Quick Start Start a new research project knowledge base in my Obsidian vault for the current repository.

Frequently Asked Questions about obsidian-project-bootstrap

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I import an existing code repository into Obsidian?

Run the bootstrap flow with the repository root as the working directory and provide a vault path explicitly or through the OBSIDIAN_VAULT_PATH environment variable. The process creates a registry, project memory file, and a compact vault structure with Hub, Plan, and Knowledge notes.

How do I start a new research project knowledge base in Obsidian?

Invoke the bootstrap procedure after the detect step confirms the repo is unbound and research-like. It generates 00-Hub.md, 01-Plan.md, Source-Inventory.md, and Codebase-Overview.md under a Research folder named after the project slug.

What happens if the repository is already bound to an Obsidian vault?

The preflight detect step identifies the existing binding and stops the process. The Skill reuses the existing project instead of rebuilding, so bootstrap is not run again by default.

Does the bootstrap copy datasets or code into the Obsidian vault?

No. The bootstrap imports only structure and summaries, explicitly ignoring .git, .venv, node_modules, caches, checkpoints, binaries, and other heavy artifacts. Raw datasets and the full code tree are never copied.

Why does bootstrap fail with a vault path missing error?

The vault path is required input and must come from explicit user input or the OBSIDIAN_VAULT_PATH environment variable. If neither is set, the process stops and requests the path before continuing.