mcpField
O
obsidian-project-bootstrap

obsidian-project-bootstrap

github.com/galaxy-dawn生产力5.9k47 次安装1 周前更新
代码仓库

关于 obsidian-project-bootstrap

为尚未绑定或需要重建项目绑定的代码仓库初始化 Obsidian 知识库的辅助技能。它导入结构和摘要，并指出可能需要补充的研究背景笔记。

主要功能

  1. 01检测现有项目绑定
  2. 02初始化仓库知识库
  3. 03导入结构和摘要
  4. 04验证必需文件与笔记
  5. 05确定后续规范笔记

适用场景

  1. 01为研究项目建立 Obsidian 知识库
  2. 02重建缺失的仓库绑定

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/galaxy-dawn/claude-scholar --skill obsidian-project-bootstrap

安装后在 Claude Code 中输入/obsidian-project-bootstrap确认已加载。

附带文件references/BOOTSTRAP-RUNBOOK.md

详细介绍

Obsidian 项目初始化

为当前仓库初始化项目知识库。

在工作流中的角色

这是一项辅助技能。

使用 obsidian-project-memory 作为主要工作流依据。仅当仓库仍需要首次绑定或重建时，才使用此技能。

使用时机

  • 用户说“开始一个新的研究项目”。
  • 用户已有一个包含代码和 Markdown 的仓库，并希望自动生成 Obsidian 知识库。
  • obsidian-project-memory 检测到一个候选研究项目，但尚无现有绑定。

必需输入

通过以下任一方式确定知识库路径：

  1. 用户明确提供，
  2. OBSIDIAN_VAULT_PATH。

流程

  1. 确定仓库根目录。
  2. 先运行预检检测步骤： 
    python3 "${CLAUDE_PLUGIN_ROOT}/skills/obsidian-project-memory/scripts/project_kb.py" detect --cwd "$PWD"
  3. 只有当仓库尚未绑定且应当导入时，才运行初始化： 
    python3 "${CLAUDE_PLUGIN_ROOT}/skills/obsidian-project-memory/scripts/project_kb.py" bootstrap --cwd "$PWD" --vault-path "$OBSIDIAN_VAULT_PATH"
  4. 验证初始化至少创建了以下文件：
    • .claude/project-memory/registry.yaml
    • .claude/project-memory/<project_id>.md
    • Research/{project-slug}/00-Hub.md
    • Research/{project-slug}/01-Plan.md
    • Research/{project-slug}/Knowledge/Source-Inventory.md
    • Research/{project-slug}/Knowledge/Codebase-Overview.md
  5. 如果导入的项目仍缺少实际背景或实验信息，请改用 Agent 优先的处理方式：
    • 阅读信息量最大的仓库文档和代码入口点，
    • 将经整理且长期有效的笔记写入 Knowledge/、Papers/、Experiments/、Results/ 或 Writing/，
    • 避免创建占位笔记。
  6. 总结已创建的知识库，并列出接下来建议补充的规范笔记。

说明

  • 初始化流程导入的是结构和摘要，而不是原始数据集、缓存、检查点或整个代码树。
  • 忽略 .git、.venv、node_modules、缓存、检查点、二进制文件及其他大型文件。
  • 默认知识库结构精简，包含：00-Hub.md、01-Plan.md、Knowledge/、Papers/、Experiments/、Results/、Writing/、Daily/、Archive/。
  • 如果当前 shell 中没有 python3，请使用能够运行 project_kb.py 的系统 Python 解释器，并明确说明这一点。

参考资料

  • references/BOOTSTRAP-RUNBOOK.md - 预检决策、故障模式和初始化后的验证

评论

支持 Markdown