explaingit

yishentu/claudian

11,129TypeScriptAudience · developerComplexity · 3/5LicenseSetup · moderate

TLDR

An Obsidian plugin that embeds AI coding agents like Claude Code and Codex directly inside your note-taking app, letting them read and edit notes using a chat sidebar.

Mindmap

mindmap
  root((repo))
    What it does
      AI chat in Obsidian
      Inline note editing
      Agent task running
    Tech stack
      TypeScript
      Obsidian
      Claude Code
      MCP
    Features
      Slash commands
      File mentions
      Plan mode
      Change preview
    Requirements
      Obsidian desktop
      Claude Code CLI
      API subscription
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Chat with an AI coding agent inside Obsidian to research, plan, and write content without switching to a terminal.

USE CASE 2

Select text in a note and trigger an AI inline rewrite with a keyboard shortcut, previewing changes before accepting.

USE CASE 3

Use slash commands to run saved prompt templates repeatedly across different notes or sections.

USE CASE 4

Connect external tools to the AI agent via MCP to pull data into your Obsidian vault automatically.

Tech stack

TypeScriptObsidian

Getting it running

Difficulty · moderate Time to first run · 30min

Requires Claude Code CLI already installed on your computer and an active Claude subscription or compatible API provider.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

In plain English

Claudian is a plugin for Obsidian, a popular note-taking application that stores notes as plain text files on your computer. The plugin embeds AI coding agents directly inside Obsidian so you can interact with them through a chat sidebar without switching to a separate terminal or application. The plugin connects to AI agents including Claude Code (from Anthropic), Codex (from OpenAI), and Opencode. Your Obsidian vault, which is the folder containing all your notes, becomes the working directory for the agent. That means the agent can read files, write files, run searches, and execute multi-step tasks directly within your vault using the same tools these agents use in a coding environment. Features include an inline editing mode where you select text in a note and use a keyboard shortcut to have the agent rewrite it, with a word-level preview of the changes before you accept them. You can type slash commands to reuse saved prompt templates, use @ mentions to pull in specific files or connect external tools via the Model Context Protocol (MCP), and enable a plan mode where the agent describes its intended approach before making any changes. Installation requires having the Claude Code CLI already installed on your computer and an active Claude subscription or compatible API provider. The plugin works on macOS, Linux, and Windows desktop. It can be installed by downloading release files from GitHub and placing them in Obsidian's plugin folder, or through a community tool called BRAT that handles automatic updates. No telemetry is collected beyond what your chosen API provider receives from your requests. Conversation history is stored locally in standard locations on your computer. The project is released under the MIT License.

Copy-paste prompts

Prompt 1
I have Obsidian and Claude Code installed. Walk me through installing the Claudian plugin and getting the AI agent chat sidebar working in my vault.
Prompt 2
I want to use Claudian's inline edit feature to rewrite a section of my meeting notes. How do I select the text, trigger the AI edit, and review the word-level diff before accepting?
Prompt 3
How do I create a slash command template in Claudian so I can run the same prompt against any note with a single keystroke?
Prompt 4
I want to use MCP with Claudian to connect an external API as a tool the AI agent can call from inside Obsidian. What is the setup process?
Open on GitHub → Explain another repo

← yishentu on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.