Saltar al contenido principal
R

github-overview (plugin)

regrevia/github-overview/plugin

Adds github_overview, which reads the dashboard you run locally over its own HTTP API instead of estimating numbers. It returns browsed views and unique visitors, git clones, npm downloads, the 14-day funnel, per-repository rows with stored-day counts, external issue and pull counts, and star growth, plus the served origin and sync time so a stale read is visible. Unbound or offline yields a reason instead of zeros.

Instalar

dsh plugin --profile web add github:regrevia/github-overview

Este plugin se encuentra en el subdirectorio plugin del repositorio.

README

github-overview

自己的 GitHub 仓库,一个页面看完:浏览与克隆的趋势、npm 等外部来源的下载、流量落在哪些页面、外部人提了多少 issue 和 PR,右边一段 AI 写的摘要。

不依赖第三方统计服务,只跑一个本地 Node 进程:读你自己的 token,把数据抓下来存到本地,页面在浏览器里打开。

npx github-overview start          # 不需要先 clone,也不需要注册任何服务

dashboard

dashboard light

第一次运行

包和安装包里没有任何账号、token 或历史数据,只有代码。第一次打开要自己做两件事:

  1. 绑定 GitHub:页面上的「用 GitHub 登录」开一次浏览器授权。绑上的永远是你在浏览器里确认的那个账号;电脑上 gh 已经登录的账号不会被借用。
  2. 配模型(可选):不配也能用,AI 摘要走内置模板。要 AI 写摘要或提问,填 base URL、key、模型名,只存本机 ~/.config/github-overview/config.json(0600)。
npx github-overview start          # 打开页面,登录一次就绑好

登录成功会把这个账号名下的仓库一起接过来,不用再跑别的命令。已经有 token(GITHUB_TOKEN 或 GH_TOKEN)的话,也可以在 登录 旁边直接粘访问令牌。

数据也只在本机:抓下来的快照存在同一目录,不上传任何地方。想清空就删掉这个目录重来。

装成插件

在 DeepSeek Harness 的插件市场里搜 github-overview,装上之后直接问看板上的数:

用 github_overview 看看近 7 天哪个仓涨得最多

插件只连本机已经在跑的看板(127.0.0.1:4317);没在跑会提示先 npx github-overview start,没绑定会提示先登录。它不自己抓数据、不含任何凭据。

用法

npx github-overview start      # http://127.0.0.1:4317,首次打开登录一次

只想挑几个仓库、或者不想在页面里点,可以先用命令写好清单,再 start:

npx github-overview init --user 你的GitHub用户名   # 账号下全部仓库
npx github-overview init --repo owner/repo --npm 包名
  • --user 会把账号下自己拥有的仓库都绑上;页面顶部可以切到「全部仓库」看合计,也可以切单个仓库。只要一部分就写 --repo a/b,c/d。
  • --npm 按同一个顺序对应仓库,只在包名和仓库名不一样时才写。默认拿仓库名去找包,找到了还要核对 registry 上的维护者是不是你,不是就不算下载。
  • 首次同步把 14 天内的流量存到本地,之后每 6 小时自动刷新(--refresh 可改),页面上的「刷新」随时手动同步;issue / PR 不跟这个慢循环,默认每 15 分钟单独刷新(--contrib 可改,0 关闭),贡献区块标出这部分的快照时间。
  • AI 摘要:npx github-overview config --apikey KEY --baseurl URL --model MODEL,或点页面右下角「配置」直接填,只存本机 ~/.config/github-overview/config.json。模型不写用 deepseek-chat。
  • 切到「全部仓库」会多出一块「项目」:按访客或窗口内下载把仓库排成一列,点一行就切到那个仓。
  • 再往下是「发版效果」:各仓最近一次发版前后的浏览日均并排,按涨幅排,点一行切过去。
  • 「漏斗」把浏览、落到仓库主页、npm 下载三个数放在一起。下载是 npm 注册表口径,和浏览不是同一批人,所以只报倍数、不折算百分比。
  • 外部贡献按窗口计数,子标点出没关又没人回的那几条,点名字直接跳到那条;安全告警标出条数最多的仓库,点进去看具体条目。
  • 没配 AI 也能用,摘要走内置模板;配好后还能在摘要框下面问一句,按当前范围的数据回答。

桌面端和手机端

npx github-overview start --host 0.0.0.0   # 手机要连的时候,多这一行

