Skip to content

Bring AI agents into Obsidian via Agent Client Protocol (ACP), such as Claude Code, Codex and Gemini CLI.

License

Notifications You must be signed in to change notification settings

RAIT-09/obsidian-agent-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

529 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Agent Client Plugin for Obsidian

GitHub Downloads License GitHub release GitHub last commit

日本語はこちら

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.

obsidian-agent-client-demo.mp4

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
  • 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

Installation

Via BRAT (Recommended)

  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 @zed-industries/claude-code-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-code-acp
    
    where.exe node   # Windows
    where.exe claude-code-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-code-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

About

Bring AI agents into Obsidian via Agent Client Protocol (ACP), such as Claude Code, Codex and Gemini CLI.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors 9