An Obsidian plugin that embeds Claude Code/Codex as an AI collaborator in your vault

Claudian – Obsidian 中的 AI 驱动编码助手

它是什么 – Claudian 是一个 Obsidian 社区插件，可让您直接从 vault 与各种基于 LLM 的编码代理（Claude Code、Codex、Grok Build、OpenCode、Pi、DeepSeek Harness 等）对话。vault 会成为代理的工作目录，因此模型可以读取、写入、搜索文件、运行 shell 命令，并执行多步骤工作流。

主要功能

功能	您获得的功能
内联编辑	选择文本（或将光标置于该处）并按热键，让代理就地编辑笔记，并提供逐字差异预览。
Zen 模式	聊天 UI 会折叠为笔记底部的紧凑编辑器，让您专注于写作。
斜杠命令与技能	输入 `/` 或 `$` 以插入可重复使用的提示模板（技能），这些模板可限定于 vault 或用户。
@提及	在提示中引用其他 vault 文件、文件夹或先前的 Claudian 会话。
侧边聊天 (`/side` 或 `/btw`)	打开临时侧边对话，用于实验，而不干扰主聊天。
MCP 服务器	通过每个提供商的原生“Managed Client Protocol”配置连接外部工具。
标签页与会话管理器	多个聊天标签页、单窗格或双窗格布局，以及持久会话管理。
协作	一个单独的插件（Claudian Collab）添加实时多人编辑功能。

支持的代理（提供商）

Claude Code (Anthropic)
Codex (OpenAI)
Grok Build (xAI)
OpenCode (v2，v1 已于 2026 年 10 月弃用)
Pi (Earendil Works)
DeepSeek Harness

您需要您想使用之提供商的相应 CLI 或 API 订阅。

安装

从 Obsidian – 设置 → 社区插件 → 浏览 → 搜索“Claudian”→ 安装 → 启用。
从源代码 – 克隆到 <vault>/.obsidian/plugins/claudian，运行 npm install && npm run build，然后在 Obsidian 中启用。

开发模式可通过 npm run dev（监视）或 npm run build（生产构建）使用。

工作原理（高级架构）

src/main.ts – 插件入口点。
core – 与提供商无关的执行引擎、进程处理、提示编码和工具抽象。
providers/* – 每个 LLM 服务（Claude、Codex 等）的适配器，处理 CLI 检测、模型发现和历史记录。
features/* – UI 组件：聊天侧边栏、内联编辑对话框、设置 UI 等。
shared 与 utils – 可重复使用的 UI 组件和通用辅助函数。

隐私与数据使用

发送给提供商：您的提示、任何附加的文件/图像，以及工具调用结果。目的地（Anthropic、OpenAI 等）可依提供商设置。
无遥测：Claudian 不会发送后台使用数据。网络流量仅在您明确调用提供商或 MCP 端点时发生。

常见故障排除步骤

找不到 CLI – 确保提供商的 CLI 位于系统 PATH 中（或在设置 → Claudian → 提供商中手动设置路径）。
缺少模型 – 更新提供商 CLI，然后在提供商的模型列表下单击发现。
身份验证失败 – 环境变量（例如 ANTHROPIC_API_KEY）可以覆盖 CLI 凭据；请在插件的环境设置中清除或覆盖它们。
Node / npm 路径不匹配 – 确保 CLI 使用的 Node 二进制文件可从 GUI 应用程序的环境中访问（将其目录添加到共享 PATH）。

获取帮助 / 贡献

在 GitHub 仓库上开启 issue，以报告错误或功能请求。
欢迎提交 pull request；请参阅 CONTRIBUTING.md。不接受新的提供商 – 它们必须由维护者在上游添加。

许可与赞助

MIT 许可。
由 Moonshot AI (Kimi) 和贝壳找房 (BEIKE) 赞助。促销链接不收取联盟佣金。

简而言之： Claudian 将您的 Obsidian vault 变成一个交互式编码游乐场，由最新的 LLM 编码代理提供支持，具有全功能的聊天 UI、内联编辑和可扩展的工具集成，同时保持数据流透明且无遥测。

YishenTu/claudian