📋 核心要点
- Claudian 是 Obsidian 社区插件,把 Claude Code、Codex、Grok、OpenCode、Pi 等 AI 编程代理嵌入 vault
- vault 即代理的工作目录:文件读写、搜索、bash、多步骤工作流开箱即用
- 支持内联编辑、斜杠命令 / Skills、@提及、Plan 模式、MCP 服务器、多标签页会话
- 桌面端专属(macOS / Linux / Windows),要求 Obsidian v1.7.2+ 与至少一个代理 CLI
- MIT 协议,获 Kimi(月之暗面)与贝壳找房(BEIKE)赞助,GitHub 约 14.8k stars
相关:obsidian-skills 使用指南
项目概况
Claudian(github.com/yishentu/claudian)是一款 Obsidian 插件,把 AI 编程代理(Claude Code、Codex、Grok、Opencode、Pi,以及更多待支持)嵌入你的 vault。安装后,vault 直接成为代理的工作目录——文件读写、搜索、bash、多步骤工作流开箱即用。
| 指标 | 数值 |
|---|---|
| Stars | 14.8k |
| Forks | 964 |
| Watching | 41 |
| Open Issues | 39 |
| Open PRs | 34 |
| Commits | 811 |
| License | MIT |
Topics:claude-code、codex、ide、obsidian、obsidian-plugin、productivity。
核心功能
- 聊天侧边栏:通过丝带图标或命令面板打开,交互方式与熟悉的 Claude Code、Codex、Grok、Opencode、Pi 一致——与代理对话,它就能读、写、编辑、搜索 vault 里的文件。
- 内联编辑(Inline Edit):选中文本或从光标处开始 + 快捷键,直接在笔记内编辑,带词级 diff 预览。
- 斜杠命令与 Skills:输入
/或$调用可复用的提示词模板或 Skills,支持用户级与 vault 级作用域。 - @提及:输入
@提及任何想让代理处理的对象,包括 vault 文件、子代理(subagents)、外部目录文件。 - Plan 模式:
Shift+Tab切换。代理先探索、设计,再实施,实施方案需经审批。 - 指令模式(
#):从聊天输入框添加精化的自定义指令。 - MCP 服务器:通过各代理的 CLI 原生管理的 MCP 配置接入外部工具。
- 标签页与会话管理:单面板模式下多标签页,或双栏模式下聊天旁带持久化会话管理器。
环境要求
至少满足以下之一:
- 一个代理 CLI:Claude Code CLI、Codex CLI、Grok Build、OpenCode、Pi;
- 一个兼容的订阅或 API 服务商,如 OpenRouter、Kimi、GLM、DeepSeek;
- Obsidian v1.7.2+;
- 仅桌面端(macOS / Linux / Windows)。
安装方式
从 Obsidian 社区插件安装(推荐)
- Obsidian → 设置 → 第三方插件 → 浏览;
- 搜索 “Claudian” → 安装;
- 启用插件。
从源码安装(开发)
❯Bash
cd /path/to/vault/.obsidian/plugins
git clone https://github.com/YishenTu/claudian.git
cd claudian
npm install
npm run build开发时可用 npm run dev(监听模式)与 npm run build(生产构建)。
隐私与数据
- 发送到 API 的内容:你的输入、附加文件、图片、工具调用输出。视所选服务商而定,数据发往 Anthropic(Claude)、OpenAI(Codex)、xAI(Grok),或 OpenCode / Pi 里配置的服务商。目的地可通过服务商设置与环境变量配置。
- 无遥测、无后台活动:Claudian 不运行遥测信标;UI 轮询定时器只读取本地 Obsidian/编辑器选中状态;网络活动仅限于显式的服务商运行时工作、已配置的 MCP 端点,以及回答问题所需的 SDK/CLI 调用。
架构
❯Text
src/
├── main.ts # 插件入口
├── app/ # 共享默认值与插件级存储
├── core/ # 服务商无关的运行时、注册表与类型契约
│ ├── runtime/ # ChatRuntime 接口与审批类型
│ ├── providers/ # 服务商注册表与工作区服务
│ ├── auxiliary/ # 服务商共享辅助服务
│ ├── bootstrap/ # 插件启动装配
│ ├── security/ # 审批工具
│ └── ... # commands, mcp, prompt, storage, tools, types
├── providers/ # 各服务商适配器
│ ├── claude/ # Claude SDK 适配、prompt 编码、存储、MCP、插件
│ ├── codex/ # Codex app-server 适配、JSON-RPC 传输、JSONL 历史
│ ├── grok/ # Grok Build ACP 适配、原生历史、模型与工具
│ ├── opencode/ # Opencode 适配
│ ├── pi/ # Pi RPC 适配、模型发现、JSONL 历史
│ └── acp/ # Agent Client Protocol 共享传输
├── features/
│ ├── chat/ # 侧边栏聊天:标签页、控制器、渲染器
│ ├── inline-edit/ # 内联编辑模态框与服务商编辑服务
│ └── settings/ # 设置外壳(含服务商标签页)
├── shared/ # 可复用 UI 组件与模态框
├── i18n/ # 国际化(10 种语言)
├── types/ # 共享环境类型
├── utils/ # 跨切面工具
└── style/ # 模块化 CSS赞助与许可
- Kimi(月之暗面 Moonshot AI):作为 “Open Source Friend” 赞助 Claudian。Kimi K3 拥有 2.8T 参数、原生视觉能力与 100 万 token 上下文窗口。新用户首次成功充值可获赠 10% 的 API 额度(活动截至 2026-09-30)。
- 贝壳找房(Ke Holdings / BEIKE):由 BEIKE 与 MOMA 团队赞助。
- 有意支持可联系:
tysk01213@gmail.com。 - 协议:MIT License。