obsidian-project-bootstrap

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Obsidian Project Bootstrap

Bootstrap a project knowledge base for the current repository.

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

Role in the workflow

工作流中的角色

This is a supporting skill.

Use

obsidian-project-memory

as the main workflow authority. Use this skill only when a repository still needs its initial binding or rebuild.

这是一项支持性Skill。

以

obsidian-project-memory

作为主要工作流权限。仅当仓库仍需初始绑定或重建时才使用此Skill。

When to use

使用场景

The user says “start a new research project”.
The user has an existing repo with code plus Markdown and wants an Obsidian knowledge base generated automatically.
```
obsidian-project-memory
```
detects a research-project candidate but no existing binding.

用户说“启动一个新的研究项目”。
用户拥有包含代码和Markdown的现有仓库，希望自动生成Obsidian知识库。
```
obsidian-project-memory
```
检测到研究项目候选对象，但不存在现有绑定。

Required input

必要输入

Resolve the vault path from one of:

explicit user input,
```
OBSIDIAN_VAULT_PATH
```
.

从以下任一来源解析vault路径：

用户明确输入，
```
OBSIDIAN_VAULT_PATH
```
环境变量。

Procedure

流程

Identify the repository root.

Run a preflight detect step first:

bash

python3 "${CLAUDE_PLUGIN_ROOT}/skills/obsidian-project-memory/scripts/project_kb.py" detect --cwd "$PWD"

Only if the repo is unbound and should be imported, run bootstrap:

bash

python3 "${CLAUDE_PLUGIN_ROOT}/skills/obsidian-project-memory/scripts/project_kb.py" bootstrap --cwd "$PWD" --vault-path "$OBSIDIAN_VAULT_PATH"

Verify that bootstrap created at least:

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

If the imported project still lacks real background or experiment context, switch to an agent-first pass:
- read the most informative repo docs and code entry points,
- synthesize durable notes into
```
Knowledge/
```
  ,
```
Papers/
```
  ,
```
Experiments/
```
  ,
```
Results/
```
  , or
```
Writing/
```
  ,
- avoid placeholder notes.
Summarize the created knowledge base and the next recommended canonical notes to fill in.

首先运行预检检测步骤：

bash

python3 "${CLAUDE_PLUGIN_ROOT}/skills/obsidian-project-memory/scripts/project_kb.py" detect --cwd "$PWD"

仅当仓库未绑定且需要导入时，运行初始化引导：

bash

python3 "${CLAUDE_PLUGIN_ROOT}/skills/obsidian-project-memory/scripts/project_kb.py" bootstrap --cwd "$PWD" --vault-path "$OBSIDIAN_VAULT_PATH"

验证初始化引导至少创建了以下内容：

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

如果导入的项目仍缺少实际背景或实验上下文，切换至Agent优先流程：
- 读取信息最丰富的仓库文档和代码入口点，
- 将持久化笔记整合到
```
Knowledge/
```
  、
```
Papers/
```
  、
```
Experiments/
```
  、
```
Results/
```
  或
```
Writing/
```
  目录中，
- 避免使用占位符笔记。
总结已创建的知识库，以及下一步建议补充的标准笔记。

Notes

注意事项

The bootstrap process imports structure and summaries, not raw datasets, caches, checkpoints, or the whole code tree.
Ignore
```
.git
```
,
```
.venv
```
,
```
node_modules
```
, caches, checkpoints, binaries, and other heavy artifacts.

The default vault is compact:

00-Hub.md

01-Plan.md

Knowledge/

Papers/

Experiments/

Results/

Writing/

Daily/

Archive/

If
```
python3
```
is unavailable in the current shell, use the system Python interpreter that can run
```
project_kb.py
```
and say so explicitly.

初始化引导过程仅导入结构和摘要，不导入原始数据集、缓存、检查点或整个代码树。
忽略
```
.git
```
、
```
.venv
```
、
```
node_modules
```
、缓存、检查点、二进制文件和其他大型工件。

默认vault结构紧凑：包含

00-Hub.md

、

01-Plan.md

、

Knowledge/

、

Papers/

、

Experiments/

、

Results/

、

Writing/

、

Daily/

、

Archive/

。

如果当前shell中无法使用
```
python3
```
，请使用能够运行
```
project_kb.py
```
的系统Python解释器，并明确说明这一点。

References

参考资料

```
references/BOOTSTRAP-RUNBOOK.md
```
- preflight decisions, failure modes, and post-bootstrap verification

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