obsidian-plugin/rait-09_obsidian-agent-client
1
0
Fork 0
mirror of https://github.com/rait-09/obsidian-agent-client.git synced 2026-07-22 06:43:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
1095 commits 116 branches 84 tags 14 MiB
TypeScript 92.5%
CSS 7%
JavaScript 0.3%
Shell 0.2%
Find a file
RAIT-09 f4e23f2c69 chore(security): reject __proto__/constructor keys in config-option persistence
2026-06-19 15:43:41 +09:00
.claude fix: remove zero-width Unicode characters from skill file 2026-05-14 23:24:53 +09:00
.github fix: update actions versions in CI workflow 2026-05-19 23:44:37 +09:00
.vscode Enable Prettier formatting for CSS 2025-10-29 20:38:23 +09:00
.zed Enable Prettier formatting for CSS 2025-10-29 20:38:23 +09:00
docs Merge branch 'master' into dev 2026-05-31 01:11:15 +09:00
src chore(security): reject __proto__/constructor keys in config-option persistence 2026-06-19 15:43:41 +09:00
.editorconfig Initial commit 2025-09-18 18:47:14 +09:00
.gitignore chore: add plan/ to .gitignore 2026-03-22 01:56:14 +09:00
.npmrc Initial commit 2025-09-18 18:47:14 +09:00
.prettierignore Add VitePress documentation site for Agent Client 2025-12-14 01:53:46 +09:00
.prettierrc Add prettier and editor settings 2025-10-29 20:26:01 +09:00
AGENTS.md docs: update AGENTS.md to reflect current architecture after refactoring 2026-04-03 17:37:52 +09:00
ARCHITECTURE.md docs: update ARCHITECTURE.md to reflect current architecture after refactoring 2026-04-03 17:41:36 +09:00
CLAUDE.md chore: migrate claude-agent-acp references from @zed-industries to @agentclientprotocol 2026-03-26 20:48:40 +09:00
CONTRIBUTING.md docs: update CONTRIBUTING.md architecture section and naming conventions 2026-04-03 17:43:45 +09:00
esbuild.config.mjs Replace builtin-modules with node:module builtinModules 2025-12-14 19:34:37 +09:00
eslint.config.mjs Add VitePress documentation site for Agent Client 2025-12-14 01:53:46 +09:00
GEMINI.md chore: migrate claude-agent-acp references from @zed-industries to @agentclientprotocol 2026-03-26 20:48:40 +09:00
LICENSE chore(license): update copyright year to 2025-2026 and add NOTICE file 2026-06-06 01:55:16 +09:00
manifest.json Update version to 0.11.0-preview.1 2026-06-05 23:35:58 +09:00
NOTICE chore(license): update copyright year to 2025-2026 and add NOTICE file 2026-06-06 01:55:16 +09:00
package-lock.json chore: regenerate package-lock.json 2026-06-05 23:45:27 +09:00
package.json Update version to 0.11.0-preview.1 2026-06-05 23:35:58 +09:00
README.ja.md fix: add target blank to Add to Obsidian badge link 2026-05-15 20:58:51 +09:00
README.md fix: add target blank to Add to Obsidian badge link 2026-05-15 20:58:51 +09:00
styles.css fix(markdown): make wide display math horizontally scrollable 2026-06-16 23:15:45 +09:00
tsconfig.json Move source files into src 2025-09-24 17:42:57 +09:00
version-bump.mjs Use double quotes and import process in version-bump.mjs 2025-12-14 19:35:46 +09:00
versions.json Initial commit 2025-09-18 18:47:14 +09:00

README.md

Agent Client Plugin for Obsidian

GitHub Downloads License GitHub release GitHub last commit GitHub Discussions

日本語はこちら

Add to Obsidian

Buy Me A Coffee

Bring AI agents (Claude Code, Codex, Gemini CLI) directly into Obsidian. Chat with your AI assistant right from your vault.

Built on Agent Client Protocol (ACP) by Zed.

https://github.com/user-attachments/assets/1c538349-b3fb-44dd-a163-7331cbca7824

Features

  • Note Mentions: Reference your notes with @notename syntax
  • Image Attachments: Paste or drag-and-drop images into the chat
  • Slash Commands: Use / commands provided by your agent
  • Multi-Agent Support: Switch between Claude Code, Codex, Gemini CLI, and custom agents
  • Multi-Session: Run multiple agents simultaneously in separate views
  • Floating Chat: A persistent, collapsible chat window for quick access
  • Mode & Model Switching: Change AI models and agent modes from the chat
  • Session History: Resume or fork previous conversations
  • Chat Export: Save conversations as Markdown notes
  • Terminal Integration: Let agents execute commands and return results
  • MCP Support: Agents use their configured MCP servers — no extra setup needed in the plugin

Installation

From Community Plugins (Recommended)

  1. Open Settings → Community Plugins → Browse
  2. Search for "Agent Client"
  3. Click Install, then Enable

Via BRAT (Pre-release Versions)

To try pre-release versions before they are published to Community Plugins:

  1. Install the BRAT plugin
  2. Go to Settings → BRAT → Add Beta Plugin
  3. Paste: https://github.com/RAIT-09/obsidian-agent-client
  4. Enable Agent Client from the plugin list

Manual Installation

  1. Download main.js, manifest.json, styles.css from Releases
  2. Place them in VaultFolder/.obsidian/plugins/agent-client/
  3. Enable the plugin in Settings → Community Plugins

Quick Start

Open a terminal (Terminal on macOS/Linux, PowerShell on Windows) and run the following commands.

  1. Install an agent and its ACP adapter (e.g., Claude Code):

    curl -fsSL https://claude.ai/install.sh | bash   # Install Claude Code
npm install -g @agentclientprotocol/claude-agent-acp   # Install ACP adapter

  2. Login (skip if using API key):

    claude

    Follow the prompts to authenticate with your Anthropic account.

  3. Find the paths:

    which node   # macOS/Linux
which claude-agent-acp

where.exe node   # Windows
where.exe claude-agent-acp

  4. Configure in Settings → Agent Client:

    • Node.js path: e.g., /usr/local/bin/node
    • Built-in agents → Claude Code → Path: e.g., /usr/local/bin/claude-agent-acp (not claude)
    • API key: Add your key, or leave empty if logged in via CLI

  5. Start chatting: Click the robot icon in the ribbon

Setup Guides

Full Documentation

Development

npm install
npm run dev

For production builds:

npm run build

License

Apache License 2.0 - see LICENSE for details.

Star History

Star History Chart