KloseDoc

协作、评论、版本历史与 GitHub

实时协作

同一项目的成员可以同时编辑。修改实时同步,每个人的光标带颜色和名字显示,顶栏头像和分享面板的 当前在线 列表显示谁在线。

通过只读链接匿名访问的人需要先在弹出的对话框中 设置显示名称 再 加入工作空间。

邀请成员和分享链接的操作见项目首页的“分享与成员”。

评论

评论需要登录,查看者也可以评论。

添加评论

  • 工具栏的 在光标或所选文本处添加评论:选中一段文本后点击,评论锚定到选区;没有选区时锚定到光标所在的词或行。
  • 侧栏“评论”标签中的 新建评论:使用当前选区。
  • 光标不在文本上时会提示“请将光标放在文本上,或选择要评论的文本”。

单条评论最多 4000 字符。有未保存的评论草稿时离开页面会有提示。

查看与操作

  • 有评论的行在行号旁显示评论图标,被评论的文本高亮,点击文本或图标打开评论弹窗。
  • 侧栏评论列表按 未解决 / 已解决 筛选,按文件和位置排序,点击线程跳到对应源码。列表每 15 秒自动刷新。
  • 回复:已解决的线程要先重新打开才能回复。
  • 编辑:仅作者。
  • 解决 / 重新打开:顶层评论的作者、项目所有者和编辑者。
  • 删除评论:作者或所有者,删除线程会一并删除其中的回复。

已解决的评论在标签行显示“已解决”。AI 审阅生成的评论额外带严重级别(错误 / 警告 / 提示)和类别标签,见AI 写作助手。

版本历史

点击顶栏 版本历史 打开历史抽屉。

版本如何产生

  • 停止编辑 30 秒后自动创建一个版本;持续编辑时至少每 5 分钟创建一次。内容没有变化时不会重复创建。
  • 导入项目、应用 AI 修改、从 GitHub 拉取、切换主文件、Agent 更新时立即创建一个版本。
  • 你可以随时 创建命名版本(默认名“项目检查点”,最多 80 字符)作为检查点。

版本类型包括:初始版本、自动保存版本、已保存版本、恢复版本、导入项目、已应用 AI 修改、已拉取 GitHub 修改、Agent 更新。

浏览

  • 全部版本 / 已命名 筛选;条目按天分组,显示新增、修改、删除的文件数;加载更早版本 每次加载 50 条。
  • 铅笔按钮 命名版本 / 重命名版本,命名版本可以 删除命名版本。初始版本不能命名。
  • 点击某个版本进入只读的历史视图,顶部显示“正在查看历史版本”,预览区收起,不能编译。
  • 与当前版本比较 显示该版本与当前状态的差异:仅显示变动 过滤文件,文件带“新增 / 已修改 / 已删除”标记和 +/− 行数,跳转到修改处 在差异间循环。查看快照 切回完整内容。
  • 退出历史版本 回到编辑。

恢复

点击 恢复 会把项目内容恢复到该版本,并记录为一个新的“恢复版本”,因此当前内容不会丢失,可以再恢复回来。如果恢复期间有人修改了项目,会提示刷新历史后重试。

保留策略

  • 未命名的自动版本最多保留最新 200 个,超过 90 天的旧版本会被清理。
  • 每个项目最多 100 个命名版本,达到上限时提示“命名版本数量已达上限”。

这些数值由管理员设置。

GitHub 同步

GitHub 功能仅项目所有者可用,其他成员会看到“仅项目所有者可以使用该功能”。

连接

  1. 在 更多操作 → GitHub 集成 中点 连接 GitHub,完成 GitHub 授权。
  2. 点 安装 GitHub App,在 GitHub 上把 App 安装到你的账号或组织,并在“Only select repositories”里勾选要使用的仓库。新建仓库后也要回到 App 的安装设置里补勾。组织的安装可能需要管理员批准。
  3. 回到 KloseDoc,刷新仓库 后选择一个 空仓库,填写提交信息,点 关联并推送。项目会提交到仓库的默认分支。

要从已有仓库创建项目,请用项目首页的 从 GitHub 导入,导入后的项目已经关联好仓库。

同一个 GitHub 账号可以连接多个 KloseDoc 账号,每个账号保存独立的授权。

检查、拉取与推送

面板显示同步状态:GitHub 与 KloseDoc 已同步 / KloseDoc 有更改待推送 / GitHub 有更改待拉取 / 两端均有更改 / 重新连接 GitHub 以继续,以及上次检查和上次同步时间。

  • 检查:刷新状态。KloseDoc 不会自动拉取。
  • 拉取:确认后把 GitHub 的更改拉到项目,并创建“已拉取 GitHub 修改”版本。本地有未推送的更改时会拒绝,提示先推送或解决本地更改。
  • 推送:填写 提交信息(默认“Update from KloseDoc”,最多 240 字符)后提交。只有 GitHub 一端有更改时会拒绝,提示先拉取。
  • 两端均有更改 时点推送,KloseDoc 会把本地快照提交到一个新分支 klosedoc/<时间戳>-<随机串>,并提供 在 GitHub 上比较冲突分支 链接。在 GitHub 上合并或创建 PR 处理完后,再回来 检查 和 拉取 即可对齐。
  • 断开仓库连接 只断开关联,不会删除 GitHub 仓库。

与 Agent 配合

项目关联 GitHub 后,让 Codex、Claude Code 等 Agent 通过仓库更新项目,而不是用 MCP 直接上传:推送,Agent 在本地合并并 push,再拉取。令牌具有 GitHub 同步权限时,推送和拉取也可以由 Agent 自己完成;否则由你在这里操作。GitHub 有未拉取的更改时,Agent 的直接写入会被拒绝。详见Agent 接入。

限制

  • 同步上限:100 个文件、100 MB 源码(管理员可调)。
  • 不支持 submodule、符号链接、Git LFS,以及文件树过大导致 GitHub 返回截断列表的仓库。