obsidian-git-sync-starter

Stop configuring, Start writing.
「どのPCからでも git clone 一発。環境依存を排除し、テストによって動作が保証された、究極の Obsidian × GitHub 同期テンプレート」

---

🌟 Overview

Obsidianを複数のPCで利用する際、GitHub連携の設定や .obsidian 内の競合に悩まされていませんか？ このプロジェクトは、dotenv (.env) 方式を採用した汎用セットアップスクリプトを提供し、ノートPC単位での環境構築の煩わしさをゼロにします。

なぜこのテンプレートなのか？

• 環境の完全分離: OSやデバイスごとに異なる「ワークスペース設定」を自動除外。
• 一貫した自動構築: Windows (PowerShell) と Mac/Linux (Bash) の両対応。
• クリーンアップ機能: cleanup スクリプトにより、何度でも環境をリセットして試行可能。
• AI-Native (MCP Ready): 将来のAIエージェント（Claude/Cursor）連携を見越した MCP_PORT 設定をプリセット。

---

🚀 Quick Start

"Zero-Configuration Plugin Setup"

従来のテンプレートは「自分でプラグインを探してインストール」が必要でしたが、本ツールは setup スクリプト内でプラグインのバイナリ配置まで自動化します。Vaultを開いた瞬間、すでに Obsidian-Git がスタンバイ状態です。

1. テンプレートの準備

ブラウザで本リポジトリを開き、Use this template ボタンから自分専用のリポジトリを作成します。 👉 画像付きの手順解説はこちら

2. リポジトリのクローン

作成した自分のリポジトリをローカルにクローンします。

git clone https://github.com/[YOUR_ID]/[YOUR_REPO].git
cd [YOUR_REPO]

3. 環境設定 (.env)

.env.example をコピーして、ご自身の環境に合わせて編集します。INSTALL_PATH を指定することで、任意の場所に Vault を作成できます。

cp .env.example .env
# エディタで開き、GITHUB_USER や INSTALL_PATH を書き換え

4. セットアップ実行

ご自身のOSに合わせたスクリプトを実行してください。

Mac / Linux (Bash)

chmod +x src/setup.sh src/cleanup.sh
bash src/setup.sh

Windows (PowerShell)

.\src\setup.ps1

5. リモートリポジトリの作成と初回プッシュ (重要)

setup.sh 実行時に「Remote repository not found」と表示された場合は、以下の手順で同期を確立させます。

1. GitHubでリポジトリを作成: こちらから新規作成 (名前は .env と同じもの)
2. 初回プッシュ: Vault フォルダに移動し、以下のコマンドを実行します。

   git push -u origin main
   

6. Obsidianで開く

セットアップが完了したら、以下のガイドに従って Vault を開いてください。 👉 Vaultを開く詳細な手順はこちら

✅ Reliability / Testing

本プロジェクトは、品質と再現性を担保するために統合テスト（Integration Tests）をパスしています。

検証項目 (automated via tests/)

• .env からの変数の正常な読み込みとバリデーション
• 指定パスへのディレクトリ構造の自動生成
• 秘伝の .gitignore による環境競合の防止
• app.json への動的な設定注入
• cleanup スクリプトによる安全なロールバック

テストの実行方法

• Mac/Linux: bash tests/test-init.sh
• Windows: .\tests\test-init.ps1

---

🧹 Cleanup

作成した Vault を削除して元の状態に戻したい場合は、以下のコマンドを使用します。

• Mac/Linux: bash src/cleanup.sh
• Windows: .\src\cleanup.ps1

---

📅 Roadmap

• iOS/Android 同期用の Working Copy 連携ガイドの追加
• AIエージェント向け MCP サーバー設定の正式実装
• 特定の技術スタック向けの Obsidian-to-StaticSite 連携テンプレート

---

👤 Author

fk2000

• X (Twitter): @fk_2000
• Blog: Zenn (技術記事), Note
• GitHub: fk2000

---

📄 License

This project is licensed under the MIT License.