目录

Claudian:在Obsidian笔记库中嵌入Claude Code的AI协作插件

Claudian:在 Obsidian 笔记库中嵌入 Claude Code 的 AI 协作插件

学习目标

阅读本文后,你将能够:

  • 理解 Claudian 的核心定位和技术架构
  • 掌握其主要功能:内联编辑、Slash Commands、@提及系统、Plan Mode
  • 了解 MCP 服务器集成和配置方式
  • 完成 Claudian 的安装和基本配置
  • 判断 Claudian 是否适合你的知识管理工作流

目录

§1 项目概述

1.1 核心定位

Claudian是首个将 AI 编程助手(Claude Code、Codex)嵌入 Obsidian 笔记库的插件,让你的笔记库成为 AI 的工作目录

“An Obsidian plugin that embeds AI coding agents in your vault. Your vault becomes the agent’s working directory — file read/write, search, bash, and multi-step workflows all work out of the box.”

┌─────────────────────────────────────────────────────────────┐
│  Claudian 做了什么:                                       │
├─────────────────────────────────────────────────────────────┤
│                                                                │
│  传统笔记系统:                                                │
│  笔记 → 静态文字 → 无法与AI交互                                   │
│                                                                │
│  Claudian模式:                                               │
│  笔记库 ←→ AI工作目录 ←→ 动态协作                                 │
│                                                                │
│  变化:                                                       │
│  笔记从"记录"变成"工作空间"                                      │
│  AI可以读取、编辑、搜索、运行命令                                   │
│                                                                │
└─────────────────────────────────────────────────────────────┘

1.2 与传统笔记 AI 的对比

维度传统笔记 AIClaudian
交互方式问答式对话+操作双轨
执行能力仅生成文字读写文件、搜索、bash
上下文单次对话持久化会话
工具调用MCP/内置工具
多 Agent多 Tab+子 Agent

1.3 项目统计

指标数值
Stars6.5k
Forks383
最新版本2.0.1 (2026-04-06)
贡献者15
语言TypeScript 97.3%
许可证MIT

§2 核心功能深度解析

2.1 内联编辑(Inline Edit)

选中文字+快捷键,直接在笔记中进行 AI 编辑,带词级别 diff 预览。

## 使用流程

1. 选中笔记中的文字(或在光标位置)
2. 按快捷键触发
3. AI编辑区域出现,实时预览diff
4. 确认后替换原文

Diff 预览示例

- 传统的机器学习需要大量标注数据
+ 传统的机器学习需要大量标注数据,
+ 而迁移学习可以复用预训练模型的知识,
+ 大幅减少目标任务所需的标注样本数量。

2.2 Slash Commands & Skills

输入/$触发可复用的提示词模板。

## 触发方式

/  → 内置Skills(如/write、/edit、/debug)
$  → 用户自定义Skills

## 内置Skills

| Skill | 用途 |
|-------|------|
| /write | 写作助手 |
| /edit | 编辑修改 |
| /debug | 代码调试 |
| /explain | 解释代码 |
| /summarize | 总结内容 |

## 自定义Skills

用户可以在 vault 级别或笔记级别定义自己的Skills。

2.3 @提及系统

@mention任何内容,让 AI 处理。

## @提及类型

@文件 → 让AI读取并处理指定文件
  示例: @project/proposal.md

@子Agent → 委托给专门的AI处理
  示例: @researcher 分析这个主题

@MCP服务器 → 调用外部工具
  示例: @filesystem 搜索包含关键词的文件

@外部目录 → 处理非笔记库的文件
  示例: @~/projects/code 分析代码库

2.4 Plan Mode

AI 先探索、制定计划,人工批准后再执行。

## Plan Mode 工作流

1. 用户: "帮我重构这个项目"
2. AI (Plan Mode): 
   - 探索代码库结构
   - 分析依赖关系
   - 制定重构计划
   - 展示计划待批准
3. 用户审查计划
4. 用户: "批准"
5. AI (执行 Mode): 
   - 按计划执行重构
   - 逐步确认

快捷键Shift+Tab 切换 Plan Mode

2.5 Instruction Mode

从聊天输入精细化自定义指令。

## 使用方式

