agent-steward 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (333) hide show
  1. package/CHANGELOG.md +376 -0
  2. package/CROSS_PLATFORM.md +149 -0
  3. package/README.md +306 -15
  4. package/ROADMAP-STRATEGY.md +147 -0
  5. package/ROADMAP.md +1069 -0
  6. package/dist/core/analytics.d.ts +132 -0
  7. package/dist/core/analytics.d.ts.map +1 -0
  8. package/dist/core/analytics.js +290 -0
  9. package/dist/core/audit.d.ts +96 -0
  10. package/dist/core/audit.d.ts.map +1 -0
  11. package/dist/core/audit.js +297 -0
  12. package/dist/core/cron-to-schtasks.d.ts +20 -0
  13. package/dist/core/cron-to-schtasks.d.ts.map +1 -0
  14. package/dist/core/cron-to-schtasks.js +250 -0
  15. package/dist/core/dry-run.d.ts +102 -0
  16. package/dist/core/dry-run.d.ts.map +1 -0
  17. package/dist/core/dry-run.js +447 -0
  18. package/dist/core/file-watcher.d.ts +31 -0
  19. package/dist/core/file-watcher.d.ts.map +1 -0
  20. package/dist/core/file-watcher.js +186 -0
  21. package/dist/core/git-trigger.d.ts +82 -0
  22. package/dist/core/git-trigger.d.ts.map +1 -0
  23. package/dist/core/git-trigger.js +312 -0
  24. package/dist/core/glob.d.ts +38 -0
  25. package/dist/core/glob.d.ts.map +1 -0
  26. package/dist/core/glob.js +233 -0
  27. package/dist/core/local-ai.d.ts +52 -0
  28. package/dist/core/local-ai.d.ts.map +1 -0
  29. package/dist/core/local-ai.js +119 -0
  30. package/dist/core/lock.d.ts +57 -0
  31. package/dist/core/lock.d.ts.map +1 -0
  32. package/dist/core/lock.js +195 -0
  33. package/dist/core/matrix.d.ts +167 -0
  34. package/dist/core/matrix.d.ts.map +1 -0
  35. package/dist/core/matrix.js +724 -0
  36. package/dist/core/native-notify.d.ts +36 -0
  37. package/dist/core/native-notify.d.ts.map +1 -0
  38. package/dist/core/native-notify.js +113 -0
  39. package/dist/core/one-shot.d.ts +68 -0
  40. package/dist/core/one-shot.d.ts.map +1 -0
  41. package/dist/core/one-shot.js +139 -0
  42. package/dist/core/otel.d.ts +4 -0
  43. package/dist/core/otel.d.ts.map +1 -0
  44. package/dist/core/otel.js +98 -0
  45. package/dist/core/permissions.d.ts +69 -0
  46. package/dist/core/permissions.d.ts.map +1 -0
  47. package/dist/core/permissions.js +143 -0
  48. package/dist/core/prometheus.d.ts +23 -0
  49. package/dist/core/prometheus.d.ts.map +1 -0
  50. package/dist/core/prometheus.js +146 -0
  51. package/dist/core/ps-wrapper.d.ts +73 -0
  52. package/dist/core/ps-wrapper.d.ts.map +1 -0
  53. package/dist/core/ps-wrapper.js +1071 -0
  54. package/dist/core/record-history.d.ts +25 -0
  55. package/dist/core/record-history.d.ts.map +1 -0
  56. package/dist/core/record-history.js +471 -0
  57. package/dist/core/retention.d.ts +29 -0
  58. package/dist/core/retention.d.ts.map +1 -0
  59. package/dist/core/retention.js +98 -0
  60. package/dist/core/savings.d.ts +70 -0
  61. package/dist/core/savings.d.ts.map +1 -0
  62. package/dist/core/savings.js +87 -0
  63. package/dist/core/schedule-gate.d.ts +2 -0
  64. package/dist/core/schedule-gate.d.ts.map +1 -0
  65. package/dist/core/schedule-gate.js +211 -0
  66. package/dist/core/schedule-v2.d.ts +116 -0
  67. package/dist/core/schedule-v2.d.ts.map +1 -0
  68. package/dist/core/schedule-v2.js +586 -0
  69. package/dist/core/scheduler/index.d.ts +32 -0
  70. package/dist/core/scheduler/index.d.ts.map +1 -0
  71. package/dist/core/scheduler/index.js +63 -0
  72. package/dist/core/scheduler/linux.d.ts +44 -0
  73. package/dist/core/scheduler/linux.d.ts.map +1 -0
  74. package/dist/core/scheduler/linux.js +225 -0
  75. package/dist/core/scheduler/logs.d.ts +11 -0
  76. package/dist/core/scheduler/logs.d.ts.map +1 -0
  77. package/dist/core/scheduler/logs.js +34 -0
  78. package/dist/core/scheduler/mac.d.ts +40 -0
  79. package/dist/core/scheduler/mac.d.ts.map +1 -0
  80. package/dist/core/scheduler/mac.js +207 -0
  81. package/dist/core/scheduler/posix.d.ts +40 -0
  82. package/dist/core/scheduler/posix.d.ts.map +1 -0
  83. package/dist/core/scheduler/posix.js +89 -0
  84. package/dist/core/scheduler/registry.d.ts +41 -0
  85. package/dist/core/scheduler/registry.d.ts.map +1 -0
  86. package/dist/core/scheduler/registry.js +57 -0
  87. package/dist/core/scheduler/types.d.ts +86 -0
  88. package/dist/core/scheduler/types.d.ts.map +1 -0
  89. package/dist/core/scheduler/types.js +1 -0
  90. package/dist/core/scheduler/windows.d.ts +99 -0
  91. package/dist/core/scheduler/windows.d.ts.map +1 -0
  92. package/dist/core/scheduler/windows.js +596 -0
  93. package/dist/core/secrets.d.ts +66 -0
  94. package/dist/core/secrets.d.ts.map +1 -0
  95. package/dist/core/secrets.js +433 -0
  96. package/dist/core/self-analysis.d.ts +117 -0
  97. package/dist/core/self-analysis.d.ts.map +1 -0
  98. package/dist/core/self-analysis.js +539 -0
  99. package/dist/core/self-analysis.test.d.ts +2 -0
  100. package/dist/core/self-analysis.test.d.ts.map +1 -0
  101. package/dist/core/self-analysis.test.js +219 -0
  102. package/dist/core/session.d.ts +42 -0
  103. package/dist/core/session.d.ts.map +1 -0
  104. package/dist/core/session.js +134 -0
  105. package/dist/core/shutdown.d.ts +26 -0
  106. package/dist/core/shutdown.d.ts.map +1 -0
  107. package/dist/core/shutdown.js +49 -0
  108. package/dist/core/structured-log.d.ts +84 -0
  109. package/dist/core/structured-log.d.ts.map +1 -0
  110. package/dist/core/structured-log.js +146 -0
  111. package/dist/core/summary.d.ts +69 -0
  112. package/dist/core/summary.d.ts.map +1 -0
  113. package/dist/core/summary.js +250 -0
  114. package/dist/core/telegram.d.ts +55 -0
  115. package/dist/core/telegram.d.ts.map +1 -0
  116. package/dist/core/telegram.js +344 -0
  117. package/dist/core/triage-chain.d.ts +40 -0
  118. package/dist/core/triage-chain.d.ts.map +1 -0
  119. package/dist/core/triage-chain.js +80 -0
  120. package/dist/core/triage-compare.d.ts +68 -0
  121. package/dist/core/triage-compare.d.ts.map +1 -0
  122. package/dist/core/triage-compare.js +184 -0
  123. package/dist/core/triage-rules.d.ts +23 -0
  124. package/dist/core/triage-rules.d.ts.map +1 -0
  125. package/dist/core/triage-rules.js +196 -0
  126. package/dist/core/triage-shadow.d.ts +91 -0
  127. package/dist/core/triage-shadow.d.ts.map +1 -0
  128. package/dist/core/triage-shadow.js +160 -0
  129. package/dist/core/triage-worker.d.ts +55 -0
  130. package/dist/core/triage-worker.d.ts.map +1 -0
  131. package/dist/core/triage-worker.js +314 -0
  132. package/dist/core/triage.d.ts +76 -0
  133. package/dist/core/triage.d.ts.map +1 -0
  134. package/dist/core/triage.js +271 -0
  135. package/dist/core/watch-paths.d.ts +6 -0
  136. package/dist/core/watch-paths.d.ts.map +1 -0
  137. package/dist/core/watch-paths.js +62 -0
  138. package/dist/core/wrappers/bash.d.ts +95 -0
  139. package/dist/core/wrappers/bash.d.ts.map +1 -0
  140. package/dist/core/wrappers/bash.js +413 -0
  141. package/dist/db/git-state-repo.d.ts +16 -0
  142. package/dist/db/git-state-repo.d.ts.map +1 -0
  143. package/dist/db/git-state-repo.js +38 -0
  144. package/dist/db/history-repo.d.ts +110 -0
  145. package/dist/db/history-repo.d.ts.map +1 -0
  146. package/dist/db/history-repo.js +300 -0
  147. package/dist/db/index.d.ts +47 -0
  148. package/dist/db/index.d.ts.map +1 -0
  149. package/dist/db/index.js +120 -0
  150. package/dist/db/metrics-repo.d.ts +46 -0
  151. package/dist/db/metrics-repo.d.ts.map +1 -0
  152. package/dist/db/metrics-repo.js +103 -0
  153. package/dist/db/migrate.d.ts +24 -0
  154. package/dist/db/migrate.d.ts.map +1 -0
  155. package/dist/db/migrate.js +244 -0
  156. package/dist/db/recovery.d.ts +11 -0
  157. package/dist/db/recovery.d.ts.map +1 -0
  158. package/dist/db/recovery.js +38 -0
  159. package/dist/db/schema.d.ts +24 -0
  160. package/dist/db/schema.d.ts.map +1 -0
  161. package/dist/db/schema.js +170 -0
  162. package/dist/db/settings-repo.d.ts +8 -0
  163. package/dist/db/settings-repo.d.ts.map +1 -0
  164. package/dist/db/settings-repo.js +27 -0
  165. package/dist/db/tasks-repo.d.ts +26 -0
  166. package/dist/db/tasks-repo.d.ts.map +1 -0
  167. package/dist/db/tasks-repo.js +120 -0
  168. package/dist/db/templates-repo.d.ts +17 -0
  169. package/dist/db/templates-repo.d.ts.map +1 -0
  170. package/dist/db/templates-repo.js +57 -0
  171. package/dist/gui-experimental.cjs +1 -0
  172. package/dist/history.d.ts +60 -0
  173. package/dist/history.d.ts.map +1 -0
  174. package/dist/history.js +70 -0
  175. package/dist/i18n.d.ts +75 -0
  176. package/dist/i18n.d.ts.map +1 -0
  177. package/dist/i18n.js +357 -0
  178. package/dist/index.d.ts +858 -0
  179. package/dist/index.d.ts.map +1 -0
  180. package/dist/index.js +5179 -0
  181. package/dist/integrations.d.ts +72 -0
  182. package/dist/integrations.d.ts.map +1 -0
  183. package/dist/integrations.js +233 -0
  184. package/dist/notifications.d.ts +199 -0
  185. package/dist/notifications.d.ts.map +1 -0
  186. package/dist/notifications.js +967 -0
  187. package/dist/profiles.d.ts +60 -0
  188. package/dist/profiles.d.ts.map +1 -0
  189. package/dist/profiles.js +227 -0
  190. package/dist/rpc.d.ts +3806 -0
  191. package/dist/rpc.d.ts.map +1 -0
  192. package/dist/rpc.js +1507 -0
  193. package/dist/schtasks.d.ts +32 -0
  194. package/dist/schtasks.d.ts.map +1 -0
  195. package/dist/schtasks.js +45 -0
  196. package/dist/server.d.ts +128 -0
  197. package/dist/server.d.ts.map +1 -0
  198. package/dist/server.js +2413 -0
  199. package/dist/settings.d.ts +389 -0
  200. package/dist/settings.d.ts.map +1 -0
  201. package/dist/settings.js +770 -0
  202. package/dist/shared/jobs-view.d.ts +59 -0
  203. package/dist/shared/jobs-view.d.ts.map +1 -0
  204. package/dist/shared/jobs-view.js +146 -0
  205. package/dist/skill.d.ts +15 -0
  206. package/dist/skill.d.ts.map +1 -0
  207. package/dist/skill.js +93 -0
  208. package/dist/task-transfer.d.ts +252 -0
  209. package/dist/task-transfer.d.ts.map +1 -0
  210. package/dist/task-transfer.js +628 -0
  211. package/dist/templates.d.ts +57 -0
  212. package/dist/templates.d.ts.map +1 -0
  213. package/dist/templates.js +16 -0
  214. package/dist/types.d.ts +96 -0
  215. package/dist/types.d.ts.map +1 -0
  216. package/dist/types.js +130 -0
  217. package/dist/version.d.ts +8 -0
  218. package/dist/version.d.ts.map +1 -0
  219. package/dist/version.js +27 -0
  220. package/dist/workspaces.d.ts +113 -0
  221. package/dist/workspaces.d.ts.map +1 -0
  222. package/dist/workspaces.js +393 -0
  223. package/docs/ARCHITECTURE.md +457 -0
  224. package/docs/COMPATIBILITY.md +233 -0
  225. package/docs/CONCEPT.md +230 -0
  226. package/docs/CROSS_PLATFORM.ru.md +150 -0
  227. package/docs/CROSS_PLATFORM.zh.md +146 -0
  228. package/docs/FAQ.md +52 -0
  229. package/docs/FAQ.ru.md +53 -0
  230. package/docs/FAQ.zh.md +43 -0
  231. package/docs/FEATURES.md +698 -0
  232. package/docs/FEATURES.zh.md +655 -0
  233. package/docs/LOCAL-AI.md +300 -0
  234. package/docs/MIGRATION.md +355 -0
  235. package/docs/README.ru.md +268 -0
  236. package/docs/README.zh.md +305 -0
  237. package/docs/SAVINGS.md +61 -0
  238. package/docs/SAVINGS.ru.md +60 -0
  239. package/docs/SAVINGS.zh.md +52 -0
  240. package/docs/V1-V2-COMPATIBILITY-PLAN.md +366 -0
  241. package/docs/ZH-LOCALE-PLAN.md +324 -0
  242. package/docs/dashboard.png +0 -0
  243. package/docs/spikes/local-model-structured-output.md +81 -0
  244. package/docs/spikes/ollama-qwen3-4b-smoke.json +28 -0
  245. package/docs/spikes/ollama-qwen3-4b.json +163 -0
  246. package/gui-experimental.cjs +9 -0
  247. package/index.js +1 -0
  248. package/locales/en.json +780 -0
  249. package/locales/ru.json +780 -0
  250. package/locales/zh.json +780 -0
  251. package/package.json +133 -13
  252. package/scripts/bench-local.mjs +321 -0
  253. package/scripts/check-zh-locale.mjs +218 -0
  254. package/scripts/demo-dashboard.mjs +209 -0
  255. package/scripts/run-tests.mjs +236 -0
  256. package/scripts/spike-local-structured.mjs +182 -0
  257. package/scripts/test-locale.mjs +45 -0
  258. package/skills/scheduled-job-best-practices/SKILL.md +158 -0
  259. package/skills/scheduled-job-best-practices/references/recipes.md +163 -0
  260. package/src/core/analytics.ts +424 -0
  261. package/src/core/audit.ts +418 -0
  262. package/src/core/cron-to-schtasks.ts +288 -0
  263. package/src/core/dry-run.ts +601 -0
  264. package/src/core/file-watcher.ts +245 -0
  265. package/src/core/git-trigger.ts +391 -0
  266. package/src/core/glob.ts +226 -0
  267. package/src/core/local-ai.ts +173 -0
  268. package/src/core/lock.ts +219 -0
  269. package/src/core/matrix.ts +947 -0
  270. package/src/core/native-notify.ts +157 -0
  271. package/src/core/one-shot.ts +189 -0
  272. package/src/core/otel.ts +128 -0
  273. package/src/core/permissions.ts +200 -0
  274. package/src/core/prometheus.ts +215 -0
  275. package/src/core/ps-wrapper.ts +1140 -0
  276. package/src/core/record-history.ts +615 -0
  277. package/src/core/retention.ts +141 -0
  278. package/src/core/savings.ts +150 -0
  279. package/src/core/schedule-gate.ts +253 -0
  280. package/src/core/schedule-v2.ts +668 -0
  281. package/src/core/scheduler/index.ts +82 -0
  282. package/src/core/scheduler/linux.ts +257 -0
  283. package/src/core/scheduler/logs.ts +37 -0
  284. package/src/core/scheduler/mac.ts +270 -0
  285. package/src/core/scheduler/posix.ts +114 -0
  286. package/src/core/scheduler/registry.ts +99 -0
  287. package/src/core/scheduler/types.ts +90 -0
  288. package/src/core/scheduler/windows.ts +711 -0
  289. package/src/core/secrets.ts +503 -0
  290. package/src/core/self-analysis.ts +744 -0
  291. package/src/core/session.ts +150 -0
  292. package/src/core/shutdown.ts +69 -0
  293. package/src/core/structured-log.ts +214 -0
  294. package/src/core/summary.ts +318 -0
  295. package/src/core/telegram.ts +436 -0
  296. package/src/core/triage-chain.ts +125 -0
  297. package/src/core/triage-compare.ts +277 -0
  298. package/src/core/triage-rules.ts +238 -0
  299. package/src/core/triage-shadow.ts +240 -0
  300. package/src/core/triage-worker.ts +344 -0
  301. package/src/core/triage.ts +366 -0
  302. package/src/core/watch-paths.ts +70 -0
  303. package/src/core/wrappers/bash.ts +532 -0
  304. package/src/db/git-state-repo.ts +62 -0
  305. package/src/db/history-repo.ts +492 -0
  306. package/src/db/index.ts +166 -0
  307. package/src/db/metrics-repo.ts +170 -0
  308. package/src/db/migrate.ts +328 -0
  309. package/src/db/recovery.ts +46 -0
  310. package/src/db/schema.ts +188 -0
  311. package/src/db/settings-repo.ts +31 -0
  312. package/src/db/tasks-repo.ts +162 -0
  313. package/src/db/templates-repo.ts +77 -0
  314. package/src/gui.tsx +5222 -0
  315. package/src/history.ts +128 -0
  316. package/src/i18n.ts +413 -0
  317. package/src/index.ts +6605 -0
  318. package/src/integrations.ts +297 -0
  319. package/src/notifications.ts +1346 -0
  320. package/src/profiles.ts +254 -0
  321. package/src/rpc.ts +1609 -0
  322. package/src/schtasks.ts +75 -0
  323. package/src/server.ts +2662 -0
  324. package/src/settings.ts +1369 -0
  325. package/src/shared/jobs-view.ts +188 -0
  326. package/src/skill.ts +113 -0
  327. package/src/task-transfer.ts +944 -0
  328. package/src/templates.ts +67 -0
  329. package/src/tui-v1.tsx +341 -0
  330. package/src/tui.tsx +329 -0
  331. package/src/types.ts +191 -0
  332. package/src/version.ts +27 -0
  333. package/src/workspaces.ts +487 -0
