Obsidian Vault 同期セットアップガイド¶
MyLabリポジトリのドキュメント・ログをObsidianで閲覧・編集するためのセットアップ手順。
アーキテクチャ¶
MyLab (メインリポジトリ)
├── docs/ ──┐
├── logs/ ──┤ sync_to_vault.py
├── .obsidian/ ──┤ (GitHub Actions or ローカル実行)
└── README.md ──┘
↓
KZ55230/obsidian-vault (Vault用リポジトリ)
├── docs/ ← MyLabから同期
├── logs/ ← MyLabから同期
├── .obsidian/ ← Obsidian設定
└── MyLab-README.md ← MyLabのREADME
↓
Obsidian (ローカル)
└── Obsidian Git プラグインで自動pull
1. Vault用リポジトリの作成¶
GitHub上で新しいリポジトリを作成:
# GitHubで KZ55230/obsidian-vault を作成(Private推奨)
# https://github.com/new
# ローカルにクローン
git clone https://github.com/KZ55230/obsidian-vault.git
cd obsidian-vault
echo "# Obsidian Vault" > README.md
git add README.md
git commit -m "initial commit"
git push -u origin main
2. GitHub Actions の設定(自動同期)¶
Personal Access Token の作成¶
- GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens
- 「Generate new token」をクリック
- 設定:
- Token name:
vault-sync - Expiration: 90 days(またはNo expiration)
- Repository access:
KZ55230/obsidian-vaultのみ - Permissions:
- Contents: Read and Write
- トークンを生成してコピー
Secretの登録¶
- MyLabリポジトリ → Settings → Secrets and variables → Actions
- 「New repository secret」をクリック
- 設定:
- Name:
VAULT_SYNC_PAT - Value: 上で生成したトークン
これで docs/、logs/、.obsidian/ に変更がpushされると自動的にvaultリポジトリに同期されます。
3. ローカルでの手動同期¶
# MyLabリポジトリのルートから実行
python scripts/sync_to_vault.py --vault-repo /path/to/obsidian-vault
# ドライラン(変更内容の確認のみ)
python scripts/sync_to_vault.py --vault-repo /path/to/obsidian-vault --dry-run
# コミットのみ(プッシュしない)
python scripts/sync_to_vault.py --vault-repo /path/to/obsidian-vault --no-push
Windows環境の例¶
4. Obsidian側のセットアップ¶
Obsidian Git プラグインのインストール¶
- Obsidianを開く
- Settings → Community Plugins → Browse
- 「Obsidian Git」を検索してインストール
- プラグインを有効化
Vault を開く¶
- vaultリポジトリをローカルにクローン:
- Obsidian → 「Open folder as vault」→ クローンしたディレクトリを選択
Obsidian Git プラグイン設定¶
Settings → Obsidian Git:
| 設定項目 | 推奨値 | 説明 |
|---|---|---|
| Auto pull interval | 5 | 5分ごとに自動pull |
| Auto push interval | 0 | 手動pushのみ(読み取り専用の場合) |
| Pull on startup | ON | 起動時にpull |
5. 同期対象¶
| ソース (MyLab) | 同期先 (Vault) | 内容 |
|---|---|---|
docs/ | docs/ | ドキュメント、図面、ガイド |
logs/ | logs/ | 会話ログ |
.obsidian/ | .obsidian/ | Obsidian設定 |
README.md | MyLab-README.md | プロジェクト概要 |
除外されるファイル¶
__pycache__/*.pyc.DS_StoreThumbs.db
トラブルシューティング¶
GitHub Actionsが動かない¶
VAULT_SYNC_PATシークレットが正しく設定されているか確認- トークンの有効期限が切れていないか確認
- トークンに
obsidian-vaultリポジトリへのContents書き込み権限があるか確認
Obsidian Gitでpullが失敗する¶
- リポジトリのURLとクレデンシャルが正しいか確認
- Gitがインストールされているか確認
.gitconfigにユーザー名とメールが設定されているか確認