hkcanan/katmer-code

GitHub: hkcanan/katmer-code

将 Claude Code 引入 Obsidian 编辑器的学术辅助插件,提供文献综述、引文验证及差异编辑等深度研究技能。

Stars: 298 | Forks: 16

# KatmerCode Obsidian 中的 Claude Code —— 具备学术研究技能、行内差异编辑和 MCP 支持。 [![Obsidian 插件](https://img.shields.io/badge/Obsidian-Plugin-7C3AED?style=flat&logo=obsidian)](https://obsidian.md) [![许可证: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE) [![仅限桌面端](https://img.shields.io/badge/platform-desktop%20only-orange)]() 一款将 Claude Code 集成为侧边栏聊天面板的 Obsidian 插件。专为在 Obsidian 中进行写作的研究人员构建,希望在不离开编辑器的情况下获得文献综述、引文检查、稿件编辑和同行评审等方面的 AI 协助。 附带作为斜杠命令运行的 **7 项学术研究技能**。**仅限桌面端**(需要 Claude Code CLI)。 ![聊天面板](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/ecd9b4adc3144123.png) ## 快速开始 1. 安装 Claude Code:`npm install -g @anthropic-ai/claude-code`,然后运行 `claude` 登录 2. 克隆并构建:`git clone https://github.com/hkcanan/katmer-code.git && cd katmer-code && npm install && npm run build` 3. 将 `main.js`、`manifest.json`、`styles.css` 复制到 `/.obsidian/plugins/katmer-code/` 中 4. 在 Obsidian → 设置 → 社区插件中启用 **KatmerCode** 5. 若要使用学术技能:设置 → KatmerCode → 开启技能 + 启用 **允许网络请求** ## 功能特性 - 在 Obsidian 中运行 Claude Code(通过 [Agent SDK](https://docs.anthropic.com/en/docs/claude-code/sdk)) - 通过**行内差异**编辑您的稿件——在编辑器中进行字词级别的修订追踪(接受/撤销) - 生成 **HTML 研究报告**(同行评审、引文分析、研究空白分析),可在 Obsidian 内查看 - 连接到您的 **MCP 服务器**——在 `~/.claude.json` 中配置的任何服务器均可自动生效 - 支持 `/compact`、标签页、会话恢复、流式传输以及 Claude Code 终端能做的所有操作 ## 截图 ### 聊天面板 ![聊天](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/ecd9b4adc3144123.png) *选中的文本会自动作为上下文附加。侧边栏中展示工具调用、思考块和流式文本。* ### 行内差异编辑 ![差异](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/ea3f7422c5144125.png) *字词级别的修订追踪——红色删除线表示删除的文本,绿色下划线表示添加的内容。接受 (✓) 或撤销 (✕)。* ### 同行评审报告 ![报告](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/24508a0b83144128.png) *`/peer-review` 会生成一份包含 8 项指标评分、雷达图和详细评估的 HTML 报告。* ### 引文验证与缺失参考文献 ![引文](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/1ad63e2546144133.png) *带有评估徽章的主张级别验证。缺失的参考文献按被引次数和相关性进行排名。* ## 学术技能 从 **设置 → KatmerCode → 学术技能** 中启用。每项技能都会作为斜杠命令进行安装。 ### 技能的工作原理 1. **您提供一份稿件**——可以是活动文件、文件路径或选中的文本。 2. **Claude 读取并分析它**——解析结构,提取主张,识别参考文献。 3. **查询 API**——技能调用学术数据库进行交叉核对、搜索或信息扩充。 4. **生成 HTML 报告**——包含表格、图表和具有可操作性的发现。 5. **在 Obsidian 中打开报告**——或者在您的浏览器中打开,由您选择。 对于耗时较长的任务(带有引文验证的同行评审、研究空白分析),Claude 会使用 **子代理**——并行处理程序同时分析不同的部分。 ### 可用技能 | 命令 | 功能描述 | 典型应用场景 | |---------|-------------|-----------------| | `/peer-review` | 从 8 个维度(原创性、论证结构、文献覆盖面、方法论等)评估您的稿件。生成雷达图和逐节的反馈。 | 提交前:“评审员可能会指出什么问题?” | | `/cite-verify` | 对照 CrossRef、Semantic Scholar 和 OpenAlex 检查每一篇参考文献。标记作者姓名、年份或标题中的不匹配之处。测试引用的主张是否真正得到了来源的支持。 | 起草后:“我的引文准确吗?” | | `/lit-search` | 并行搜索 arXiv、Semantic Scholar、PubMed 和 OpenAlex。对结果进行去重并按相关性排名。 | 启动新项目:“关于 X 发表了哪些文章?” | | `/citation-network` | 构建交互式引文网络图 展示谁引用了谁。包含时间轴视图。 | 了解某个领域:“这些论文之间有何关联?” | | `/research-gap` | 识别文献中的时间、方法论、主题和应用空白。根据可行性和潜在影响对每个空白进行评分。 | 规划研究:“机遇在哪里?” | | `/journal-match` | 分析您稿件的参考文献概况,并根据您所引用的来源的发表去向建议目标期刊。 | 准备提交:“这篇论文适合哪家期刊?” | | `/abstract` | 生成 5 种格式的摘要:结构化、叙述性、图文描述、亮点和社交媒体总结。 | 定稿时:“帮我写一份结构化摘要。” | ### 技能输出 #### `/cite-verify` —— 引文验证 ![引文验证](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/9a659950cb144137.png) *每篇参考文献都会对照 CrossRef、Semantic Scholar 和 OpenAlex 进行检查。标记有问题的地方并附上评估徽章——年份错误、可疑引文、推荐修正。* #### `/journal-match` —— 期刊推荐 ![期刊匹配](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/d4c5c646bc144141.png) *排名前 10 的期刊,根据范围、影响力、受众和接受度进行评分。附带当前期刊的优势/劣势评估。* ![期刊推荐](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/6c03eb50ce144143.png) *包含最佳选择、强力备选和稳妥备选的战略推荐——每一项均附带理由。* #### `/research-gap` —— 空白分析 ![空白矩阵](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/20f540ad5d144144.png) *按优先级和影响力排名的空白。证据密度展示了每个领域的探索不足程度。* ![空白详情](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/d782026745144148.png) *每个空白都包含证据基础、研究问题、可行性评估和战略说明。* ![发表趋势](https://static.pigsec.cn/wp-content/uploads/repos/2026/04/3ffa3f28e8144149.png) *发表趋势图展示了该领域随时间的活动情况——有助于识别新兴或衰退的领域。* ### 报告设计 所有技能都会生成采用共享设计系统的 HTML 报告: - **Crimson Pro** 衬线字体排版(学术书籍美感) - **Chart.js** 用于绘制雷达图、条形图、时间轴 - **Alpine.js** 用于可折叠部分和交互元素 - 跨所有报告类型保持一致的调色板、表格样式和徽章系统 报告可在 Obsidian 内(iframe 查看器)或默认浏览器中打开。生成新报告时会自动出现通知。 ### 一个实际的例子 假设您起草了一篇关于人工智能在法律推理中应用的论文。以下是使用这些技能的一种方式: 1. `/peer-review makaleler/demo-article.md` —— 在请教同事之前获得一份结构化评估 2. 查看雷达图——注意到“文献覆盖面”得分较低 3. `/lit-search AI legal reasoning hermeneutics` —— 查找您可能遗漏的论文 4. `/cite-verify makaleler/demo-article.md` —— 检查所有 14 篇参考文献是否准确 5. `/journal-match makaleler/demo-article.md` —— 查看哪些期刊发表类似的研究 6. 根据发现修改您的稿件,然后再次运行 `/peer-review` 没有哪一次运行能给您一个确定的答案。但每一次都会向您展示一些您自己可能无法察觉的东西。 ## 系统要求 - **Obsidian** 1.4.0+(仅限桌面端——macOS、Windows 或 Linux) - 已安装并登录的 **Claude Code CLI** - 具有 API 访问权限的 **Claude 账户** ``` npm install -g @anthropic-ai/claude-code claude # log in once ``` ## 安装 ### 从源代码构建 ``` git clone https://github.com/hkcanan/katmer-code.git cd katmer-code npm install npm run build ``` 这会在项目根目录生成三个文件:`main.js`、`manifest.json` 和 `styles.css`。 将这三个文件复制到您的仓库中: ``` mkdir -p /.obsidian/plugins/katmer-code cp main.js manifest.json styles.css /.obsidian/plugins/katmer-code/ ``` 然后在 Obsidian → 设置 → 社区插件中启用 **KatmerCode**。 ## 配置 | 设置 | 默认值 | 描述 | |---------|---------|-------------| | CLI 路径 | `claude` | 自动检测。如需要可手动设置。 | | 工作目录 | 仓库根目录 | Claude 会话运行的路径。 | | 默认模型 | Sonnet | Opus、Opus 1M、Sonnet 或 Haiku | | 权限模式 | 接受编辑 | 仅自动批准文件编辑 | | 允许网络请求 | 关闭 | 学术技能需要(启用 WebFetch、WebSearch、curl) | ### MCP 服务器(可选) 该插件从您的 Claude Code 配置(`~/.claude.json`)继承 MCP 服务器。无需额外配置——如果您已经为终端 Claude Code 设置了 MCP 服务器,它们在这里也同样有效。 以下服务器**并非必需**,但安装后可以加速学术技能: - [paper-search-mcp](https://github.com/openags/paper-search-mcp) —— 集成 20 多个学术数据库的单一服务器 - [arxiv-mcp-server](https://github.com/blazickjp/arxiv-mcp-server) —— 支持全文 PDF 阅读的 arXiv - [openalex-research-mcp](https://github.com/oksure/openalex-research-mcp) —— 引文分析、趋势、期刊质量 如果没有 MCP 服务器,技能会使用 WebFetch 直接调用 API。这完全可行——MCP 服务器只是让它更快、消耗更少的 token。 ## 工作原理 ``` Obsidian ├── Editor (with inline diffs) ├── KatmerCode Chat (sidebar) │ └── Agent SDK → Claude Code CLI subprocess │ ├── Tools (Read, Edit, Write, Bash, Grep...) │ ├── MCP servers (from your config) │ └── Skills (~/.claude/commands/) └── Report Viewer (iframe) ``` 当您在设置中启用技能时,它们是作为 `.md` 提示词文件安装到 `~/.claude/commands/` 中的。它们在插件和您的终端中均可运行。 ## 许可证 [MIT](LICENSE) ## 贡献 欢迎提交 Issue 和 PR。这是一个副业项目——由研究人员为研究人员构建。
标签:Agent SDK, AI编程助手, Anthropic, CIS基准, Claude, CVE检测, DLL 劫持, Inline Diff, Markdown, MCP支持, MITM代理, Obsidian, 同行评审, 大语言模型, 学术研究, 引用检查, 插件, 文本分析, 文献综述, 知识管理, 科研工具, 自动写作, 自动化攻击, 论文编辑