项目文件夹

0
wehub-resource-sync 8f818184ce
CI / typecheck (push) Has been cancelled
CI / test (push) Has been cancelled
CI / lint (push) Has been cancelled
CI / build (push) Has been cancelled
docs: make Chinese README the default
2026-07-13 10:12:43 +00:00

Note

本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
English · 原始项目 · 上游 README
原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

Claudian

GitHub stars GitHub release License

Preview

一款 Obsidian 插件,可在你的库(vault)中嵌入 AI 编程智能体(Claude Code、Codex、Opencode、Pi,更多即将推出)。你的库将成为智能体的工作目录——文件读写、搜索、bash 以及多步骤工作流均可开箱即用。

功能与用法

从功能区图标或命令面板打开聊天侧边栏。选中文本并使用快捷键进行行内编辑。一切操作都和你熟悉的编程智能体一样——Claude Code、Codex、Opencode 和 Pi——与智能体对话,它会读取、写入、编辑和搜索你库中的文件。

行内编辑(Inline Edit — 选中文本或在光标位置开始 + 快捷键,直接在笔记中编辑,并提供词级 diff 预览。

斜杠命令与 Skills — 输入 /$,使用用户级和库级作用域中的可复用提示模板或 Skills。

@mention - 输入 @ 可提及你希望智能体处理的任何内容:库文件、子智能体(subagents)、MCP 服务器,或外部目录中的文件。

计划模式(Plan Mode — 通过 Shift+Tab 切换。智能体在实施前先探索与设计,然后提交计划供你审批。

指令模式(# — 从聊天输入中添加的精炼自定义指令。

MCP 服务器 — 通过模型上下文协议(Model Context Protocol,stdio、SSE、HTTP)连接外部工具。Claude 在应用内管理库 MCP;Codex 使用其自身的 CLI 托管 MCP 配置。

多标签页与会话 — 多个聊天标签页、会话历史、分支(fork)、恢复(resume)和紧凑模式(compact)。

系统要求

安装

从 Obsidian 社区插件安装(推荐)

  1. 打开 Obsidian → Settings → Community plugins → Browse
  2. 搜索 "Claudian" 并点击 Install
  3. 启用该插件

或直接从社区插件页面.安装。

从 GitHub Release 安装

  1. 最新版本下载 main.jsmanifest.jsonstyles.css
  2. 在库的 plugins 文件夹中创建名为 claudian 的文件夹:
    /path/to/vault/.obsidian/plugins/claudian/
    
  3. 将下载的文件复制到 claudian 文件夹
  4. 在 Obsidian 中启用插件:
    • Settings → Community plugins → Enable "Claudian"

从源码安装(开发)

  1. 将此仓库克隆到库的 plugins 文件夹:

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

    npm install
    npm run build
    
  3. 在 Obsidian 中启用插件:

    • Settings → Community plugins → Enable "Claudian"

开发

# Watch mode
npm run dev

# Production build
npm run build

隐私与数据使用

  • 发送至 API:你的输入、附加文件、图片及工具调用输出。默认:AnthropicClaude)、OpenAICodex),或在 Opencode/Pi 中配置的提供商;可通过提供商设置和环境变量配置。
  • 本地存储:Claudian 设置与会话元数据位于 vault/.claudian/;Claude 提供商文件位于 vault/.claude/;转录记录位于 ~/.claude/projects/Claude)、~/.codex/sessions/Codex),以及 .pi/agent/sessions/~/.pi/agent/sessions/Pi)。
  • 环境变量:提供商子进程继承 Obsidian 进程环境,以及你在 Claudian 中配置的任何变量。这用于 CLI 认证、代理、证书和 PATH 解析。
  • 设备特定路径:每台设备的 CLI 路径使用存储在浏览器本地存储中的不透明本地密钥,而非你的系统主机名。
  • 后台活动Claudian 不运行遥测信标。UI 轮询定时器仅读取本地 Obsidian/编辑器选中状态。网络活动仅限于明确的提供商运行时工作、已配置的 MCP 端点,以及响应你请求所需的提供商 SDK/CLI 调用。

故障排除

找不到 Claude CLI

如果遇到 spawn claude ENOENTClaude CLI not found,插件无法自动检测你的 Claude 安装。这在 Node 版本管理器(nvm、fnm、volta)中很常见。

解决方案:先将该设置留空,让 Claudian 自动检测 Claude Code。若自动检测失败,找到你的 CLI 路径并在 Settings → Advanced → Claude CLI path 中设置。

平台 命令 示例路径
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-wrapper.cjs

注意:在 Windows 上,避免使用 .cmd.ps1 包装器。原生安装请使用 claude.exe,包管理器安装请使用 cli-wrapper.cjscli.js 仅是旧版 Claude Code npm 包的遗留回退方案。

替代方案:在 Settings → Environment → Custom variables 中将 Node.js bin 目录添加到 PATH。

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

若使用 npm 安装的 CLI,检查 claudenode 是否在同一目录:

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

若不在同一目录,Obsidian 等 GUI 应用可能找不到 Node.js。

解决方案

  1. 安装原生二进制文件(推荐)
  2. 在 Settings → Environment 中添加 Node.js 路径:PATH=/path/to/node/bin

其他提供商

Codex、Opencode 和 Pi 支持已上线,但功能可能不完整,仍需要在各平台和安装方式下进行更多测试。如有功能请求或遇到任何 bug,请提交 GitHub issue.

架构

src/
├── main.ts                      # Plugin entry point
├── app/                         # Shared defaults and plugin-level storage
├── core/                        # Provider-neutral runtime, registry, and type contracts
│   ├── runtime/                 # ChatRuntime interface and approval types
│   ├── providers/               # Provider registry and workspace services
│   ├── auxiliary/               # Shared provider auxiliary services
│   ├── bootstrap/               # Plugin bootstrap wiring
│   ├── security/                # Approval utilities
│   └── ...                      # commands, mcp, prompt, storage, tools, types
├── providers/
│   ├── claude/                  # Claude SDK adaptor, prompt encoding, storage, MCP, plugins
│   ├── codex/                   # Codex app-server adaptor, JSON-RPC transport, JSONL history
│   ├── opencode/                # Opencode adaptor
│   ├── pi/                      # Pi RPC adaptor, model discovery, JSONL history
│   └── acp/                     # Agent Client Protocol shared transport
├── features/
│   ├── chat/                    # Sidebar chat: tabs, controllers, renderers
│   ├── inline-edit/             # Inline edit modal and provider-backed edit services
│   └── settings/                # Settings shell with provider tabs
├── shared/                      # Reusable UI components and modals
├── i18n/                        # Internationalization (10 locales)
├── types/                       # Shared ambient types
├── utils/                       # Cross-cutting utilities
└── style/                       # Modular CSS

许可证

根据 MIT License 授权。

赞助

Ke Holdings Inc. (BEIKE)

MOMA

Claudian 由贝壳找房(Ke Holdings Inc. / BEIKE)及 MOMA 团队慷慨赞助。他们的支持使 Claudian 能够通过持续的开发与维护不断改进。

想支持 Claudian 或在此展示赞助?请联系我:tysk01213@gmail.com

Star 历史

Star History Chart

致谢