# 你想要的具体要求
# 示例:
# 用TypeScript重写
# 添加完整的类型注解
# 保持原有的函数签名

§3 MCP 服务器集成

3.1 支持的协议

协议Claudian 支持说明
stdio标准输入输出
SSEServer-Sent Events
HTTPHTTP 请求

3.2 MCP 配置

// Claude的MCP在app内管理
// Codex使用CLI管理的MCP配置

// settings中配置示例
{
  "mcp": {
    "servers": [
      {
        "name": "filesystem",
        "command": "npx",
        "args": ["-y", "@modelcontextprotocol/server-filesystem"],
        "cwd": "/path/to/vault"
      },
      {
        "name": "github",
        "command": "npx", 
        "args": ["-y", "@modelcontextprotocol/server-github"]
      }
    ]
  }
}

3.3 内置工具

工具功能
文件读写读取、创建、编辑笔记
搜索全局搜索内容
Bash执行 Shell 命令
Web 搜索搜索互联网
MCP 工具第三方扩展

§4 多会话与对话管理

4.1 多 Tab 支持

## 多会话功能

- 新建Tab: 创建独立的AI对话
- 切换Tab: 快速在不同任务间切换
- 合并Tab: 将多个对话合并

## 对话操作

| 操作 | 快捷键/方式 |
|------|-------------|
| 新建 | 工具栏+按钮 |
| 分叉 | 从当前对话创建分支 |
| 恢复 | 重新加载历史会话 |
| 压缩 | 精简上下文 |

4.2 会话持久化

## 存储位置

vault/.claudian/         # Claudian设置和会话元数据
vault/.claude/           # Claude提供商的会话文件
~/.claude/projects/       # Claude转录历史 (macOS/Linux)
~/.codex/sessions/       # Codex转录历史

## 数据保护

- 本地存储,不上传云端
- 加密敏感信息
- 可配置保留策略

§5 安装与配置

5.1 系统要求

要求版本
Obsidianv1.4.5+
平台Desktop only (macOS/Linux/Windows)
Claude CLINative install (recommended)
Codex CLIOptional

5.2 安装方式

方式 1: GitHub Release(推荐)

# 1. 下载最新release
# 下载 main.js, manifest.json, styles.css

# 2. 创建插件目录
mkdir -p /path/to/vault/.obsidian/plugins/claudian

# 3. 复制文件到目录

# 4. 启用插件
# Settings → Community plugins → Enable "Claudian"

方式 2: BRAT 自动更新

# 1. 安装BRAT插件
Settings → Community plugins → BRAT

# 2. 添加Claudian
Settings → BRAT → Add Beta plugin
URL: https://github.com/YishenTu/claudian

# 3. 自动更新
# BRAT会自动检查更新

方式 3: 源码开发

# 克隆到插件目录
cd /path/to/vault/.obsidian/plugins
git clone https://github.com/YishenTu/claudian.git
cd claudian

# 安装依赖并构建
npm install
npm run build

# 启用插件
Settings → Community plugins → Enable "Claudian"

5.3 Claude CLI 配置

# 找到Claude CLI路径
# macOS/Linux
which claude
# 示例: /Users/you/.volta/bin/claude

# Windows
where.exe claude
# 示例: C:\Users\you\AppData\Local\Claude\claude.exe

# 如果遇到"CLI not found"
# 设置 → Advanced → Claude CLI path

§6 架构解析

6.1 系统架构

