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

122 lines
5.6 KiB
Markdown
Raw Permalink Normal View History

<h1 align="center">Agent Client Plugin for Obsidian</h1>
2025-10-23 05:19:44 +00:00
<p align="center">
<img src="https://img.shields.io/github/downloads/RAIT-09/obsidian-agent-client/total" alt="GitHub Downloads">
<img src="https://img.shields.io/github/license/RAIT-09/obsidian-agent-client" alt="License">
<img src="https://img.shields.io/github/v/release/RAIT-09/obsidian-agent-client" alt="GitHub release">
<img src="https://img.shields.io/github/last-commit/RAIT-09/obsidian-agent-client" alt="GitHub last commit">
<a href="https://github.com/RAIT-09/obsidian-agent-client/discussions"><img src="https://img.shields.io/github/discussions/RAIT-09/obsidian-agent-client" alt="GitHub Discussions"></a>
</p>
<p align="center">
<a href="https://community.obsidian.md/plugins/agent-client" target="_blank"><img src="https://img.shields.io/badge/Add%20to%20Obsidian-7c3aed?logo=obsidian&logoColor=white&style=for-the-badge" alt="Add to Obsidian"></a>
</p>
<p align="center">
<a href="https://www.buymeacoffee.com/rait09" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="180" height="50" ></a>
</p>
2025-10-23 05:19:44 +00:00
AIエージェントClaude Code、Codex、Gemini CLIをObsidianに直接統合。Vault内からAIアシスタントとチャットできます。
2025-10-23 05:19:44 +00:00
このプラグインは、Zed の [Agent Client Protocol (ACP)](https://github.com/agentclientprotocol/agent-client-protocol) で構築されています。
2025-10-23 05:19:44 +00:00
2025-12-13 05:15:37 +00:00
https://github.com/user-attachments/assets/1c538349-b3fb-44dd-a163-7331cbca7824
2025-10-23 05:19:44 +00:00
## 機能
2025-10-23 05:19:44 +00:00
- **ノートメンション**: `@ノート名`でノートを参照
- **画像添付**: チャットに画像をペーストまたはドラッグ&ドロップ
- **スラッシュコマンド**: エージェントが提供する`/`コマンドを使用
- **マルチエージェント**: Claude Code、Codex、Gemini CLI、カスタムエージェントを切り替え
- **マルチセッション**: 複数のエージェントを別々のビューで同時実行
- **フローティングチャット**: 素早くアクセスできる折りたたみ可能なチャットウィンドウ
- **モード・モデル切り替え**: チャット画面からAIモデルやエージェントモードを変更
- **セッション履歴**: 過去の会話を再開またはフォーク
- **チャットエクスポート**: 会話をMarkdownートとして保存
- **ターミナル統合**: エージェントがコマンドを実行し結果を返す
- **MCPサポート**: エージェントに設定済みのMCPサーバーがそのまま利用可能 — プラグイン側の追加設定は不要
2025-10-23 05:19:44 +00:00
## インストール
2025-10-23 05:19:44 +00:00
### コミュニティプラグインから(推奨)
1. **設定 → コミュニティプラグイン → 閲覧** を開く
2. **「Agent Client」** を検索
3. **インストール****有効化** をクリック
### BRAT経由プレリリース版
コミュニティプラグインに公開される前のプレリリース版を試すには:
2025-10-23 05:19:44 +00:00
1. [BRAT](https://github.com/TfTHacker/obsidian42-brat) プラグインをインストール
2. **設定 → BRAT → Add Beta Plugin** に移動
3. 貼り付け: `https://github.com/RAIT-09/obsidian-agent-client`
4. プラグインリストから **Agent Client** を有効化
2025-10-23 05:19:44 +00:00
### 手動インストール
2025-10-23 05:19:44 +00:00
1. [リリース](https://github.com/RAIT-09/obsidian-agent-client/releases)から `main.js`、`manifest.json`、`styles.css` をダウンロード
2. `VaultFolder/.obsidian/plugins/agent-client/` に配置
3. **設定 → コミュニティプラグイン** でプラグインを有効化
2025-10-23 05:19:44 +00:00
## クイックスタート
2025-10-23 05:19:44 +00:00
ターミナルmacOS/LinuxではTerminal、WindowsではPowerShellを開き、以下のコマンドを実行します。
2025-10-23 05:19:44 +00:00
1. **エージェントとACPアダプタをインストール**(例: Claude Code:
```bash
curl -fsSL https://claude.ai/install.sh | bash # Claude Codeをインストール
npm install -g @agentclientprotocol/claude-agent-acp # ACPアダプタをインストール
```
2025-10-23 05:19:44 +00:00
2. **ログイン**APIキーを使う場合はスキップ:
```bash
claude
```
プロンプトに従ってAnthropicアカウントで認証します。
3. **パスを確認**:
```bash
which node # macOS/Linux
which claude-agent-acp
where.exe node # Windows
where.exe claude-agent-acp
```
2025-10-23 05:19:44 +00:00
4. **設定 → Agent Client** で設定:
- **Node.js path**: 例: `/usr/local/bin/node`
- **Built-in agents → Claude Code → Path**: 例: `/usr/local/bin/claude-agent-acp``claude`ではない)
- **API key**: キーを追加、またはCLIでログイン済みの場合は空欄
5. **チャット開始**: リボンのロボットアイコンをクリック
### セットアップガイド
- [Claude Code](https://rait-09.github.io/obsidian-agent-client/agent-setup/claude-code.html)
- [Codex](https://rait-09.github.io/obsidian-agent-client/agent-setup/codex.html)
- [Gemini CLI](https://rait-09.github.io/obsidian-agent-client/agent-setup/gemini-cli.html)
- [カスタムエージェント](https://rait-09.github.io/obsidian-agent-client/agent-setup/custom-agents.html)OpenCode、Qwen Code、Kiro、Mistral Vibeなど
2025-10-23 05:19:44 +00:00
**[ドキュメント全文](https://rait-09.github.io/obsidian-agent-client/)**
2025-10-23 05:19:44 +00:00
## 開発
2025-10-23 05:19:44 +00:00
```bash
npm install
npm run dev
```
プロダクションビルド:
2025-10-23 05:19:44 +00:00
```bash
npm run build
```
## ライセンス
2025-10-23 05:19:44 +00:00
Apache License 2.0 - 詳細は [LICENSE](LICENSE) を参照。
2025-10-26 04:55:58 +00:00
## Star History
2025-10-26 04:55:58 +00:00
[![Star History Chart](https://api.star-history.com/svg?repos=RAIT-09/obsidian-agent-client&type=Date)](https://www.star-history.com/#RAIT-09/obsidian-agent-client&Date)