使用
授权:获取并配置 PAT
本应用与官方 gitee-cli 一致,使用 Gitee 个人访问令牌(Personal Access Token) 授权,不走 OAuth:
- 登录 Gitee → 头像 → 设置 → 安全设置 → 私人令牌 (或直接打开 gitee.com/profile/personal_access_tokens);
- 生成新令牌,勾选权限:user_info 与 projects(无需其他权限);
- 启动 Gitee Monitor → 托盘右键菜单「设置…」→ 粘贴令牌 → 「校验并保存」。
令牌只保存在本机(macOS/Linux: ~/.config/gitee-monitor/credentials.yml, Windows: %AppData%\gitee-monitor\,权限 0600),仅用于本机直连 Gitee 接口。 也可以用环境变量 GITEE_TOKEN 代替(优先级更高)。
添加监控仓库
设置窗口支持两种方式,可叠加使用:
- 显式仓库列表(
repos):逐个指定owner/repo/ref;ref留空 = 跟随流水线文件的全部分支; - 正则模式(
patterns):按owner列出正则,对仓库名整名匹配,批量纳入监控。
正则模式规则:
- 仓库名按整名匹配(自动加
^$锚定);想子串匹配请写.*app-svc.*; owner支持组织、个人空间、企业空间三种(自动探测对应 v5 端点);匹配与请求使用 仓库 URL 路径名(企业仓库的中文显示名不参与匹配);- 显式
repos与 pattern 命中同一仓库时,以显式条目为准(含其ref); - pattern 命中但未开通 Gitee Go 的仓库自动跳过,不算错误;
- 不设匹配数量上限:宽泛正则会把该 owner 下所有开通流水线的仓库纳入轮询,请谨慎书写;
- 设置窗口提供「预览匹配结果」,保存前可核对实际命中的仓库。
刷新与缓存行为
- 托盘图标与面板展示最新一次构建的状态;仅当存在运行中的构建时才定时轮询 (间隔
intervals.runningSeconds,默认 10 秒,逐级查询 流水线 → 阶段 → 作业), 构建结束自动停止,空闲时不发任何请求; - 右键菜单「立即刷新」只刷新现有监控项的构建状态,不会重新发现流水线;
- 监控哪些仓库的哪些流水线(正则命中仓库、各仓库的流水线文件 × 分支)缓存在
matched_repos.yml,仅在应用启动与保存配置(含登录/登出)时重新探测—— 新增/删除流水线文件或分支、新建符合 pattern 的仓库,需重启应用或改一次配置后才会出现在面板。
托盘与面板
- 托盘图标五色:绿=成功、红=失败、黄=运行中、灰=无构建、橙=错误;
- 左键托盘弹出状态面板:每个监控项显示状态、分支、构建号、耗时、commit 摘要、相对时间, 可展开最近 5 次构建历史;点击条目打开对应仓库的 Gitee Go 页面;
- 右键托盘菜单:立即刷新 / 设置… / 打开 Gitee / 退出。
通知与自启
- 构建失败、失败恢复成功时弹系统原生通知,可在配置中分别开关;
- 开机自启:macOS SMAppService/LaunchAgent、Windows 注册表 Run、Linux XDG autostart,均可开关。
命令行
bash
gitee-monitor -version # 版本
gitee-monitor --check # 无 GUI 连通性自检:校验 token、逐仓库探测流水线与最近构建配置文件参考
config.yml(与 credentials.yml 同目录):
yaml
intervals:
runningSeconds: 10 # 有构建运行中时的轮询间隔(空闲时不自动请求)
notifications:
onFailure: true # 构建失败通知
onRecovery: true # 失败恢复成功通知
autostart: false
repos: # 监控仓库列表;ref 留空 = 跟随流水线文件的全部分支
- owner: oschina
repo: gitee-cli
ref: master
patterns: # 正则模式(可选):按 owner 列仓库,对仓库名整名正则匹配
- owner: my-org
repo: "^app-svc-.*" # 命中 my-org 下所有 app-svc- 开头的仓库
# ref: master # 可选:统一钉住命中仓库的分支高级选项
go_api_host / v5_base 两个可选项见设置窗口「高级」,网关地址变更时无需改代码。