跳到主内容

reef 使用指南

DSH 插件全家桶:浏览器自动化 + MCP Server + GitHub/GitLab 自动评审 + 原生嵌入面板,一次安装启用五个模块。

本文为派生内容(基于 wiki / faq / compatibility_json 自动组装),非 AI 即时创作。

本文由本站基于该插件已收录的字段自动派生(wiki / faq / compatibility_json / readme),非 AI 即时创作。每节末尾标源字段。

快速上手

reef

— 源: plugin_wiki.wiki_content

安装与验证

dsh plugin --profile web add dsh-reef

复制以上命令在 DSH Web Profile 内运行。安装完成后在「插件列表」启用即可。

— 源: plugins.install

关键要点

  • 悬浮按钮:右下角圆形按钮显示鲸鱼图标——透明底标志,跟随 DSH 主题自动切换
  • 状态行:浏览器(开关/标签数/当前 URL)、MCP(在线状态)、GitHub(webhook 在线 + 事件数);
  • 实时画面:浏览器打开时显示缩略图,点击弹出大屏模态框——2 秒轮询实时画面,
  • GitHub 事件看板:最近 3 条 webhook 事件(时间/事件/仓库/编号/处理结果);
  • ⚙ 设置区:五个模块的配置都可在面板里修改,详见 配置。

— 源: plugin_wiki.readme_zh (fallback readme_raw)

常见问题

安装后必须重启 DSH 才能生效吗?

是的,cordis.patch.yml 中注册的五个插件行(reef-browser / reef-mcp / reef-github / reef-gitlab / reef-console)需要重启 DSH 才会加载;面板 ⚙ 设置区的改动无需重启即可热生效(仅标 ⟳ 的路径类字段除外)。

浏览器工具是否需要下载 Chromium?

默认不需要。配置项 channel='auto' 时会按平台优先探测系统已装的 Edge/Chrome/Chromium(Windows 顺序 msedge→chrome→chromium,macOS/Linux 顺序 chrome→msedge→chromium),都不存在才用 playwright 自带 Chromium 或提示 npx playwright install chromium。

GitHub 只读工具需要 token 吗?

公共仓库可选:未配置 GITHUB_TOKEN 时走匿名访问(每 IP 60 次/小时),命中限流会返回 403 并附带提示;配置后无此限制且可访问私有仓库。写操作(建 issue/PR、评论、合并)一律需要 token,由 agent 用 bash 调 gh CLI 完成。

MCP Server 怎么鉴权?支持 OAuth 吗?

三种方式可叠加或单独使用:面板 ⚙ → MCP 直接填静态 Bearer token(写入凭据库或插件自有 tokens.json);通过 authTokenEnv 指定环境变量;启用 oauthEnabled=true 并配置 MCP_CLIENT_ID/MCP_CLIENT_SECRET 后走 OAuth 2.0 client_credentials,端点 /reef/mcp/oauth/token,附 RFC 8414 /.well-known/oauth-authorization-server 发现文档。

GitHub webhook 自动评审会重复评同一个 PR 吗?

默认不会。reviewDedupe=true 时同一 PR 同一 head commit 只评一次(源码 review.ts:51 用 headSha 做 key 缓存);评审模型可在面板设置 reviewModelProvider/reviewModelModel,空则用 DSH 默认模型。

配置存哪里?卸载会留垃圾吗?

凭据优先写 DSH credentials 服务($DSH_HOME/.credentials.yaml),服务缺失回退到 $DSH_HOME/.dsh-reef/tokens.json(0600);普通配置写 $DSH_HOME/.dsh-reef/settings.json(0600,字段白名单校验)。卸载时只需在 profile 的 cordis.patch.yml 中删除对应行,运行时目录需要手动清。

不想用某个模块怎么办?

在 $DSH_HOME/profiles/web/cordis.patch.yml 中删除对应行(reef-browser/reef-mcp/reef-github/reef-gitlab/reef-console),或者保留行但在 config 下加 enabled: false 即可关闭,重启生效。

— 源: plugin_wiki.faq_json

兼容性

  • DSH: 未声明
  • Node: >=22

— 源: plugin_wiki.compatibility_json

踩坑提醒

安装前请审阅上游仓库;本指南基于已收录字段自动派生,可能滞后于最新版本。如发现与官方文档冲突,请以上游为准。

— 来源:通用规则