这份详细的部署教程将指引您安装和使用 Claudian——一个能将AI编程助手(如Claude Code、Codex、Grok等)直接嵌入到您的Obsidian笔记库中的插件。您的Obsidian笔记库会成为AI代理的工作目录,支持文件读写、搜索和Bash命令。

Claudian 的核心价值在于,它将强大的AI编程能力与Obsidian的知识管理无缝结合。您可以在笔记中直接与AI对话,让它帮您编写、修改、搜索笔记,甚至执行多步骤任务,所有操作都基于您当前的笔记上下文。

📥 安装方式

您可以通过两种方式安装Claudian。

方式一:从Obsidian社区插件市场安装(推荐)

这是最简单的方式,适合大多数用户。

  1. 打开Obsidian,进入 设置 → 社区插件 → 浏览
  2. 在搜索框中输入 “Claudian”
  3. 找到插件后,点击 安装,安装完成后在插件列表中将其 启用

方式二:从源码安装(开发者)

适用于想体验最新开发版或自行修改的用户。

  1. 进入您的Obsidian库的插件目录(通常是 你的库/.obsidian/plugins/),克隆仓库:

    1
    2
    3
    cd /path/to/your/vault/.obsidian/plugins
    git clone https://github.com/YishenTu/claudian.git
    cd claudian
  2. 安装依赖并构建:

    1
    2
    npm install
    npm run build
  3. 在Obsidian的社区插件列表中启用“Claudian”。

🤖 首次配置:选择AI代理

安装并启用插件后,您需要配置一个AI代理来驱动Claudian。

  1. 前提条件:您需要在电脑上全局安装至少一个支持的AI代理CLI,并确保它能正常工作。
    • 支持的代理:Claude Code CLI、Codex CLI、Grok Build、OpenCode、Pi。
    • API提供商:您还需要有这些代理对应的API订阅或提供商(如OpenRouter、Kimi、DeepSeek等)。具体配置请参考各代理的官方文档。
  2. 配置路径
    • 打开Obsidian设置,找到Claudian插件的设置页。
    • 在“Provider”(提供商)部分,选择您安装的AI代理(如Claude Code)。
    • 大多数情况下,Claudian能自动检测到CLI路径。如果提示找不到命令(如 spawn claude ENOENT),通常是因为CLI未在系统PATH中,常见于使用Node版本管理器(nvm, fnm)的情况。
  3. 手动设置CLI路径
    • 如果自动检测失败,您需要在设置中 手动指定CLI的完整路径。您可以在终端中使用 which claude (macOS/Linux) 或 where.exe claude (Windows) 命令找到路径。
    • Windows特别提示:请避免使用 .cmd.ps1 包装器。推荐使用原生安装的 claude.exe,或npm包安装的 cli-wrapper.cjs
    • 备选方案:您可以在Claudian设置的“Environment”中添加自定义环境变量,例如 PATH=/path/to/node/bin,以确保Node.js和CLI可执行文件在同一环境中。

🚀 核心功能与使用

配置完成后,您就可以在笔记中与AI协作了。

  • 打开聊天侧边栏:点击Obsidian左侧功能区的Claudian图标(或使用命令面板)打开聊天面板。所有对话都会基于您当前的笔记库上下文进行。
  • 内联编辑:在笔记中选中一段文本,或直接将光标放在某处,然后使用快捷键(可在设置中自定义)调用AI进行改写、续写或翻译。Claudian会提供逐词(word-level)的差异预览,让您清晰看到改动。
  • 斜杠命令与技能:在聊天输入框中输入 /$,可以调用预定义的提示词模板或技能(Skills),提高常用任务的效率。
  • 提及文件 (@mention):输入 @ 符号,可以提到库中的其他文件,让AI直接处理特定文档。
  • 计划模式 (Plan Mode):按 Shift+Tab 可切换到此模式。AI会先探索和设计实现方案,在获得您批准后再执行,适合复杂任务。
  • 多标签与双栏模式:您可以使用多个聊天标签,或将聊天面板切换为双栏模式,一边是会话列表,一边是当前对话。

❗ 故障排查

  • Provider CLI not found:如上所述,这是最常见的问题。请确保CLI已安装,其路径已被正确添加到系统PATH,或已在Claudian设置中手动指定
  • 网络或权限问题:请确保您的网络能正常访问AI提供商的API。Claudian本身不发送遥测数据,所有网络活动仅限于您主动发起的AI请求和配置的MCP服务。

📚 更多信息

  • 隐私:您的数据只会发送给您配置的AI提供商API。协作模式(Collab Mode)下的数据仅在本地网络中直接传输,不经过第三方服务器。
  • 贡献:欢迎提交Issue和Pull Request。但在提交新Provider的PR前,请务必阅读贡献指南。