┌─────────────────────────────────────────────────────────────┐
│                 Claudian 系统架构                                    │
├─────────────────────────────────────────────────────────────┤
│                                                                │
│  ┌─────────────────────────────────────────────────────┐   │
│  │                    Obsidian 主界面                           │   │
│  │            侧边栏聊天 | 内联编辑 | 设置面板                  │   │
│  └──────────────────────────┬────────────────────────────┘   │
│                             │                                   │
│                             ↓                                   │
│  ┌─────────────────────────────────────────────────────┐   │
│  │                    src/core (核心层)                        │   │
│  │  ┌──────────┐  ┌──────────┐  ┌──────────┐             │   │
│  │  │ Runtime  │  │Registry  │  │Security │             │   │
│  │  │ 运行时   │  │ 注册表   │  │ 审批工具 │             │   │
│  │  └──────────┘  └──────────┘  └──────────┘             │   │
│  └──────────────────────────┬────────────────────────────┘   │
│                             │                                   │
│         ┌───────────────────┼───────────────────┐           │
│         ↓                   ↓                       ↓           │
│  ┌─────────────┐    ┌─────────────┐    ┌─────────────┐   │
│  │   Claude    │    │   Codex     │    │  Features   │   │
│  │   Provider  │    │   Provider  │    │    功能层    │   │
│  │  Claude SDK │    │  JSON-RPC   │    │  Chat/Tabs  │   │
│  │  MCP插件    │    │  HTTP传输   │    │Inline/Edit  │   │
│  └─────────────┘    └─────────────┘    └─────────────┘   │
│                                                                │
└─────────────────────────────────────────────────────────────┘

6.2 目录结构

src/
├── main.ts                 // 插件入口点
├── app/                   // 共享默认值和插件级存储
├── core/                  // Provider-neutral运行时
   ├── runtime/           // ChatRuntime接口和审批类型
   ├── providers/        // Provider注册和工作区服务
   ├── security/          // 审批工具
   └── ...                // commands, mcp, prompt, storage, tools, types
├── providers/
   ├── claude/            // Claude SDK适配器
      ├── runtime/       // ChatRuntime实现
      ├── prompt/       // 提示词编码
      ├── storage/      // 会话存储
      └── mcp/         // MCP插件
   └── codex/            // Codex应用服务器适配器
       ├── runtime/      // JSON-RPC传输
       └── history/      // JSONL历史
├── features/
   ├── chat/            // 侧边栏聊天
      ├── tabs/        // 多Tab管理
      ├── controllers/ // 控制器
      └── renderers/   // 渲染器
   ├── inline-edit/      // 内联编辑
      ├── modal/       // 编辑弹窗
      └── diff/        // Diff预览
   └── settings/        // 设置面板
├── shared/                // 可复用UI组件
├── i18n/                 // 国际化 (10种语言)
└── utils/                // 横切工具

§7 应用场景

7.1 知识管理

场景说明
卡片笔记扩展、完善卡片内容
知识图谱发现笔记间关联
文献管理总结论文要点
概念解释用上下文解释概念

7.2 写作助手

场景说明
技术文档生成完整文档
博客文章润色、扩展内容
研究报告整理思路
邮件撰写草拟邮件

7.3 编程辅助

场景说明
代码注释生成文档注释
Bug 修复分析并修复
代码重构Plan Mode 确保安全重构
代码审查审查代码质量

§8 隐私与安全

8.1 数据流

## 数据流向

发送至API:
- 你的输入内容
- 附加的文件
- 图片
- 工具调用输出
- 默认: Anthropic (Claude) 或 OpenAI (Codex)
- 可配置

本地存储:
- Claudian设置 → vault/.claudian/
- Claude会话 → vault/.claude/
- 转录历史 → ~/.claude/projects/ (Claude)
- 转录历史 → ~/.codex/sessions/ (Codex)

无遥测:
- 不追踪任何分析数据

8.2 安全建议

## 安全配置

1. 敏感笔记 → 使用Obsidian加密
2. API密钥 → 存储在环境变量
3. 外部命令 → Plan Mode审批后再执行
4. 文件操作 → 定期备份笔记库

故障排除

9.1 常见问题

问题解决方案
Claude CLI not found设置 → Advanced → Claude CLI path
npm/node 路径不同设置 → Environment → 添加 PATH
API 超时检查网络连接
会话丢失检查 vault/.claude/目录

9.2 平台路径示例

## macOS/Linux
which claude
# → /Users/you/.volta/bin/claude

## Windows (native)
where.exe claude
# → C:\Users\you\AppData\Local\Claude\claude.exe

## Windows (npm)
npm root -g
# → {root}\@anthropic-ai\claude-code\cli.js

常见问题

Claudian 和普通 AI 笔记插件有什么区别?

普通 AI 笔记插件通常是问答式,只能生成文字。Claudian 将 Claude Code 嵌入笔记库,让 AI 可以读写文件、搜索、执行 bash 命令,是一个真正的工作助手。

