claudian  by YishenTu

Obsidian plugin for agentic Claude interaction

Created 1 month ago
633 stars

Top 52.4% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

Claudian integrates the Claude Agent SDK into Obsidian, transforming your vault into an AI agent's workspace. It empowers users with file read/write, bash command execution, and multi-step workflow capabilities directly within their notes, enhancing productivity for knowledge workers and developers.

How It Works

The plugin leverages the Claude Agent SDK to provide agentic functionalities, treating the Obsidian vault as the agent's operational directory. It offers deep context awareness, automatically incorporating the focused note, @-mentioned files, and editor selections. Novel features include vision support for image analysis, inline text editing with word-level diff previews, and extensibility via slash commands, custom skills, and Model Context Protocol (MCP) servers for integrating external tools.

Quick Start & Requirements

  • Installation: Recommended: Download release assets (main.js, manifest.json, styles.css) and place them in vault/.obsidian/plugins/claudian/. Development: git clone the repository, then run npm install and npm run build.
  • Prerequisites: Claude Code CLI installed, Obsidian v1.8.9+, Claude subscription/API key or compatible custom model provider, and a desktop OS (macOS, Linux, Windows).
  • Links: No direct links to quick-start guides or demos are provided in the README.

Highlighted Details

  • Full Agentic Capabilities: Seamlessly read, write, edit files, and execute bash commands within the Obsidian vault.
  • Contextual Awareness: Automatically attaches the focused note, supports @-file mentions, excludes notes by tag, and includes editor selections.
  • Vision Support: Analyze images via drag-and-drop, paste, or file path.
  • Inline Editing: Edit selected text or insert content at the cursor with word-level diff preview.
  • Extensibility: Features slash commands for prompt templates, skills for reusable modules, and MCP support for external tool integration.
  • Robust Security: Offers permission modes (YOLO/Safe), a command blocklist, vault confinement, and controlled export paths.

Maintenance & Community

No specific details regarding contributors, sponsorships, or community channels (e.g., Discord, Slack) are present in the provided README content.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: The MIT license permits commercial use and integration with closed-source projects without significant restrictions.

Limitations & Caveats

The "Plan Mode" feature is noted as having limitations and technical debt due to SDK constraints, with potential simplification planned. The plugin is desktop-only and requires the Claude Code CLI to be installed and accessible.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
39
Issues (30d)
39
Star History
645 stars in the last 30 days

Explore Similar Projects

Starred by Dax Dax(Core Contributor to opencode, SST) and Adam Elmore Adam Elmore(Cofounder of StatMuse; Contributor to opencode).

oh-my-opencode by code-yeongyu

95.9%
13k
LLM agent orchestration for enhanced IDE workflows
Created 1 month ago
Updated 18 hours ago
Feedback? Help us improve.