克劳迪安

克劳迪安是一款 Obsidian 插件，可将 AI 编码代理（Claude Code、Codex 等未来还将支持更多）嵌入到您的笔记库中。您的笔记库将成为代理的工作目录——文件读写、搜索、Bash 命令执行以及多步骤工作流均可开箱即用。

功能与使用方法

通过功能区图标或命令面板打开聊天侧边栏。选中文本并使用快捷键即可进行内联编辑。一切操作方式与 Claude Code 或 Codex 相同——与代理对话，它就能读取、写入、编辑和搜索您笔记库中的文件。

内联编辑 — 选择文本或从光标位置开始，配合快捷键即可在笔记中直接编辑，并提供逐词级别的差异预览。

斜杠命令与技能 — 输入 / 或 $ 可调用用户级或笔记库级的可复用提示模板或技能。

@提及 — 输入 @ 即可提及代理需要处理的任何内容，包括笔记库中的文件、子代理、MCP 服务器，或是外部目录中的文件。

计划模式 — 通过 Shift+Tab 切换。代理会在实施前先探索并设计，随后呈现一份计划供您审批。

指令模式 (#) — 通过聊天输入框添加更精细的自定义指令。

MCP 服务器 — 通过模型上下文协议（stdio、SSE、HTTP）连接外部工具。Claude 在应用内管理笔记库的 MCP；而 Codex 则使用其 CLI 管理的 MCP 配置。

多标签与对话 — 支持多个聊天标签、对话历史、分支、恢复及紧凑模式。

系统要求

• Claude 提供者：已安装 Claude Code CLI（建议原生安装）。需拥有 Claude 订阅或 API，或使用兼容的提供商（如 Openrouter、Kimi 等）。
• Codex 提供者（可选）：已安装 Codex CLI。
• Obsidian v1.4.5+
• 仅限桌面版（macOS、Linux、Windows）

安装方法

从 GitHub 发布页安装（推荐）

1. 从 最新发布 下载 main.js、manifest.json 和 styles.css。
2. 在您的笔记库插件文件夹中创建名为 claudian 的文件夹：

   /path/to/vault/.obsidian/plugins/claudian/
   

3. 将下载的文件复制到 claudian 文件夹中。
4. 在 Obsidian 中启用该插件：
   • 设置 → 社区插件 → 启用“Claudian”。

使用 BRAT

BRAT（Beta Reviewers Auto-update Tester）允许您直接从 GitHub 安装并自动更新插件。

1. 从 Obsidian 社区插件中安装 BRAT 插件。
2. 在设置 → 社区插件中启用 BRAT。
3. 打开 BRAT 设置并点击“添加 Beta 插件”。
4. 输入仓库 URL：https://github.com/YishenTu/claudian。
5. 点击“添加插件”，BRAT 将自动安装 Claudian。
6. 在设置 → 社区插件中启用 Claudian。

提示：BRAT 会自动检查更新，并在有新版本时通知您。

从源代码安装（开发模式）

1. 将此仓库克隆到您的笔记库插件文件夹中：

   cd /path/to/vault/.obsidian/plugins
   git clone https://github.com/YishenTu/claudian.git
   cd claudian
   

2. 安装依赖并构建：

   npm install
   npm run build
   

3. 在 Obsidian 中启用该插件：

   • 设置 → 社区插件 → 启用“Claudian”。

开发模式

# 监听模式
npm run dev

# 生产构建
npm run build

提示：将 .env.local.example 复制为 .env.local，或运行 npm install 并设置您的笔记库路径，以便在开发过程中自动复制文件。

隐私与数据使用

• 发送至 API：您的输入、附加文件、图片以及工具调用的输出。默认为 Anthropic（Claude）或 OpenAI（Codex）；可通过环境变量进行配置。
• 本地存储：Claudian 设置和会话元数据存储在 vault/.claudian/；Claude 提供者的相关文件存储在 vault/.claude/；对话记录则分别保存在 ~/.claude/projects/（Claude）和 ~/.codex/sessions/（Codex）。
• 无遥测：除您配置的 API 提供商外，不会进行任何跟踪。

故障排除

未找到 Claude CLI

如果您遇到 spawn claude ENOENT 或“未找到 Claude CLI”的错误，说明插件无法自动检测您的 Claude 安装。这种情况常见于 Node.js 版本管理工具（nvm、fnm、volta）。

解决方案：找到您的 CLI 路径，并在设置 → 高级 → Claude CLI 路径中进行设置。

平台	命令	示例路径
macOS/Linux	which claude	/Users/you/.volta/bin/claude
Windows（原生）	where.exe claude	C:\Users\you\AppData\Local\Claude\claude.exe
Windows（npm）	npm root -g	{root}\@anthropic-ai\claude-code\cli.js

注意：在 Windows 上，请避免使用 .cmd 包装器，应使用 claude.exe 或 cli.js。

替代方案：将您的 Node.js bin 目录添加到设置 → 环境 → 自定义变量中的 PATH。

npm CLI 与 Node.js 不在同一目录

如果您使用的是 npm 安装的 CLI，请检查 claude 和 node 是否位于同一目录：

dirname $(which claude)
dirname $(which node)

如果路径不同，像 Obsidian 这样的 GUI 应用可能无法找到 Node.js。

解决方案：

1. 安装原生二进制文件（推荐）。
2. 将 Node.js 路径添加到设置 → 环境：PATH=/path/to/node/bin。

Codex 提供者

Codex 支持现已上线，但仍需在不同平台和安装方式下进一步测试。如果您遇到任何问题，请提交 GitHub 问题。

架构设计

src/
├── main.ts                      # 插件入口点
├── app/                         # 共享默认设置和插件级存储
├── core/                        # 与提供者无关的运行时、注册表及类型契约
│   ├── runtime/                 # ChatRuntime 接口和审批类型
│   ├── providers/               # 提供者注册表和工作区服务
│   ├── security/                # 审批辅助工具
│   └── ...                      # 命令、MCP、提示、存储、工具、类型等
├── providers/
│   ├── claude/                  # Claude SDK 适配器、提示编码、存储、MCP 和插件
│   └── codex/                   # Codex 应用服务器适配器、JSON-RPC 传输、JSONL 历史记录
├── features/
│   ├── chat/                    # 侧边栏聊天：标签、控制器、渲染器
│   ├── inline-edit/             # 内联编辑模态窗口及基于提供者的编辑服务
│   └── settings/                # 带有提供者选项卡的设置界面
├── shared/                      # 可复用的 UI 组件和模态窗口
├── i18n/                        # 国际化支持（10 种语言）
├── utils/                       # 跨领域实用工具
└── style/                       # 模块化 CSS

路线图

• 100万参数的Opus和Sonnet模型
• Codex提供商集成
• 更多功能敬请期待！

许可证

根据MIT许可证授权。

点赞历史

致谢

• Obsidian 提供的插件API
• Anthropic 提供的Claude及Claude Agent SDK
• OpenAI 提供的Codex

Claudian 快速上手指南

Claudian 是一款 Obsidian 插件，旨在将 AI 编程助手（如 Claude Code、Codex）直接嵌入你的知识库。它允许 AI 代理直接读取、写入、搜索和编辑你仓库中的文件，将 Obsidian 仓库变为 AI 的工作目录。

环境准备

在开始之前，请确保满足以下系统和依赖要求：

• 操作系统：仅限桌面端（macOS, Linux, Windows）。
• Obsidian 版本：v1.4.5 或更高版本。
• 核心依赖（二选一或全选）：
  • Claude 方案（推荐）：需安装 Claude Code CLI。建议使用原生安装包（Native install），以避免路径检测问题。你需要拥有 Claude 订阅/API 密钥，或使用兼容提供商（如 Openrouter, Kimi 等）。
  • Codex 方案（可选）：需安装 Codex CLI。

安装步骤

方法一：通过 BRAT 插件安装（推荐，支持自动更新）

1. 在 Obsidian 中进入 设置 -> 社区插件，搜索并安装 BRAT (Beta Reviewers Auto-update Tester)。
2. 启用 BRAT 插件，进入其设置页面。
3. 点击 Add Beta plugin。
4. 输入仓库地址：https://github.com/YishenTu/claudian
5. 点击 Add Plugin，BRAT 将自动下载并安装 Claudian。
6. 回到 Obsidian 设置 -> 社区插件，启用 Claudian。

方法二：手动安装

1. 从 GitHub Releases 下载最新版的 main.js, manifest.json, 和 styles.css。
2. 在你的 Obsidian 仓库目录下创建插件文件夹：

   /path/to/vault/.obsidian/plugins/claudian/
   

3. 将下载的三个文件复制到上述文件夹中。
4. 重启 Obsidian（如果需要），进入 设置 -> 社区插件，启用 Claudian。

方法三：源码构建（开发者适用）

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

# 2. 安装依赖并构建
# 国内用户可使用淘宝镜像加速 npm 安装
npm config set registry https://registry.npmmirror.com
npm install
npm run build

# 3. 在 Obsidian 中启用插件

基本使用

安装并启用后，你可以通过以下方式与 AI 交互：

1. 打开聊天侧边栏

点击左侧功能区（Ribbon）的 Claudian 图标，或通过命令面板（Ctrl/Cmd + P）搜索 "Claudian: Open Chat" 打开侧边栏。

2. 基础对话与文件操作

在聊天框中输入指令，AI 会自动识别并操作当前仓库内的文件。

• 示例：帮我总结今天所有的日记内容，并生成一个周报草稿保存到 Weekly 文件夹。
• AI 将自动读取相关文件，执行分析，并写入新文件。

3. 行内编辑 (Inline Edit)

这是最高效的使用方式：

1. 在笔记中选中一段文本，或将光标置于某处。
2. 按下设定的快捷键（默认需在设置中确认，通常为特定组合键）。
3. 输入指令，例如：润色这段文字，使其更专业 或 修复这里的代码逻辑错误。
4. AI 将在弹窗中提供词级差异预览（Diff Preview），确认后即可直接替换原文。

4. 高级功能速览

• 提及文件 (@)：输入 @ 可指定特定文件、子代理或外部目录供 AI 参考。例如：@README.md 请根据此文件更新文档结构。
• 计划模式 (Shift+Tab)：切换至此模式，AI 会先探索任务并制定计划，经你批准后再执行具体操作。
• 斜杠命令 (/)：输入 / 调用预设的提示词模板或技能（Skills）。
• 自定义指令 (#)：在输入框中使用 # 添加临时的精细指令。

注意：首次使用时，请确保在插件设置中正确配置了 Claude CLI 的路径（如果未自动检测到），并登录相应的 API 服务。