rait-09_obsidian-agent-client/README.ja.md

🤖 Agent Client Plugin for Obsidian

AIエージェントをObsidianに直接統合しましょう！このプラグインを使えば、Claude Code、Codex、Gemini CLI、その他のAIエージェントと、あなたのVaultから直接チャットできます。AIアシスタントがサイドパネルですぐに利用可能になります✨

このプラグインは、Zed の Agent Client Protocol (ACP) で構築されています。

https://github.com/user-attachments/assets/567f22dc-dd32-446d-8fc5-c8cdec8b2744

✨ 主な機能

• 🔗 エージェントの直接統合: 右側パネルでAIコーディングエージェントとチャット
• 📝 ノートメンション: アクティブなノートを自動的にメンションしたり、@ノート名で特定のノートを手動でメンションできます
• ⚡ スラッシュコマンド: /コマンドを使用して、エージェントが提供する機能を実行できます
• 🔄 複数のエージェントを切り替え: Claude Code、Codex、Gemini CLI、その他のカスタムエージェント間で簡単に切り替えることができます
• 💻 ターミナル統合: エージェントがターミナルコマンドを実行し、結果をチャットで返すことができます
• 🔐 権限管理: エージェントのアクションに対する細かい制御ができます

📦 インストール方法

🧪 BRAT経由でインストール

1. コミュニティプラグインから BRAT プラグインをインストールします。
2. Obsidianの設定で、コミュニティプラグイン → BRAT → Add Beta Plugin に移動します。
3. このリポジトリのURLを貼り付けます:

   https://github.com/RAIT-09/obsidian-agent-client
   

4. BRATが最新リリースをダウンロードし、自動更新を行います。
5. プラグインリストからAgent Clientを有効化します。

💻 手動でインストール

1. リリースから最新リリースのファイルをダウンロードします:
   • main.js
   • manifest.json
   • styles.css
2. プラグインのフォルダを作成し、ファイルを配置します: VaultFolder/.obsidian/plugins/agent-client/
3. Obsidianの設定 → コミュニティプラグイン でプラグインを有効化します

⚙️ プラグインの設定

ステップ1: 📦 必要な依存関係をインストール

• Claude Codeの場合:

  npm install -g @zed-industries/claude-code-acp
  

• Codexの場合:

  npm install -g @zed-industries/codex-acp
  

• Gemini CLIの場合:

  npm install -g @google/gemini-cli
  

ステップ2: 🔍 インストールパスを確認

エージェントをインストールした後、それぞれの絶対パスを確認してください:

macOS/Linuxの場合:

# Node.js のパスを確認
which node
# 出力例: /usr/local/bin/node

# Claude Code のパスを確認
which claude-code-acp
# 出力例: /usr/local/bin/claude-code-acp

# Codex のパスを確認
which codex-acp
# 出力例: /usr/local/bin/codex-acp

# Gemini CLI のパスを確認
which gemini
# 出力例: /usr/local/bin/gemini

Windowsの場合:

# Node.js のパスを確認
where.exe node
# 出力例: C:\Program Files\nodejs\node.exe

# Claude Code のパスを確認
where.exe claude-code-acp
# 出力例: C:\Users\Username\AppData\Roaming\npm\claude-code-acp.cmd

# Codex のパスを確認
where.exe codex-acp
# 出力例: C:\Users\Username\AppData\Roaming\npm\codex-acp.cmd

# Gemini CLI のパスを確認
where.exe gemini
# 出力例: C:\Users\Username\AppData\Roaming\npm\gemini.cmd

ステップ3: 🛠️ プラグインをセットアップ

1. Settings → Agent Clientを開く
2. node のパスを設定:
   • Node.js path: 上記で確認した絶対パスを入力 (例: /usr/local/bin/node または C:\Program Files\nodejs\node.exe)
3. 使用するエージェントを設定:
   • Claude Code:
     • Path: 絶対パスを入力 (例: /usr/local/bin/claude-code-acp)
     • API key: Anthropicアカウントにログイン済みの場合は任意
   • Codex
     • Path: 絶対パスを入力 (例: /usr/local/bin/codex-acp)
     • API key: OpenAIアカウントにログイン済みの場合は任意
   • Gemini CLI:
     • Path: 絶対パスを入力 (例: /usr/local/bin/gemini)
     • API key: Googleアカウントにログイン済みの場合は任意
   • Custom Agents: ACP互換のエージェントを追加可能

📋 設定例

macOS/Linuxの例:

Settings:
├── Node.js path: /usr/local/bin/node

Built-in agents:
├── Claude Code
│   ├── Path: /usr/local/bin/claude-code-acp
│   └── API key: (任意)
├── Codex
│   ├── Path: /usr/local/bin/codex-acp
│   └── API key: (任意)
└── Gemini CLI
    ├── Path: /usr/local/bin/gemini
    └── API key: (任意)

Windowsの例:

Settings:
├── Node.js path: C:\Program Files\nodejs\node.exe

Built-in agents:
├── Claude Code
│   ├── Path: C:\Users\Username\AppData\Roaming\npm\claude-code-acp.cmd
│   └── API key: (任意)
├── Codex
│   ├── Path: C:\Users\Username\AppData\Roaming\npm\codex-acp.cmd
│   └── API key: (任意)
└── Gemini CLI
    ├── Path: C:\Users\Username\AppData\Roaming\npm\gemini.cmd
    └── API key: (任意)

🚀 使用方法

• 🎯 コマンドパレットを使用して開く: "Open agent chat"
• 🤖 リボンメニューのロボットアイコンをクリックして開く
• 💬 右側パネルで設定したエージェントとチャットする
• 📝 @ノート名でノートをメンションする
• 🔄 プラグイン設定のドロップダウンメニューからエージェントを切り替える

👨‍💻 開発者向け

npm install
npm run dev

ビルド:

npm run build

コードフォーマット（Prettier）:

# コードのフォーマットをチェック
npm run format:check

# フォーマットを自動修正
npm run format

🗺️ ロードマップ

• モデル切り替え機能: チャット画面から各エージェントのモデルを直接変更する
• 編集の追跡機能: エージェントの編集を自動で追跡 — 影響を受けるノートを開き、編集時にカーソルを移動する
• チャット履歴機能: エージェントとの過去のチャットセッションを閲覧、検索、復元する

アイデアや機能のリクエストがある場合は、ぜひお気軽にissueを開いてください！

📄 ライセンス

このプロジェクトはApache License 2.0の下でライセンスされています - 詳細はLICENSEファイルをご覧ください。

⭐️ Star History