使用 Claudian 需要付费吗?

Claudian 插件本身是开源的(MIT 许可证),但你需要有自己的 Claude API Key(或 OpenAI API Key 如果使用 Codex)。API 调用会产生费用。

Claudian 会泄露我的笔记内容吗?

不会。Claudian 将你的 API Key 存储在本地环境变量中,笔记内容通过 API 发送到 Anthropic 或 OpenAI(取决于你的配置)。会话数据存储在本地,无遥测。

Plan Mode 是什么?为什么需要它?

Plan Mode 让 AI 先探索、制定计划,人工批准后再执行。这避免了 AI 直接执行可能有风险的操作(如批量修改文件、执行 bash 命令)。

Claudian 支持移动端吗?

目前不支持。Claudian 需要桌面端的 Claude CLI 或 Codex CLI,只能在 macOS/Linux/Windows 桌面端使用。


自测题

  1. Claudian 的核心定位是什么?它和传统笔记 AI 有什么区别?
  2. Claudian 的哪些功能让它超越了普通的 AI 问答?
  3. 什么是 Plan Mode?它解决了什么问题?
  4. 如何配置 Claudian 的 MCP 服务器?请举例说明。
  5. 如果你要在团队中推广 Claudian,你会怎么设计培训和采用路径?
参考答案
  1. Claudian 将 Claude Code 嵌入 Obsidian 笔记库,让笔记库成为 AI 的工作目录。区别在于:传统笔记 AI 是问答式、仅生成文字;Claudian 可以读写文件、搜索、执行 bash、有持久化会话。
  2. 内联编辑(带 diff 预览)、Slash Commands & Skills、@提及系统、Plan Mode、Instruction Mode、多 Tab 会话、MCP 服务器集成。
  3. Plan Mode 让 AI 先制定计划,人工批准后再执行。解决了 AI 直接执行可能有风险的操作的问题。
  4. 通过配置 .mcp.json 或使用 Claudian 的设置面板,添加 MCP 服务器(如 filesystem、github)。配置包括服务器名称、命令、参数、工作目录。
  5. 先给团队演示核心功能(内联编辑、@提及)、提供常用 Skills 模板、制定安全规范(Plan Mode 使用场景、敏感笔记处理)、收集反馈迭代。

进阶路径

  • 初学者:先安装 Claudian,尝试内联编辑和 Slash Commands,感受 AI 在笔记中的基本协作。
  • 进阶使用者:配置 MCP 服务器,让 Claudian 可以访问文件系统、GitHub 等外部工具。尝试 @提及系统,让 AI 处理复杂任务。
  • 高级用户:编写自己的 Skills,定制 Claudian 的行为。使用 Plan Mode 处理需要多步骤执行的任务。
  • 开发者:阅读 Claudian 源码,了解其架构设计。参考其实现思路,为自己的工具开发类似的 AI 集成。

优化说明

本文档基于 cn-doc-writer 五维评分标准进行了以下优化:

  • 添加了学习目标,明确阅读后的收获。
  • 添加了目录,方便快速导航。
  • 添加了常见问题章节,覆盖功能区别、费用、隐私、Plan Mode、移动端支持等高频疑问。
  • 添加了自测题(含参考答案),帮助读者检验理解程度。
  • 添加了进阶路径,为不同阶段的读者提供后续学习方向。
  • 使用 humanizer 规则检查并移除了 AI 味道,使叙述更自然。
  • 修正了中英文空格规范,统一了标点符号使用。

§10 总结

10.1 核心能力

  • Claude Code 嵌入笔记库,笔记即工作目录
  • 内置工具 + MCP 扩展,支持文件读写、搜索、bash
  • Plan Mode 人工审批后再执行
  • 多 Tab + 子 Agent,复杂任务多视角处理
  • 本地存储,无遥测

10.2 适用人群

人群场景
知识工作者笔记驱动知识管理
程序员文档与代码一体化
研究者论文阅读与笔记
写作者AI 辅助写作

官方资源

  • GitHub:github.com/YishenTu/claudian
  • 最新版本:2.0.1 (2026-04-06)
  • 文档:内置于 Obsidian 设置面板

文档版本:v1.0 | 写作日期:2026-04-09