@mseep/obsidian-agent-client 0.10.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/.claude/hooks/gh-setup.sh +49 -0
  2. package/.claude/settings.json +15 -0
  3. package/.claude/skills/release-notes/SKILL.md +331 -0
  4. package/.editorconfig +10 -0
  5. package/.github/FUNDING.yml +2 -0
  6. package/.github/ISSUE_TEMPLATE/bug_report.yml +90 -0
  7. package/.github/ISSUE_TEMPLATE/config.yml +11 -0
  8. package/.github/ISSUE_TEMPLATE/feature_request.yml +59 -0
  9. package/.github/copilot-instructions.md +45 -0
  10. package/.github/pull_request_template.md +32 -0
  11. package/.github/workflows/ci.yaml +25 -0
  12. package/.github/workflows/docs.yml +58 -0
  13. package/.github/workflows/relay_to_openclaw.yml +59 -0
  14. package/.github/workflows/release.yaml +45 -0
  15. package/.prettierignore +10 -0
  16. package/.prettierrc +13 -0
  17. package/.vscode/extensions.json +7 -0
  18. package/.vscode/settings.json +37 -0
  19. package/.zed/settings.json +42 -0
  20. package/AGENTS.md +330 -0
  21. package/ARCHITECTURE.md +390 -0
  22. package/CONTRIBUTING.md +216 -0
  23. package/LICENSE +202 -0
  24. package/NOTICE +2 -0
  25. package/README.ja.md +121 -0
  26. package/README.md +125 -0
  27. package/docs/.vitepress/config.mts +124 -0
  28. package/docs/.vitepress/theme/custom.css +111 -0
  29. package/docs/.vitepress/theme/index.ts +4 -0
  30. package/docs/agent-setup/claude-code.md +84 -0
  31. package/docs/agent-setup/codex.md +76 -0
  32. package/docs/agent-setup/custom-agents.md +67 -0
  33. package/docs/agent-setup/gemini-cli.md +99 -0
  34. package/docs/agent-setup/index.md +34 -0
  35. package/docs/announcements/gemini-cli-deprecation.md +73 -0
  36. package/docs/getting-started/index.md +78 -0
  37. package/docs/getting-started/quick-start.md +38 -0
  38. package/docs/help/faq.md +181 -0
  39. package/docs/help/troubleshooting.md +221 -0
  40. package/docs/index.md +63 -0
  41. package/docs/public/apple-touch-icon.png +0 -0
  42. package/docs/public/demo.mp4 +0 -0
  43. package/docs/public/favicon-16x16.png +0 -0
  44. package/docs/public/favicon-32x32.png +0 -0
  45. package/docs/public/favicon.ico +0 -0
  46. package/docs/public/images/editing.webp +0 -0
  47. package/docs/public/images/export.webp +0 -0
  48. package/docs/public/images/floating-chat-button.webp +0 -0
  49. package/docs/public/images/floating-chat-instance-menu.webp +0 -0
  50. package/docs/public/images/floating-chat-view.webp +0 -0
  51. package/docs/public/images/mode-selection.webp +0 -0
  52. package/docs/public/images/model-selection.webp +0 -0
  53. package/docs/public/images/multi-session.webp +0 -0
  54. package/docs/public/images/remove-image.webp +0 -0
  55. package/docs/public/images/ribbon-icon.webp +0 -0
  56. package/docs/public/images/selection-context.gif +0 -0
  57. package/docs/public/images/sending-images.webp +0 -0
  58. package/docs/public/images/sending-messages.webp +0 -0
  59. package/docs/public/images/session-history-button.webp +0 -0
  60. package/docs/public/images/slash-commands-1.webp +0 -0
  61. package/docs/public/images/slash-commands-2.webp +0 -0
  62. package/docs/public/images/switch-agent.webp +0 -0
  63. package/docs/public/images/switch-default-agent.webp +0 -0
  64. package/docs/public/images/temporary-disable.gif +0 -0
  65. package/docs/reference/acp-support.md +110 -0
  66. package/docs/usage/chat-export.md +80 -0
  67. package/docs/usage/commands.md +51 -0
  68. package/docs/usage/context-files.md +57 -0
  69. package/docs/usage/editing.md +69 -0
  70. package/docs/usage/floating-chat.md +84 -0
  71. package/docs/usage/index.md +97 -0
  72. package/docs/usage/mcp-tools.md +33 -0
  73. package/docs/usage/mentions.md +70 -0
  74. package/docs/usage/mode-selection.md +28 -0
  75. package/docs/usage/model-selection.md +32 -0
  76. package/docs/usage/multi-session.md +68 -0
  77. package/docs/usage/sending-images.md +64 -0
  78. package/docs/usage/session-history.md +91 -0
  79. package/docs/usage/slash-commands.md +44 -0
  80. package/esbuild.config.mjs +49 -0
  81. package/eslint.config.mjs +25 -0
  82. package/main.js +228 -0
  83. package/manifest.json +11 -0
  84. package/package.json +52 -0
  85. package/src/acp/acp-client.ts +921 -0
  86. package/src/acp/acp-handler.ts +252 -0
  87. package/src/acp/permission-handler.ts +282 -0
  88. package/src/acp/terminal-handler.ts +264 -0
  89. package/src/acp/type-converter.ts +272 -0
  90. package/src/hooks/useAgent.ts +250 -0
  91. package/src/hooks/useAgentMessages.ts +470 -0
  92. package/src/hooks/useAgentSession.ts +544 -0
  93. package/src/hooks/useChatActions.ts +400 -0
  94. package/src/hooks/useHistoryModal.ts +219 -0
  95. package/src/hooks/useSessionHistory.ts +863 -0
  96. package/src/hooks/useSettings.ts +19 -0
  97. package/src/hooks/useSuggestions.ts +342 -0
  98. package/src/main.ts +9 -0
  99. package/src/plugin.ts +1126 -0
  100. package/src/services/chat-exporter.ts +552 -0
  101. package/src/services/message-sender.ts +755 -0
  102. package/src/services/message-state.ts +375 -0
  103. package/src/services/session-helpers.ts +211 -0
  104. package/src/services/session-state.ts +130 -0
  105. package/src/services/session-storage.ts +267 -0
  106. package/src/services/settings-normalizer.ts +255 -0
  107. package/src/services/settings-service.ts +285 -0
  108. package/src/services/update-checker.ts +128 -0
  109. package/src/services/vault-service.ts +558 -0
  110. package/src/services/view-registry.ts +345 -0
  111. package/src/types/agent.ts +92 -0
  112. package/src/types/chat.ts +351 -0
  113. package/src/types/errors.ts +136 -0
  114. package/src/types/obsidian-internals.d.ts +14 -0
  115. package/src/types/session.ts +731 -0
  116. package/src/ui/ChangeDirectoryModal.ts +137 -0
  117. package/src/ui/ChatContext.ts +25 -0
  118. package/src/ui/ChatHeader.tsx +295 -0
  119. package/src/ui/ChatPanel.tsx +1162 -0
  120. package/src/ui/ChatView.tsx +348 -0
  121. package/src/ui/ErrorBanner.tsx +104 -0
  122. package/src/ui/FloatingButton.tsx +351 -0
  123. package/src/ui/FloatingChatView.tsx +531 -0
  124. package/src/ui/InputArea.tsx +1107 -0
  125. package/src/ui/InputToolbar.tsx +371 -0
  126. package/src/ui/MessageBubble.tsx +442 -0
  127. package/src/ui/MessageList.tsx +265 -0
  128. package/src/ui/PermissionBanner.tsx +61 -0
  129. package/src/ui/SessionHistoryModal.tsx +821 -0
  130. package/src/ui/SettingsTab.ts +1337 -0
  131. package/src/ui/SuggestionPopup.tsx +138 -0
  132. package/src/ui/TerminalBlock.tsx +107 -0
  133. package/src/ui/ToolCallBlock.tsx +456 -0
  134. package/src/ui/shared/AttachmentStrip.tsx +57 -0
  135. package/src/ui/shared/IconButton.tsx +55 -0
  136. package/src/ui/shared/MarkdownRenderer.tsx +103 -0
  137. package/src/ui/view-host.ts +56 -0
  138. package/src/utils/error-utils.ts +274 -0
  139. package/src/utils/logger.ts +44 -0
  140. package/src/utils/mention-parser.ts +129 -0
  141. package/src/utils/paths.ts +246 -0
  142. package/src/utils/platform.ts +425 -0
  143. package/styles.css +2322 -0
  144. package/tsconfig.json +18 -0
  145. package/version-bump.mjs +18 -0
  146. package/versions.json +3 -0
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2025-2026 RAIT-09
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ obsidian-agent-client
2
+ Copyright 2025-2026 RAIT-09
package/README.ja.md ADDED
@@ -0,0 +1,121 @@
1
+ <h1 align="center">Agent Client Plugin for Obsidian</h1>
2
+
3
+ <p align="center">
4
+ <img src="https://img.shields.io/github/downloads/RAIT-09/obsidian-agent-client/total" alt="GitHub Downloads">
5
+ <img src="https://img.shields.io/github/license/RAIT-09/obsidian-agent-client" alt="License">
6
+ <img src="https://img.shields.io/github/v/release/RAIT-09/obsidian-agent-client" alt="GitHub release">
7
+ <img src="https://img.shields.io/github/last-commit/RAIT-09/obsidian-agent-client" alt="GitHub last commit">
8
+ <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>
9
+ </p>
10
+
11
+ <p align="center">
12
+ <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>
13
+ </p>
14
+
15
+ <p align="center">
16
+ <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>
17
+ </p>
18
+
19
+ AIエージェント(Claude Code、Codex、Gemini CLI)をObsidianに直接統合。Vault内からAIアシスタントとチャットできます。
20
+
21
+ このプラグインは、Zed の [Agent Client Protocol (ACP)](https://github.com/agentclientprotocol/agent-client-protocol) で構築されています。
22
+
23
+ https://github.com/user-attachments/assets/1c538349-b3fb-44dd-a163-7331cbca7824
24
+
25
+ ## 機能
26
+
27
+ - **ノートメンション**: `@ノート名`でノートを参照
28
+ - **画像添付**: チャットに画像をペーストまたはドラッグ&ドロップ
29
+ - **スラッシュコマンド**: エージェントが提供する`/`コマンドを使用
30
+ - **マルチエージェント**: Claude Code、Codex、Gemini CLI、カスタムエージェントを切り替え
31
+ - **マルチセッション**: 複数のエージェントを別々のビューで同時実行
32
+ - **フローティングチャット**: 素早くアクセスできる折りたたみ可能なチャットウィンドウ
33
+ - **モード・モデル切り替え**: チャット画面からAIモデルやエージェントモードを変更
34
+ - **セッション履歴**: 過去の会話を再開またはフォーク
35
+ - **チャットエクスポート**: 会話をMarkdownノートとして保存
36
+ - **ターミナル統合**: エージェントがコマンドを実行し結果を返す
37
+ - **MCPサポート**: エージェントに設定済みのMCPサーバーがそのまま利用可能 — プラグイン側の追加設定は不要
38
+
39
+ ## インストール
40
+
41
+ ### コミュニティプラグインから(推奨)
42
+
43
+ 1. **設定 → コミュニティプラグイン → 閲覧** を開く
44
+ 2. **「Agent Client」** を検索
45
+ 3. **インストール** → **有効化** をクリック
46
+
47
+ ### BRAT経由(プレリリース版)
48
+
49
+ コミュニティプラグインに公開される前のプレリリース版を試すには:
50
+
51
+ 1. [BRAT](https://github.com/TfTHacker/obsidian42-brat) プラグインをインストール
52
+ 2. **設定 → BRAT → Add Beta Plugin** に移動
53
+ 3. 貼り付け: `https://github.com/RAIT-09/obsidian-agent-client`
54
+ 4. プラグインリストから **Agent Client** を有効化
55
+
56
+ ### 手動インストール
57
+
58
+ 1. [リリース](https://github.com/RAIT-09/obsidian-agent-client/releases)から `main.js`、`manifest.json`、`styles.css` をダウンロード
59
+ 2. `VaultFolder/.obsidian/plugins/agent-client/` に配置
60
+ 3. **設定 → コミュニティプラグイン** でプラグインを有効化
61
+
62
+ ## クイックスタート
63
+
64
+ ターミナル(macOS/LinuxではTerminal、WindowsではPowerShell)を開き、以下のコマンドを実行します。
65
+
66
+ 1. **エージェントとACPアダプタをインストール**(例: Claude Code):
67
+ ```bash
68
+ curl -fsSL https://claude.ai/install.sh | bash # Claude Codeをインストール
69
+ npm install -g @agentclientprotocol/claude-agent-acp # ACPアダプタをインストール
70
+ ```
71
+
72
+ 2. **ログイン**(APIキーを使う場合はスキップ):
73
+ ```bash
74
+ claude
75
+ ```
76
+ プロンプトに従ってAnthropicアカウントで認証します。
77
+
78
+ 3. **パスを確認**:
79
+ ```bash
80
+ which node # macOS/Linux
81
+ which claude-agent-acp
82
+
83
+ where.exe node # Windows
84
+ where.exe claude-agent-acp
85
+ ```
86
+
87
+ 4. **設定 → Agent Client** で設定:
88
+ - **Node.js path**: 例: `/usr/local/bin/node`
89
+ - **Built-in agents → Claude Code → Path**: 例: `/usr/local/bin/claude-agent-acp`(`claude`ではない)
90
+ - **API key**: キーを追加、またはCLIでログイン済みの場合は空欄
91
+
92
+ 5. **チャット開始**: リボンのロボットアイコンをクリック
93
+
94
+ ### セットアップガイド
95
+
96
+ - [Claude Code](https://rait-09.github.io/obsidian-agent-client/agent-setup/claude-code.html)
97
+ - [Codex](https://rait-09.github.io/obsidian-agent-client/agent-setup/codex.html)
98
+ - [Gemini CLI](https://rait-09.github.io/obsidian-agent-client/agent-setup/gemini-cli.html)
99
+ - [カスタムエージェント](https://rait-09.github.io/obsidian-agent-client/agent-setup/custom-agents.html)(OpenCode、Qwen Code、Kiro、Mistral Vibeなど)
100
+
101
+ **[ドキュメント全文](https://rait-09.github.io/obsidian-agent-client/)**
102
+
103
+ ## 開発
104
+
105
+ ```bash
106
+ npm install
107
+ npm run dev
108
+ ```
109
+
110
+ プロダクションビルド:
111
+ ```bash
112
+ npm run build
113
+ ```
114
+
115
+ ## ライセンス
116
+
117
+ Apache License 2.0 - 詳細は [LICENSE](LICENSE) を参照。
118
+
119
+ ## Star History
120
+
121
+ [![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)
package/README.md ADDED
@@ -0,0 +1,125 @@
1
+ <h1 align="center">Agent Client Plugin for Obsidian</h1>
2
+
3
+ <p align="center">
4
+ <img src="https://img.shields.io/github/downloads/RAIT-09/obsidian-agent-client/total" alt="GitHub Downloads">
5
+ <img src="https://img.shields.io/github/license/RAIT-09/obsidian-agent-client" alt="License">
6
+ <img src="https://img.shields.io/github/v/release/RAIT-09/obsidian-agent-client" alt="GitHub release">
7
+ <img src="https://img.shields.io/github/last-commit/RAIT-09/obsidian-agent-client" alt="GitHub last commit">
8
+ <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>
9
+ </p>
10
+
11
+ <p align="center">
12
+ <a href="README.ja.md">日本語はこちら</a>
13
+ </p>
14
+
15
+ <p align="center">
16
+ <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>
17
+ </p>
18
+
19
+ <p align="center">
20
+ <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>
21
+ </p>
22
+
23
+ Bring AI agents (Claude Code, Codex, Gemini CLI) directly into Obsidian. Chat with your AI assistant right from your vault.
24
+
25
+ Built on [Agent Client Protocol (ACP)](https://github.com/agentclientprotocol/agent-client-protocol) by Zed.
26
+
27
+ https://github.com/user-attachments/assets/1c538349-b3fb-44dd-a163-7331cbca7824
28
+
29
+ ## Features
30
+
31
+ - **Note Mentions**: Reference your notes with `@notename` syntax
32
+ - **Image Attachments**: Paste or drag-and-drop images into the chat
33
+ - **Slash Commands**: Use `/` commands provided by your agent
34
+ - **Multi-Agent Support**: Switch between Claude Code, Codex, Gemini CLI, and custom agents
35
+ - **Multi-Session**: Run multiple agents simultaneously in separate views
36
+ - **Floating Chat**: A persistent, collapsible chat window for quick access
37
+ - **Mode & Model Switching**: Change AI models and agent modes from the chat
38
+ - **Session History**: Resume or fork previous conversations
39
+ - **Chat Export**: Save conversations as Markdown notes
40
+ - **Terminal Integration**: Let agents execute commands and return results
41
+ - **MCP Support**: Agents use their configured MCP servers — no extra setup needed in the plugin
42
+
43
+ ## Installation
44
+
45
+ ### From Community Plugins (Recommended)
46
+
47
+ 1. Open **Settings → Community Plugins → Browse**
48
+ 2. Search for **"Agent Client"**
49
+ 3. Click **Install**, then **Enable**
50
+
51
+ ### Via BRAT (Pre-release Versions)
52
+
53
+ To try pre-release versions before they are published to Community Plugins:
54
+
55
+ 1. Install the [BRAT](https://github.com/TfTHacker/obsidian42-brat) plugin
56
+ 2. Go to **Settings → BRAT → Add Beta Plugin**
57
+ 3. Paste: `https://github.com/RAIT-09/obsidian-agent-client`
58
+ 4. Enable **Agent Client** from the plugin list
59
+
60
+ ### Manual Installation
61
+
62
+ 1. Download `main.js`, `manifest.json`, `styles.css` from [Releases](https://github.com/RAIT-09/obsidian-agent-client/releases)
63
+ 2. Place them in `VaultFolder/.obsidian/plugins/agent-client/`
64
+ 3. Enable the plugin in **Settings → Community Plugins**
65
+
66
+ ## Quick Start
67
+
68
+ Open a terminal (Terminal on macOS/Linux, PowerShell on Windows) and run the following commands.
69
+
70
+ 1. **Install an agent and its ACP adapter** (e.g., Claude Code):
71
+ ```bash
72
+ curl -fsSL https://claude.ai/install.sh | bash # Install Claude Code
73
+ npm install -g @agentclientprotocol/claude-agent-acp # Install ACP adapter
74
+ ```
75
+
76
+ 2. **Login** (skip if using API key):
77
+ ```bash
78
+ claude
79
+ ```
80
+ Follow the prompts to authenticate with your Anthropic account.
81
+
82
+ 3. **Find the paths**:
83
+ ```bash
84
+ which node # macOS/Linux
85
+ which claude-agent-acp
86
+
87
+ where.exe node # Windows
88
+ where.exe claude-agent-acp
89
+ ```
90
+
91
+ 4. **Configure** in **Settings → Agent Client**:
92
+ - **Node.js path**: e.g., `/usr/local/bin/node`
93
+ - **Built-in agents → Claude Code → Path**: e.g., `/usr/local/bin/claude-agent-acp` (not `claude`)
94
+ - **API key**: Add your key, or leave empty if logged in via CLI
95
+
96
+ 5. **Start chatting**: Click the robot icon in the ribbon
97
+
98
+ ### Setup Guides
99
+
100
+ - [Claude Code](https://rait-09.github.io/obsidian-agent-client/agent-setup/claude-code.html)
101
+ - [Codex](https://rait-09.github.io/obsidian-agent-client/agent-setup/codex.html)
102
+ - [Gemini CLI](https://rait-09.github.io/obsidian-agent-client/agent-setup/gemini-cli.html)
103
+ - [Custom Agents](https://rait-09.github.io/obsidian-agent-client/agent-setup/custom-agents.html) (OpenCode, Qwen Code, Kiro, Mistral Vibe, etc.)
104
+
105
+ **[Full Documentation](https://rait-09.github.io/obsidian-agent-client/)**
106
+
107
+ ## Development
108
+
109
+ ```bash
110
+ npm install
111
+ npm run dev
112
+ ```
113
+
114
+ For production builds:
115
+ ```bash
116
+ npm run build
117
+ ```
118
+
119
+ ## License
120
+
121
+ Apache License 2.0 - see [LICENSE](LICENSE) for details.
122
+
123
+ ## Star History
124
+
125
+ [![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)
@@ -0,0 +1,124 @@
1
+ import { defineConfig } from "vitepress";
2
+
3
+ export default defineConfig({
4
+ title: "Agent Client",
5
+ description:
6
+ "Obsidian plugin for AI agent integration - Chat with Claude Code, Codex, Gemini CLI and more",
7
+
8
+ // GitHub Pages base path
9
+ base: "/obsidian-agent-client/",
10
+
11
+ head: [
12
+ ["link", { rel: "icon", type: "image/x-icon", href: "/obsidian-agent-client/favicon.ico" }],
13
+ ["link", { rel: "icon", type: "image/png", sizes: "32x32", href: "/obsidian-agent-client/favicon-32x32.png" }],
14
+ ["link", { rel: "icon", type: "image/png", sizes: "16x16", href: "/obsidian-agent-client/favicon-16x16.png" }],
15
+ ["link", { rel: "apple-touch-icon", sizes: "180x180", href: "/obsidian-agent-client/apple-touch-icon.png" }],
16
+ ["meta", { name: "og:type", content: "website" }],
17
+ ["meta", { name: "og:title", content: "Agent Client for Obsidian" }],
18
+ [
19
+ "meta",
20
+ {
21
+ name: "og:description",
22
+ content: "Chat with AI agents directly in Obsidian",
23
+ },
24
+ ],
25
+ [
26
+ "meta",
27
+ {
28
+ name: "og:url",
29
+ content: "https://rait-09.github.io/obsidian-agent-client/",
30
+ },
31
+ ],
32
+ ],
33
+
34
+ themeConfig: {
35
+ nav: [
36
+ { text: "Home", link: "/" },
37
+ { text: "Getting Started", link: "/getting-started/" },
38
+ { text: "Agent Setup", link: "/agent-setup/" },
39
+ { text: "Usage", link: "/usage/" },
40
+ { text: "GitHub", link: "https://github.com/RAIT-09/obsidian-agent-client" },
41
+ ],
42
+
43
+ sidebar: [
44
+ {
45
+ text: "Introduction",
46
+ items: [{ text: "What is Agent Client?", link: "/" }],
47
+ },
48
+ {
49
+ text: "Getting Started",
50
+ items: [
51
+ { text: "Installation", link: "/getting-started/" },
52
+ { text: "Quick Start", link: "/getting-started/quick-start" },
53
+ ],
54
+ },
55
+ {
56
+ text: "Agent Setup",
57
+ items: [
58
+ { text: "Overview", link: "/agent-setup/" },
59
+ { text: "Claude Code", link: "/agent-setup/claude-code" },
60
+ { text: "Codex", link: "/agent-setup/codex" },
61
+ { text: "Gemini CLI", link: "/agent-setup/gemini-cli" },
62
+ { text: "Custom Agents", link: "/agent-setup/custom-agents" },
63
+ ],
64
+ },
65
+ {
66
+ text: "Usage",
67
+ items: [
68
+ { text: "Basic Usage", link: "/usage/" },
69
+ { text: "Note Mentions", link: "/usage/mentions" },
70
+ { text: "Sending Images and Files", link: "/usage/sending-images" },
71
+ { text: "Slash Commands", link: "/usage/slash-commands" },
72
+ { text: "Mode Selection", link: "/usage/mode-selection" },
73
+ { text: "Model Selection", link: "/usage/model-selection" },
74
+ { text: "Session History", link: "/usage/session-history" },
75
+ { text: "Multi-Session Chat", link: "/usage/multi-session" },
76
+ { text: "Floating Chat", link: "/usage/floating-chat" },
77
+ { text: "Editing", link: "/usage/editing" },
78
+ { text: "Chat Export", link: "/usage/chat-export" },
79
+ { text: "Commands & Hotkeys", link: "/usage/commands" },
80
+ { text: "Context Files", link: "/usage/context-files" },
81
+ { text: "MCP Tools", link: "/usage/mcp-tools" },
82
+ ],
83
+ },
84
+ {
85
+ text: "Help",
86
+ items: [
87
+ { text: "FAQ", link: "/help/faq" },
88
+ { text: "Troubleshooting", link: "/help/troubleshooting" },
89
+ ],
90
+ },
91
+ {
92
+ text: "Reference",
93
+ items: [
94
+ { text: "ACP Protocol Support", link: "/reference/acp-support" },
95
+ ],
96
+ },
97
+ {
98
+ text: "Announcements",
99
+ items: [
100
+ {
101
+ text: "Gemini CLI Discontinuation",
102
+ link: "/announcements/gemini-cli-deprecation",
103
+ },
104
+ ],
105
+ },
106
+ ],
107
+
108
+ socialLinks: [
109
+ {
110
+ icon: "github",
111
+ link: "https://github.com/RAIT-09/obsidian-agent-client",
112
+ },
113
+ ],
114
+
115
+ footer: {
116
+ message: "Released under the Apache 2.0 License.",
117
+ copyright: "Copyright © 2025-present RAIT-09",
118
+ },
119
+
120
+ search: {
121
+ provider: "local",
122
+ },
123
+ },
124
+ });