obsidian-agent-client  by RAIT-09

Integrate AI agents into Obsidian workflows

Created 3 months ago
330 stars

Top 83.1% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

This plugin integrates AI agents like Claude Code, Codex, and Gemini CLI directly into Obsidian, enabling users to interact with AI assistants within their note-taking environment. It targets Obsidian power users and developers seeking to streamline workflows by bringing AI capabilities, such as code generation and analysis, directly into their research and writing process. The primary benefit is enhanced productivity through seamless AI integration.

How It Works

The plugin leverages the Agent Client Protocol (ACP) by Zed, acting as a bridge between Obsidian and AI agent backends. It provides a dedicated side panel for chatting with configured agents, supporting context passing (active note, specific references) and agent execution of terminal commands.

Quick Start & Requirements

Installation is via BRAT (add repo URL: https://github.com/RAIT-09/obsidian-agent-client) or manual file placement. Prerequisites include Node.js and ACP client packages (e.g., @zed-industries/claude-code-acp) installed via npm. Configuration requires setting absolute paths for Node.js and each agent client in Obsidian settings. WSL Mode is recommended for Windows.

Highlighted Details

  • Direct chat interface for AI coding agents within an Obsidian side panel.
  • Support for image attachments, note mentions (@notename), and slash commands (/).
  • Multi-agent support with model/mode switching (e.g., Sonnet, Haiku, Plan Mode).
  • Agent execution of terminal commands with results returned in chat.
  • Fine-grained permission management.

Maintenance & Community

Roadmap items include Edit Tracking, Chat History Access, and Multi-Instance Support. Feature requests are handled via GitHub issues. No explicit community channels are listed.

Licensing & Compatibility

Licensed under the Apache License 2.0, which is permissive for commercial use and integration into closed-source applications.

Limitations & Caveats

Key features like Edit Tracking and Multi-Instance Support are under development. Setup requires manual installation and configuration of external dependencies and paths, potentially posing an initial hurdle. Native Windows execution may have compatibility issues, with WSL Mode recommended.

Health Check
Last Commit

18 hours ago

Responsiveness

Inactive

Pull Requests (30d)
16
Issues (30d)
13
Star History
217 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.