Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

642 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iClaudian

GitHub stars GitHub release License

预览

iClaudian 是一个 Obsidian 桌面端插件,把常用 AI 编程代理直接嵌入到你的 Vault 侧边栏和行内编辑流程中。当前支持 Claude Code、Codex CLI、OpenCode、Gemini CLI、Antigravity CLI、Freebuff CLI,以及 GitHub Copilot CLI。你的 Vault 会作为代理工作目录,代理可以在授权范围内读取、搜索、编辑文件并执行多步骤任务。

核心功能

  • 多提供方聊天:在同一个聊天体验中切换 Claude、Codex、OpenCode、Gemini、Antigravity、Freebuff、Copilot 等运行时。
  • 行内编辑:选中文本或在光标位置触发快捷键,使用代理直接改写笔记,并显示词级 diff 预览。
  • 对话与多标签:支持多个聊天标签、历史会话、恢复、分叉、压缩上下文等工作流。
  • 计划模式:通过 Shift+Tab 切换 Plan 模式,让代理先探索和设计,再执行实现。
  • 指令模式(#:在输入框中使用 # 精炼/追加本轮自定义指令。
  • 命令与 Skills:输入 /$ 调用 Vault 级、用户级命令与 Skills。
  • @mention 上下文:可提及 Vault 文件、外部文件、子代理、MCP 服务器等上下文。
  • MCP 工具:支持 Model Context Protocol。Claude 可在插件内管理 Vault MCP;Codex、Gemini、Copilot、OpenCode、Freebuff 使用各自 CLI 的 MCP/工具配置。
  • 模型与推理配置:提供方设置页可配置模型列表、上下文窗口、推理强度或权限模式。Claude Opus 4.8(含 opus[1m])默认推理强度为 xhigh,思考过程以摘要(summarized)形式实时显示。
  • 流式数学渲染:可选「流式期间延迟数学公式渲染」设置,避免 LaTeX 在 token 边界处闪烁,待整段输出完成后再统一渲染。
  • 本地优先存储:会话元数据、提供方配置、命令、Skills 均保存在本地 Vault 或 CLI 原生目录中。

已支持提供方

提供方 启动方式 当前能力概览
Claude Code Claude Agent SDK / Claude Code CLI 最完整:流式对话、取消、恢复、历史、分叉、rewind(可选「仅对话」或「代码 + 对话」两种回退模式)、Plan、图片、行内编辑、#/$、子代理、MCP、插件等
Codex CLI codex app-server 发送、流式、取消、恢复、历史重载、分叉、Plan、图片、行内编辑、#$ Skills、子代理;部分运行时命令、MCP 管理、Claude 插件能力不适用
OpenCode OpenCode CLI ACP/运行时模型发现、模型筛选、模式选择、命令下拉、行内编辑和标题生成等基础代理能力
Gemini CLI gemini --acp ACP 会话、模型发现、Plan/YOLO 权限模式、运行时命令、MCP 由 Gemini CLI 管理
Antigravity CLI agy --model <id> -p / agy --continue --model <id> -p 流式输出、原生继续会话、模型与 effort ID、YOLO/Auto-edit/Plan 权限模式;每次请求直接传入模型,MCP/插件由 Antigravity CLI 管理
Freebuff CLI freebuff Freebuff 内置模型预选(Premium/Unlimited)、流式 stdout、行内编辑与标题生成;工具/MCP/浏览器能力由 Freebuff CLI 自身管理
GitHub Copilot CLI copilot --acp ACP 会话、模型选择、Plan/YOLO 权限模式、运行时命令;插件、MCP、BYOK 等由 Copilot CLI 管理;ACP 不可用时会走保留 Obsidian 当前笔记上下文的 prompt fallback

模型 ID

GitHub Copilot CLI 模型 ID

根据 copilot help config 的模型清单确认,Copilot CLI 当前可用的真实模型 ID 包括,iClaudian 也会默认预置这些 ID:

claude-sonnet-4.6
claude-sonnet-4.5
claude-haiku-4.5
claude-opus-4.8
claude-opus-4.7
claude-opus-4.6
claude-opus-4.6-fast
claude-opus-4.5
gpt-5.5
gpt-5.4
gpt-5.3-codex
gpt-5.2-codex
gpt-5.2
gpt-5.4-mini
gpt-5-mini
gpt-4.1

旧配置中的 gpt-5.1 会自动迁移到 gpt-5.4claude-sonnet-4 会自动迁移到 claude-sonnet-4.6。如需使用其他 Copilot CLI 模型,可在 Settings → iClaudian → Copilot → Model IDs 中每行填写一个模型 ID。

Antigravity CLI 模型 ID

Antigravity CLI 1.1.5 及以上版本提供稳定的 --model 参数和 models 子命令;iClaudian 会把选择的模型 ID 直接传给 agy -p,不再修改全局的 ~/.gemini/antigravity-cli/settings.json。当前预置模型 ID 为:

gemini-3.6-flash-medium
gemini-3.6-flash-high
gemini-3.6-flash-low
gemini-3.5-flash-medium
gemini-3.5-flash-high
gemini-3.5-flash-low
gemini-3.1-pro-high
gemini-3.1-pro-low
claude-sonnet-4-6
claude-opus-4-6-thinking
gpt-oss-120b-medium

旧配置中的模型显示名称会自动迁移到对应的 CLI 模型 ID;未指定 effort 的 gemini-3.6-flash 默认归一化为 gemini-3.6-flash-medium

Freebuff 内置模型

Freebuff CLI 会在终端首次使用时弹出模型选择界面。iClaudian 会把模型选择器里的 Freebuff 模型预先写入 ~/.config/manicode/settings.jsonfreebuffModel 字段,然后再执行 freebuff --cwd <vault>,尽量避免 CLI 再弹出模型选择界面。

Premium(高级):

DeepSeek V4 Pro   -> deepseek/deepseek-v4-pro
MiniMax M3        -> minimax/minimax-m3
MiMo 2.5 Pro      -> mimo/mimo-v2.5-pro
Kimi K2.6         -> moonshotai/kimi-k2.6

Unlimited(无限):

DeepSeek V4 Flash -> deepseek/deepseek-v4-flash
MiMo 2.5          -> mimo/mimo-v2.5
MiniMax M2.7      -> minimax/minimax-m2.7

如果 Obsidian GUI 环境找不到 freebuff,iClaudian 会额外探测常见 Node 安装位置(如 ~/.hermes/node/bin/freebuff)。也可以在 Settings → iClaudian → Freebuff → CLI path 填写绝对路径覆盖默认命令。

安装要求

  • Obsidian v1.4.5+
  • 桌面端系统:macOS、Linux、Windows
  • 至少安装一个你要使用的 CLI:
    • Claude provider:安装 Claude Code CLI
    • Codex provider:安装 Codex CLI
    • OpenCode provider:安装 OpenCode
    • Gemini provider:安装 Gemini CLI,并支持 gemini --acp
    • Antigravity provider:安装 Antigravity CLI,并完成 CLI 登录/授权
    • Freebuff provider:安装 Freebuff(npm install -g freebuff),并完成 CLI 登录/授权
    • Copilot provider:安装 GitHub Copilot CLI,并完成 copilot login

安装方式

从 GitHub Release 安装(推荐)

  1. latest release 下载 main.jsmanifest.jsonstyles.css

  2. 在你的 Vault 中创建插件目录:

    /path/to/vault/.obsidian/plugins/claudian/
    
  3. 把下载的三个文件复制到该目录。

  4. 在 Obsidian 中启用:Settings → Community plugins → Enable iClaudian

使用 BRAT 安装

  1. 安装并启用 BRAT
  2. 在 BRAT 设置中点击 “Add Beta plugin”。
  3. 填入仓库地址:https://github.com/izscc/iclaudian
  4. 添加完成后,在社区插件中启用 iClaudian

从源码开发

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

开发模式:

npm run dev

常用配置

CLI 路径

如果 Obsidian 无法从 GUI 环境的 PATH 中找到 CLI,可在对应提供方设置页填写绝对路径:

提供方 macOS/Linux 示例 Windows 示例
Claude /Users/you/.volta/bin/claude C:\Users\you\AppData\Local\Claude\claude.exe
Codex /Users/you/bin/codex C:\Users\you\AppData\Roaming\npm\codex.cmd
Gemini /usr/local/bin/gemini C:\Users\you\AppData\Roaming\npm\gemini.cmd
Antigravity /usr/local/bin/agy C:\Users\you\AppData\Roaming\npm\agy.cmd
Freebuff /usr/local/bin/freebuff C:\Users\you\AppData\Roaming\npm\freebuff.cmd
Copilot /Users/you/.local/bin/copilot C:\Users\you\AppData\Local\GitHubCopilot\copilot.exe
OpenCode /usr/local/bin/opencode C:\Users\you\AppData\Roaming\npm\opencode.cmd

Windows 使用 Claude 时,优先使用 claude.exe 或 npm 包中的 cli-wrapper.cjs,不要使用 .cmd / .ps1 包装脚本。

Copilot CLI 权限模式

Copilot provider 通过 ACP 启动:

  • 默认:copilot --acp --model <model>
  • YOLO:启动时追加 --allow-all,会话内优先通过 ACP allow_all=on 切换;若旧版 Copilot ACP 不支持该配置,再兼容回退到 autopilot mode URL
  • Plan:追加 --mode plan

Copilot 的 MCP、插件、BYOK provider、登录状态等仍由 GitHub Copilot CLI 自身管理。若 ACP 启动失败,iClaudian 会自动降级到 copilot --prompt --silent --stream on 的非交互对话路径,避免直接中断聊天。降级路径会把当前 Obsidian 笔记内容内联进 prompt,并把外部上下文目录通过 --add-dir 传递;Markdown 笔记不会作为 --attachment 传递,因为 Copilot CLI 的 attachment 只接受图片或原生文档。

Antigravity CLI 调用方式

Antigravity provider 使用当前 CLI 支持的非交互方式:

  • 默认:agy --model <model-id> -p <prompt> --print-timeout 5m
  • 连续对话:同一 iClaudian 运行时内第二轮起使用 agy --continue --model <model-id> -p <prompt>,复用 Antigravity CLI 原生会话与缓存,不再把完整历史重新拼进 prompt。
  • 输出:stdout 边到达边渲染到聊天窗口,避免等整个进程结束后才显示。
  • YOLO:追加 --dangerously-skip-permissions
  • Auto-edit / Plan:分别追加 --mode accept-edits / --mode plan
  • 模型:通过每次调用的 --model 参数传入,不修改用户全局 CLI 设置

这避免了旧版 agy --acp 路径导致的 initialize 超时问题,也尽量贴近原版 Antigravity CLI 的高速体验。

Freebuff CLI 调用方式

Freebuff provider 使用当前 CLI 公开的最小非交互能力:

  • 默认执行 freebuff --cwd <vault>,并通过 stdin 提交 prompt,以兼容 Freebuff 当前不接受 [prompt...] 参数的版本。
  • 输出:stdout 边到达边渲染到聊天窗口;stderr 仅在无 stdout 或退出失败时作为提示/错误展示。
  • 路径:留空时使用 PATH 中的 freebuff,并额外探测常见 Node 安装目录;填写 CLI path 后使用该路径。
  • 模型:iClaudian 的模型选择器会把所选模型写入 ~/.config/manicode/settings.jsonfreebuffModel 字段,尽量避免 CLI 再弹出模型选择 TUI。

Freebuff 的登录、广告支持、工具、浏览器使用和 MCP-like 能力仍由 CLI 自身管理。

隐私与数据

  • 会发送给模型提供方的数据:你的输入、被引用/附加的文件、图片、工具调用结果,以及代理执行上下文。
  • 本地存储
    • iClaudian 设置与会话元数据:vault/.claudian/
    • Claude Vault 配置:vault/.claude/
    • Codex Vault Skills/Agents:vault/.codex/vault/.agents/
    • Claude 原生日志:~/.claude/projects/
    • Codex 原生日志:~/.codex/sessions/
    • Copilot 原生配置:~/.copilot/
    • Freebuff 原生配置:通常位于 ~/.config/manicode/(由 CLI 自身维护;iClaudian 会写入 freebuffModel 字段以预选模型)
  • 无遥测:插件本身不做额外追踪;实际请求由你配置的 CLI/provider 决定。

开发命令

npm run dev
npm run build
npm run typecheck
npm run lint
npm run lint:fix
npm run test
npm run test:watch
npm run test:coverage

目录结构

src/
├── main.ts                      # 插件入口
├── app/                         # 默认设置与插件级存储
├── core/                        # 提供方无关的 runtime、registry、类型契约
├── providers/
│   ├── claude/                  # Claude SDK 适配、历史、MCP、插件、设置页
│   ├── codex/                   # Codex app-server、JSON-RPC、JSONL 历史、Skills、子代理
│   ├── opencode/                # OpenCode 适配、模型发现、模式管理
│   ├── gemini/                  # Gemini ACP 适配
│   ├── copilot/                 # GitHub Copilot CLI ACP 适配
│   ├── antigravity/             # Antigravity CLI print/continue 适配
│   ├── freebuff/                # Freebuff CLI 适配
│   └── acp/                     # ACP 共享客户端、传输、事件归一化
├── features/
│   ├── chat/                    # 侧边栏聊天、多标签、渲染器
│   ├── inline-edit/             # 行内编辑 Modal 与服务
│   └── settings/                # 设置页框架与通用设置区块
├── shared/                      # 通用 UI 组件
├── i18n/                        # 多语言翻译
├── utils/                       # 路径、环境变量、Markdown、图片、会话等工具
└── style/                       # 模块化 CSS

路线图

  • Claude Opus/Sonnet 1M 上下文模型
  • Codex provider 集成
  • OpenCode provider 集成
  • Freebuff provider 集成
  • Gemini CLI ACP provider 集成
  • GitHub Copilot CLI ACP provider 集成
  • 持续补齐各 provider 的原生命令、MCP、历史和跨平台安装体验

License

基于 MIT License 发布。

Acknowledgments

About

iClaudian: obsidian插件,支持Claude, Codex,Copilot, OpenCode, and Antigravity CLI 和 Freebuff 的集成使用其模型能力

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages