vaultweaver は何をしますか?
ファイルをClaude Code用のナレッジグラフに変換します。ローカルデータから構造化されたLLMインデックスを構築するためのObsidian互換ツールです。
概要
VaultWeaverは、ローカルファイルシステム上のマークダウンファイル(特にObsidian Vault)をスキャンし、それらをグラフベースの構造化インデックスに変換します。このインデックスはClaude Codeのコンテキストとして読み込むことができ、AIエージェントがドキュメント間の関係性を理解し、より正確な回答を生成するのに役立ちます。
主な機能
- ファイルスキャン: 指定したディレクトリを再帰的にスキャンし、マークダウンファイルを収集します。
- エンティティ抽出: ファイル内の主要なエンティティ(トピック、人物、場所など)を抽出します。
- 関係性マッピング: ファイル間のリンクや共通キーワードに基づいて関係性を自動的にマッピングします。
- JSON出力: 生成されたナレッジグラフをClaude Codeが読み取り可能なJSON形式で出力します。
- Obsidian互換: Obsidian Vault内のバックリンクやタグを認識し、グラフ構造に反映します。
インストール
npm install -g vaultweaver
または、プロジェクト内でローカルにインストール:
npm install vaultweaver
使用法
基本的な使用法
vaultweaver --input /path/to/obsidian/vault --output ./knowledge-graph.json
Claude Codeとの連携
出力されたJSONファイルをClaude Codeのセッションで参照するには、以下のようにClaude Codeの設定に追加します:
{
"contextFiles": ["./knowledge-graph.json"]
}
または、CLI経由で直接読み込むことも可能:
claude code --context knowledge-graph.json
オプション
| オプション | 説明 | デフォルト値 |
|---|---|---|
--input | スキャンするディレクトリのパス | 必須 |
--output | 出力ファイルのパス | ./vaultweaver-output.json |
--max-files | 処理する最大ファイル数 | 1000 |
--include-tags | Obsidianのタグを含めるかどうか | true |
--verbose | 詳細ログの出力 | false |
出力形式
出力されるJSONは以下の構造を持ちます:
{
"version": "1.0",
"generatedAt": "2024-01-01T00:00:00Z",
"nodes": [
{
"id": "node-1",
"type": "document",
"label": "プロジェクト計画",
"filePath": "/path/to/doc.md",
"tags": ["プロジェクト", "計画"]
}
],
"edges": [
{
"source": "node-1",
"target": "node-2",
"relation": "references"
}
]
}
制限事項
- 対応フォーマットは現在マークダウンのみです。
- 大量のファイル(10,000以上)を処理する場合はパフォーマンスが低下する可能性があります。
- バイナリファイルや画像ファイルはスキップされます。
ライセンス
MIT