@@ -0,0 +1,146 @@
1
+ # 跨平台:Windows → macOS → Linux
2
+
3
+ 插件已不再绑定 `schtasks`。调度器被抽象成一层接口,有三种实现,运行包装脚本按目标操作系统生成。
4
+
5
+ Translations: [English](../CROSS_PLATFORM.md) · [Русский](CROSS_PLATFORM.ru.md)
6
+
7
+ ## 架构
8
+
9
+ ```
10
+ src/
11
+ index.ts # 工具、RPC、插件生命周期
12
+ gui.tsx # GUI 面板(标题来自 RPC)
13
+ server.ts # Web 仪表盘(动态标题)
14
+ core/
15
+ scheduler/
16
+ types.ts # SchedulerBackend、CreateTaskOptions、RunTaskResult
17
+ index.ts # 工厂 createSchedulerBackend() + getSchedulerTitle()
18
+ windows.ts # WindowsScheduler (schtasks)
19
+ linux.ts # LinuxScheduler (crontab)
20
+ mac.ts # MacScheduler (launchd / LaunchAgents)
21
+ posix.ts # Linux/macOS 共享基类(任务注册表)
22
+ registry.ts # POSIX 后端的持久化任务注册表
23
+ logs.ts # 跨平台任务日志读取
24
+ wrappers/
25
+ bash.ts # Linux/macOS 的 .sh 包装脚本生成器
26
+ ps-wrapper.ts # Windows 的 .ps1/.cmd 包装脚本(未变)
27
+ record-history.ts # 指标/历史 + 重试/链式任务(通过后端)
28
+ cron-to-schtasks.ts # cron → schtasks(仅 Windows)
29
+ ```
30
+
31
+ ### 接口
32
+
33
+ ```ts
34
+ interface SchedulerBackend {
35
+ readonly platform: NodeJS.Platform;
36
+ readonly title: string; // "Windows 任务计划程序" / "OpenCode Scheduler"
37
+ createTask(options: CreateTaskOptions): Promise<void>;
38
+ deleteTask(name: string): Promise<void>;
39
+ runTask(name: string): Promise<RunTaskResult>;
40
+ listTasks(): Promise<ScheduledTaskInfo[]>;
41
+ pauseTask(name: string): Promise<void>;
42
+ resumeTask(name: string): Promise<void>;
43
+ }
44
+ ```
45
+
46
+ 工厂按 `process.platform` 选择实现:
47
+ `win32 → WindowsScheduler`,`darwin → MacScheduler`,其余 → `LinuxScheduler`。
48
+
49
+ ## 各操作系统的运行方式
50
+
51
+ ### Windows(行为未变)
52
+ - 任务通过 `schtasks` 注册到 Windows 任务计划程序的 `\OpenCode\windows-scheduler\` 文件夹。
53
+ - 包装脚本:`run-task.ps1` 加每个任务专属的 `run-<name>.cmd`,位于 `%APPDATA%\opencode\windows-scheduler\wrapper`。
54
+ - 日志:`%APPDATA%\opencode\windows-scheduler\logs\<name>.log`。
55
+ - cron 会转换成 schtasks(`convertCronToSchTasks`)——支持与之前相同的模板集合。
56
+
57
+ ### Linux
58
+ - 任务保存在受管 `crontab` 块中:
59
+ ```
60
+ # >>> opencode-scheduler >>>
61
+ # task: my-task
62
+ */5 * * * * /bin/bash '/…/wrapper/run-my-task.sh' >> '/…/logs/my-task.log' 2>&1
63
+ # <<< opencode-scheduler <<<
64
+ ```
65
+ - 暂停 = 带 `# PAUSED: ` 前缀的行(块会从注册表重建)。
66
+ - `file` 触发器的任务不会进入 crontab——由插件的 FileWatchManager 启动。
67
+ - 包装脚本:`~/.config/opencode/windows-scheduler/wrapper/run-<name>.sh`(chmod 0755)。
68
+ - 支持完整 cron 语法(与 Windows 不同),因为 crontab 原生支持。
69
+ - 删除/重建只触及自己的块,`crontab` 的其他行不受影响。
70
+
71
+ ### macOS
72
+ - 任务是 LaunchAgent plist:`~/Library/LaunchAgents/com.opencode.scheduler.<name>.plist`。
73
+ - 调度:`* * * * *` 和 `*/N` 使用 `StartInterval`,`M * * * *`、`M H * * *`、`M H * * D`
74
+ 使用 `StartCalendarInterval`。
75
+ - 暂停 = `launchctl unload -w`,恢复 = `launchctl load -w`。
76
+ - 包装脚本与 Linux 相同的 `.sh`;配置路径:
77
+ `~/.config/opencode/windows-scheduler/`(或 `$XDG_CONFIG_HOME`)。
78
+
79
+ ### 共享 POSIX 包装脚本(`.sh`)
80
+ - `cd` 到工作目录,用文件中的提示词执行 `opencode run`。
81
+ - 日志通过 `>>` 追加,并带时间戳。
82
+ - 通过原子 `mkdir` 加锁——防止并行运行。
83
+ - 超时:子进程 + 看门狗(先 `TERM`,再 `KILL`)。
84
+ - Quality Gate:`bash -lc "<命令>"`(相当于 Windows 上的 `cmd.exe /c`)。
85
+ - 指标:`node "<record-history.js>" <task> <status> <started> <duration> <error> "-" "-"`——
86
+ 与 PowerShell 包装脚本相同的契约,因此历史/指标/重试/链式任务在各平台通用。
87
+ - `PATH` 追加 `/opt/homebrew/bin`、`/usr/local/bin`、`~/.local/bin`、`~/.bun/bin`。
88
+
89
+ ## 功能矩阵
90
+
91
+ | 能力 | Windows | Linux | macOS |
92
+ |---|---|---|---|
93
+ | 调度后端 | `schtasks` | `crontab` | `launchd` LaunchAgents |
94
+ | 原生 cron 子集 | `* * * * *`、`*/N * * * *`(N ≤ 1439,60 % N = 0)、`M * * * *`、`M H * * *`、`M H * * D` | 完整 cron | 与 Windows 相同的子集 |
95
+ | 其他 cron 表达式 | 分钟轮询 + schedule gate | 原生 cron | 分钟轮询 + schedule gate |
96
+ | 月/周字段中的 `*/N` | 非原生 → 轮询 | 原生 | 非原生 → 轮询 |
97
+ | 暂停 / 恢复 | `schtasks /change /disable` / `/enable` | 托管块中的 `# PAUSED:` 行 | `launchctl unload -w` / `load -w` |
98
+ | 文件触发器 | 进程内 `FileWatchManager` | 相同 | 相同 |
99
+ | 任务包装脚本 | `.cmd` + `.ps1` | `.sh` | `.sh` |
100
+ | 日志 | `%APPDATA%\opencode\windows-scheduler\logs` | `~/.config/opencode/windows-scheduler/logs` | 与 Linux 相同 |
101
+ | `secrets.key` 保护 | `icacls`(仅所有者)+ `chmod` 回退 | `chmod 0600` | `chmod 0600` |
102
+ | 仪表盘 | `127.0.0.1`,动态标题 | 相同 | 相同 |
103
+ | DAG / matrix / quality gates / 通知 | 插件内,与操作系统无关 | 相同 | 相同 |
104
+
105
+ ### 折衷
106
+
107
+ 1. **分钟轮询。** 原生子集之外的 cron 表达式,以及使用非系统 IANA 时区的任务,
108
+ 由操作系统调度器每分钟启动一次;`schedule-gate` 决定是否真正执行。
109
+ 代价是每个任务每分钟一个短生命周期的包装进程。
110
+ 2. **`M H */N * *` 故意不转换为 `schtasks /sc DAILY /mo N`。**
111
+ cron 从每月 1 日开始计数,并在月初重置;`/mo N` 从任务创建日期开始计数,
112
+ 不会在月初重置。两者并不等价,因此该表达式保持轮询模式。
113
+ 若要原生支持,应使用 `MONTHLY` 加显式 `/d` 列表,而不是 `DAILY /mo N`。
114
+ 3. **DST。** 网关按本地墙上时间工作。不存在的时间(春季前进)会被跳过;
115
+ 有歧义的时间(秋季回拨)在第一次出现时执行。
116
+ 4. **Windows 上的 `*/N * * * *`** 仅在 `60 % N = 0` 且 `N ≤ 1439` 时原生支持。
117
+ 否则回退到轮询:`schtasks /mo N` 从创建时刻计数,而 cron 从整点开始计数。
118
+ 5. **POSIX 包装脚本、crontab 和 launchd 尚未在真实 Linux/macOS 主机上执行**
119
+ (见“限制”);语法和转义仅由测试覆盖。
120
+
121
+ ## GUI 与仪表盘
122
+ - 标题是动态的:Windows 上为「Windows 任务计划程序」,macOS/Linux 上为「OpenCode Scheduler」。
123
+ - 标题来自 RPC 方法 `get_platform` → `{ platform, title }`。
124
+ - 标题同时用于 GUI 面板、错误回退面板和仪表盘的 `<title>/<h1>`。
125
+ - 按钮、状态、表格、DAG 和指标与操作系统无关。
126
+ - 工具描述(`schedule_task` 等)会替换为实际调度器名称。
127
+
128
+ ## 构建与检查
129
+ - `npm run build` — 通过,无错误。
130
+ - `npm run build:gui` — 通过(`gui-experimental.cjs`,约 47.7 kB)。
131
+ - 运行时已验证:
132
+ - win32/darwin/linux 的标题;
133
+ - 多个表达式上的 `cronToLaunchdSchedule`;
134
+ - Windows 上真实的 `listTasks()`——返回短任务名(无前缀);
135
+ - `shellQuote` 转义(引号、空格、西里尔字母);
136
+ - `dist/index.js` 可导入,`dist` 不直接引用 `schtasks.js`。
137
+
138
+ ## 限制与需要在真实机器上验证的内容
139
+ 1. `.sh` 包装脚本和 crontab/launchd **从未实际执行**——当前 Windows 机器没有 `bash`/WSL。
140
+ 语法和转义是手工检查的;仍需在 Linux 和 macOS 上跑一遍。
141
+ 2. cron → launchd 支持与 Windows 相同的有限模板集合
142
+ (`* * * * *`、`*/N * * * *`、`M * * * *`、`M H * * *`、`M H * * D`)。
143
+ Linux 上支持完整 cron。
144
+ 3. Windows 任务前缀(`\OpenCode\windows-scheduler\`)和插件 id 为向后兼容而保留。
145
+ 4. `src/schtasks.ts` 保留为旧脚本(`test-create.cjs`、`test-run.cjs`)的薄垫片;
146
+ 所有逻辑现在都在 `core/scheduler/windows.ts`。
package/docs/FAQ.md ADDED
@@ -0,0 +1,52 @@
1
+ # FAQ
2
+
3
+ Frequently asked questions and recovery scenarios. The English version of the
4
+ secrets section is also in [FEATURES.md](FEATURES.md#recovering-a-quarantined-secrets-store).
5
+
6
+ Translations: [Русский](FAQ.ru.md) · [中文](FAQ.zh.md)
7
+
8
+ ## Contents
9
+
10
+ - [Recovering secrets after a `.corrupt-*` quarantine](#recovering-secrets-after-a-corrupt--quarantine)
11
+ - [Webhook triggers: can a request be replayed?](#webhook-triggers-can-a-request-be-replayed)
12
+
13
+ ## Recovering secrets after a `.corrupt-*` quarantine
14
+
15
+ Quarantine triggers when `secrets.json` cannot be parsed (an interrupted write or
16
+ manual editing). The file is **not deleted** — it is renamed to
17
+ `secrets.json.corrupt-<timestamp>` next to the original. This is a side effect of a
18
+ read operation; recovery is **manual by design** so that no automatic rewrite can
19
+ destroy data.
20
+
21
+ Recovery steps:
22
+
23
+ 1. Find the file in the plugin directory: `%APPDATA%\opencode\windows-scheduler\`
24
+ (Windows) or `~/.config/opencode/windows-scheduler/` (macOS/Linux, or
25
+ `$XDG_CONFIG_HOME`).
26
+ 2. Open it in an editor: it is usually truncated JSON. Fix the syntax.
27
+ 3. Copy the fixed file back as `secrets.json` (keep the `.corrupt-*` copy as a
28
+ backup) and verify with `manage_secrets` (`action: "list"`).
29
+ 4. If the file cannot be repaired, re-set the secrets (`manage_secrets`,
30
+ `action: "set"`). Values encrypted with a lost `secrets.key` cannot be recovered
31
+ — re-enter them.
32
+ 5. Rare case: the rename failed and writes stay blocked ("Writing new secrets is
33
+ blocked"). Move the broken file away manually, then re-set the secrets.
34
+
35
+ ## Webhook triggers: can a request be replayed?
36
+
37
+ Yes — in both remaining authentication modes requests are replayable, so replay
38
+ protection is the sender's responsibility:
39
+
40
+ - **Signature without `timestampToleranceSeconds` (= 0, legacy).** The HMAC covers
41
+ only the body, so an intercepted request can be replayed forever. Set a non-zero
42
+ tolerance and send `X-Scheduler-Timestamp`: the signature then covers
43
+ `<timestamp>.<body>` and a request outside the window is rejected.
44
+ - **Token-only mode.** A token is also replayable — the scheduler cannot tell a
45
+ repeat from an attack. If you cannot switch to signatures: keep the token in CI
46
+ secrets, rotate it regularly, issue one token per task, and make the task
47
+ idempotent.
48
+ - **GitHub Actions** does not send `X-Scheduler-Timestamp` itself, so
49
+ `X-Hub-Signature-256` runs in legacy mode. Sign `<timestamp>.<body>` in a separate
50
+ workflow step with the shared secret.
51
+ - The scheduler keeps no replay cache — deduplicating unique requests is the
52
+ sender's responsibility.
package/docs/FAQ.ru.md ADDED
@@ -0,0 +1,53 @@
1
+ # FAQ
2
+
3
+ Частые вопросы и восстановительные сценарии. Английская версия этого раздела —
4
+ в [FEATURES.md](FEATURES.md#recovering-a-quarantined-secrets-store).
5
+
6
+ Translations: [English](FAQ.md) · [中文](FAQ.zh.md)
7
+
8
+ ## Содержание
9
+
10
+ - [Восстановление секретов после карантина `.corrupt-*`](#восстановление-секретов-после-карантина-corrupt-)
11
+ - [Webhook-триггеры: можно ли переиграть запрос (replay)?](#webhook-триггеры-можно-ли-переиграть-запрос-replay)
12
+
13
+ ## Восстановление секретов после карантина `.corrupt-*`
14
+
15
+ Карантин срабатывает, когда `secrets.json` не парсится (обрыв записи,
16
+ ручное редактирование). Файл **не удаляется**, а переименовывается в
17
+ `secrets.json.corrupt-<метка времени>` рядом с оригиналом. Это побочный эффект
18
+ операции чтения — автоматического восстановления нет, чтобы ничто не могло
19
+ затереть данные.
20
+
21
+ Порядок восстановления:
22
+
23
+ 1. Найдите файл в каталоге плагина: `%APPDATA%\opencode\windows-scheduler\`
24
+ (Windows) или `~/.config/opencode/windows-scheduler/` (macOS/Linux,
25
+ либо `$XDG_CONFIG_HOME`).
26
+ 2. Откройте его в редакторе: обычно это обрезанный JSON. Исправьте синтаксис.
27
+ 3. Верните исправленный файл под именем `secrets.json` (копию `.corrupt-*`
28
+ оставьте как бэкап) и проверьте `manage_secrets` (`action: "list"`).
29
+ 4. Если файл не восстанавливается — задайте секреты заново
30
+ (`manage_secrets`, `action: "set"`). Значения, зашифрованные утерянным
31
+ `secrets.key`, восстановить нельзя — только повторный ввод.
32
+ 5. Редкий случай: rename не удался и запись заблокирована
33
+ («Запись новых секретов заблокирована»). Уберите битый файл вручную
34
+ (переместите в сторону), затем задайте секреты заново.
35
+
36
+ ## Webhook-триггеры: можно ли переиграть запрос (replay)?
37
+
38
+ Да, в обоих оставшихся режимах аутентификации запросы replayable — защита от
39
+ повтора лежит на отправителе:
40
+
41
+ - **Подпись без `timestampToleranceSeconds` (= 0, legacy).** HMAC покрывает
42
+ только тело — перехваченный запрос можно переиграть бесконечно. Задайте
43
+ ненулевой tolerance и шлите `X-Scheduler-Timestamp`: подпись будет покрывать
44
+ `<timestamp>.<body>`, и запрос вне окна перестанет приниматься.
45
+ - **Token-only режим.** Токен тоже replayable — планировщик не отличит повтор
46
+ от атаки. Если перейти на подпись нельзя: храните токен в секретах CI,
47
+ регулярно ротируйте, выдавайте по одному на задачу и делайте задачу
48
+ идемпотентной.
49
+ - **GitHub Actions** сам `X-Scheduler-Timestamp` не присылает, поэтому
50
+ `X-Hub-Signature-256` работает в legacy-режиме. Подписывайте
51
+ `<timestamp>.<body>` отдельным шагом workflow общим секретом.
52
+ - Планировщик не ведёт кэш повторов — дедупликация уникальных запросов на
53
+ стороне отправителя.
package/docs/FAQ.zh.md ADDED
@@ -0,0 +1,43 @@
1
+ # 常见问题
2
+
3
+ 常见问题与恢复场景。
4
+
5
+ Translations: [English](FAQ.md) · [Русский](FAQ.ru.md)
6
+
7
+ ## 目录
8
+
9
+ - [`.corrupt-*` 隔离后如何恢复密钥](#隔离后如何恢复密钥)
10
+ - [Webhook 触发器:请求会被重放吗?](#webhook-触发器请求会被重放吗)
11
+
12
+ ## 隔离后如何恢复密钥
13
+
14
+ 当 `secrets.json` 无法解析(写入被中断或手工编辑)时触发隔离。文件**不会被删除**,
15
+ 而是重命名为同目录下的 `secrets.json.corrupt-<时间戳>`。这是读取操作的副作用;
16
+ 恢复**按设计是手工的**,以免任何自动重写破坏数据。
17
+
18
+ 恢复步骤:
19
+
20
+ 1. 在插件目录中找到该文件:`%APPDATA%\opencode\windows-scheduler\`(Windows)
21
+ 或 `~/.config/opencode/windows-scheduler/`(macOS/Linux,或 `$XDG_CONFIG_HOME`)。
22
+ 2. 用编辑器打开:通常是截断的 JSON,修正语法。
23
+ 3. 把修好的文件复制回 `secrets.json`(保留 `.corrupt-*` 副本作为备份),
24
+ 用 `manage_secrets`(`action: "list"`)验证。
25
+ 4. 如果文件无法修复,重新设置密钥(`manage_secrets`,`action: "set"`)。
26
+ 用丢失的 `secrets.key` 加密的值无法恢复——请重新输入。
27
+ 5. 罕见情况:重命名失败且写入被阻止("Writing new secrets is blocked")。
28
+ 手工移走损坏文件,然后重新设置密钥。
29
+
30
+ ## Webhook 触发器:请求会被重放吗?
31
+
32
+ 会——在两种剩余认证模式下请求都可被重放,因此防重放是发送方的责任:
33
+
34
+ - **带签名但未设置 `timestampToleranceSeconds`(= 0,旧模式)。** HMAC 只覆盖请求体,
35
+ 被截获的请求可以永远重放。设置非零容忍窗口并发送 `X-Scheduler-Timestamp`:
36
+ 签名随后覆盖 `<timestamp>.<body>`,窗口之外的请求会被拒绝。
37
+ - **仅 Token 模式。** Token 同样可被重放——调度器无法区分重复请求和攻击。
38
+ 如果无法切换到签名:把 Token 放在 CI secrets 中,定期轮换,每个任务单独签发,
39
+ 并让任务幂等。
40
+ - **GitHub Actions** 自己不发送 `X-Scheduler-Timestamp`,因此
41
+ `X-Hub-Signature-256` 以旧模式运行。可在单独的 workflow 步骤中用共享密钥
42
+ 对 `<timestamp>.<body>` 签名。
43
+ - 调度器不保留重放缓存——对唯一请求去重是发送方的责任。