Skip to content

README_zh_CN.md

Latest commit

 

History

History
143 lines (95 loc) · 6.15 KB

README_zh_CN.md

File metadata and controls

143 lines (95 loc) · 6.15 KB
Raw

Claude Note

Claude Note 是一个用于思源笔记的 Claude Code 侧栏插件。它把本地 Claude Code 会话嵌入思源笔记，让你可以在阅读、写作和整理笔记时，直接调用 Claude Code 处理当前文档、关联笔记、附件和本地工作目录中的内容。

本插件不是普通的 Chat API 对话框。它运行的是你本机已经安装和配置好的 Claude Code，因此可以继承 Claude Code 的模型、权限、工具调用、会话历史和本地文件处理能力；同时，插件会把思源笔记的上下文以更适合笔记场景的方式交给 Claude Code。

主要功能

  • 在思源侧栏中使用 Claude Code，对话过程不离开笔记界面。
  • 自动识别当前打开的思源文档，可一键附加为本轮对话上下文。
  • 支持搜索并关联思源文档，将相关笔记片段加入对话。
  • 支持添加本地文件，让 Claude Code 结合文件内容进行分析、整理或改写。
  • 支持多个并行会话，每个会话可保留独立的模型、思考强度和权限模式。
  • 支持读取 Claude Code 历史会话，并可在插件内重命名、恢复或删除会话。
  • 支持显示或隐藏思考过程、工具调用，并对单个步骤展开或收起。
  • 在输入区显示模型、思考强度、权限模式和上下文窗口使用情况。
  • 自动读取 ~/.claude/settings.json 中的模型和环境变量配置，适配第三方模型、代理网关和自定义 Claude Code 配置。
  • 内置精简的思源 API 辅助工具。Claude Code 在需要读取或修改思源笔记时，可以通过插件提供的 helper 与思源交互，用户不需要额外安装思源 skill。
  • 长对话中支持一键滚动到开头、末尾。

安装前提

使用 Claude Note 前，需要先准备好：

  1. 思源笔记桌面端。
  2. 本机可用的 Claude Code CLI。
  3. Node.js 18 或更高版本。

Claude Code 的安装、登录、模型配置和第三方代理配置请参考官方文档：

如果你不熟悉 Claude Code 的安装流程，可以在 B 站等平台搜索面向新手的安装教程。只要你能在终端中正常运行 claude，通常就可以继续使用本插件。

安装插件

通过思源集市安装

  1. 打开思源笔记。
  2. 进入 设置 -> 集市 -> 插件。
  3. 搜索 Claude Note。
  4. 安装并启用插件。
  5. 点击思源侧栏中的 Claude Note 图标打开面板。

基本使用

  1. 点击思源侧栏中的 Claude Note 图标。
  2. 在输入框中输入问题或任务。
  3. 根据需要勾选当前文档、关联其他笔记，或添加本地文件。
  4. 在输入区选择模型、思考强度和权限模式。
  5. 发送消息，等待 Claude Code 返回结果。

如果当前会话正在运行，你仍然可以切换到其他会话、新建会话或继续输入内容；正在运行的会话可单独停止。

上下文与思源笔记

Claude Note 支持三类常用上下文：

  • 当前文档：把当前打开的思源文档加入本轮对话。
  • 关联笔记：搜索并选择其他思源文档或片段加入本轮对话。
  • 本地文件：把本地文件交给 Claude Code 作为参考材料。

这些上下文会在本轮发送时交给 Claude Code。发送后，插件会清理已附加的临时上下文，避免无意中在后续轮次中持续累积。

插件内置了一个精简的思源 API helper。它会自动使用思源运行环境中的 API token 和端口；如果自动识别失败，可以在插件设置中手动填写思源 API 密钥和端口。

模型、思考强度与权限模式

Claude Note 的底部输入区提供三个与 Claude Code 相关的选项：

  • 模型：来自 Claude Code 默认模型和 ~/.claude/settings.json 中可识别的模型配置。
  • 思考强度：对应 Claude Code 的 effort 参数。
  • 权限模式：对应 Claude Code 的 permission mode，用于控制工具调用和文件操作时的确认策略。

这些选项按会话保存。也就是说，不同会话可以使用不同模型、不同思考强度和不同权限模式。

设置说明

Claude Note 的设置分为两类。

通用

  • 默认附加当前打开文档。
  • 是否要求使用 Command/Ctrl + Enter 发送。
  • 流式输出时是否自动滚动到底部。
  • 是否显示思考过程。
  • 是否显示工具调用。
  • 思源 API 密钥和端口。

一般情况下，思源 API 密钥可以留空，插件会尝试自动识别。

Claude Code

  • Claude CLI 路径：通常无需填写，插件会自动寻找 claude 命令。
  • 工作目录：Claude Code 的运行目录，也是本地文件读写和命令执行的主要边界。
  • 项目指令：对应工作目录中的 CLAUDE.md，可在插件设置中编辑，也可直接编辑该文件。
  • 环境变量：为 Claude Code 会话额外传入环境变量。

建议将工作目录设置为思源 data 目录，或你专门用于文献、写作和资料整理的工作目录。若工作目录中不存在 CLAUDE.md，插件会自动生成；即使项目指令为空，也会生成空文件。

注意事项

  • Claude Note 依赖本机 Claude Code。若终端中无法正常运行 claude，插件也无法正常工作。
  • Claude Code 可能读取文件、修改文件或执行命令，具体能力取决于工作目录和权限模式。
  • 插件禁止 Claude Code 直接写入思源的 .sy 文件；涉及思源笔记修改时，应优先通过思源 API helper 完成。
  • 如果使用第三方模型、代理或自定义网关，请先确保 Claude Code 在终端中可正常调用，再在插件中使用。
  • 本插件目前专注于侧栏使用，不提供标签页模式。

开发

pnpm install
pnpm dev

构建：

pnpm build

项目仓库：

https://github.com/fujingzhai/claude-note

许可

MIT

声明

本插件完全通过 vibe coding 制作。制作用到的工具和模型包括：

  • Codex（GPT-5.5）：约 60% 任务量
  • Antigravity（Gemini 3.5 Flash）：约 30% 任务量
  • Claude Code（mimo-v2.5-pro）：约 10% 任务量

请有需要使用的用户自行斟酌使用。