start 打印两类地址:本机看的 http://127.0.0.1:4317,以及手机要填的 http://192.168.x.x:4317。默认只听本机,加 --host 0.0.0.0(或 HOST=0.0.0.0)才对同一 Wi-Fi 的手机开放,别人扫不到。

  • macOS / Windows 桌面:apps/desktop 是一个 Electron 外壳,双击直接进看板,不用开终端。它只监听本机回环,账号、token、抓下来的数据都留在本机 userData/data,和命令行版用同一个页面。
  • Android:apps/mobile 是一个 WebView 壳,第一次打开填一次电脑上的看板地址(就是 start 打印的 手机填 …),之后每次打开直接是看板。壳本身不存 token、不抓数据,登录和同步都还发生在电脑上,所以手机上丢了也只是丢一个地址。点站内链接留在壳里,点到 GitHub 之类的站外链接交给系统浏览器。
  • 绑定一律走浏览器授权:页面里的「用 GitHub 登录」会开一次授权页,你在浏览器里确认的是哪个账号,绑上的就是哪个账号。电脑上 gh 已经登着的账号不会被借用——授权过程用的是临时配置目录,读完就删。
  • 手机装不上时(部分国内 ROM 会拦 adb 安装):先在「设置 → 更多设置 → 开发者选项」打开「通过 USB 安装」,装的时候屏幕上会弹一次确认,点允许。用 USB 连着、又不想开局域网时,adb reverse tcp:4317 tcp:4317 之后手机上填 http://127.0.0.1:4317 即可。

为什么需要它

GitHub 自带的 traffic 只给 14 天,而且只有浏览和克隆,看不到 npm 下载。页面下半有一块「发版效果」:挑最近一个前后都有数据的版本,把发版前后各 7 天的浏览与下载日均并排放在一起(覆盖不满时标出实际天数),涨没涨一眼能看出。发行版一多、渠道一散,判断「这次发版有没有人真用上」就得自己拼数据。这个项目把 GitHub traffic、npm 下载、发版记录放在同一条时间轴上,再用一句话说清发生了什么。

口径

名字含义
浏览打开页面的总次数
访客去重后的人数,一个人来三次算一个
克隆git clone 的总次数
克隆人数去重后的人数
发版窗口内发布的版本,含 npm 发布时间;每仓最多取最近 100 条,覆盖不满整窗时界面会标出实际区间和下限
星数增长窗口内新增的 star,按每个 star 的日期算
外部贡献别人提的 issue 和 PR,作者自己和 CI、机器人账号的不计
  • 浏览和克隆是两个指标,不相加。
  • 页面构成是浏览落在哪些页面,来源是从哪个站进来,两者分开;这两块都用最近 14 天,不随上面选的窗口变。
  • 问「有多少用户」时按访客和 npm 下载两路折算后给约数和区间,不是只报访客数;克隆数不参与人数估算。
  • 多仓合计时浏览、克隆、下载、star 相加;访客不去重跨仓相加,沿用的是各仓 API 给的人数。

数据源

来源指标粒度
GitHub traffic浏览、克隆、页面、来源每日 + 快照
GitHub API外部 issue、PR按更新时间拉取,按创建或合并、关闭时间入窗
GitHub stargazers星数增长每个 star 的时间(取最近 1000 个,更早的不计)
GitHub alerts安全告警快照
npm每日下载、版本时间每日(约 2–3 天延迟)

首个版本做 GitHub + npm,其余来源按同一接口追加。

14 天窗口

GitHub 的 traffic 只保留最近 14 天,所以第一次运行就要开始存快照。30 天、90 天视图读本地存储,只画有记录的那段,不会把空缺画成 0。

访客是 14 天窗口内去重的人数,GitHub 不提供更长范围的人数,所以 30 天、90 天视图显示同一个值,并在访客下面标出去重窗口,不会因为切了范围就变少。

星数增长只算有记录的日期:窗口比储存的记录长时,按记录的首尾日期算,不会把没采集的日子当成 0。

路线

  • 页面与视觉规范
  • 本地存储与 GitHub / npm 抓取
  • 定时刷新与手动刷新
  • 面板内配置(AI 的 base URL 与 key)
  • AI 摘要,未配置时用模板
  • 摘要框里直接提问
  • npm 包归属核对,机器人 PR 不计入外部
  • 绑定 GitHub 账号,多仓切换与合计
  • 提问会自己查数据:跨仓比较、拉最新、给估算

License

MIT

Plugins relacionados