taphound 0.2.0-dev.1 → 0.2.0-dev.12

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 (467) hide show
  1. package/README.md +49 -149
  2. package/README.zh-CN.md +47 -147
  3. package/assets/skills/taphound-case-suite/SKILL.md +363 -0
  4. package/assets/skills/taphound-case-suite/schemas/base-flow-record.schema.json +22 -0
  5. package/assets/skills/taphound-case-suite/schemas/case-catalog.schema.json +26 -0
  6. package/assets/skills/taphound-case-suite/schemas/case-ledger.schema.json +158 -0
  7. package/assets/skills/taphound-case-suite/schemas/suite-input.schema.json +41 -0
  8. package/assets/skills/taphound-case-suite/schemas/transition.schema.json +61 -0
  9. package/assets/skills/taphound-case-suite/scripts/ledger.mjs +1207 -0
  10. package/assets/skills/taphound-case-suite/templates/base-flow-record.example.json +20 -0
  11. package/assets/skills/taphound-case-suite/templates/suite-input.example.json +27 -0
  12. package/assets/skills/taphound-case-suite/templates/transition.example.json +8 -0
  13. package/assets/skills/taphound-flash/SKILL.md +115 -0
  14. package/assets/skills/taphound-flash/scripts/flash.mjs +585 -0
  15. package/assets/skills/taphound-flash/templates/flash-plan.example.json +15 -0
  16. package/assets/skills/taphound-journey-brief-author/CONTEXT-GUIDE.md +471 -0
  17. package/assets/skills/taphound-journey-brief-author/SKILL.md +494 -0
  18. package/assets/skills/taphound-journey-brief-author/prompts/brief-author-role.md +96 -0
  19. package/assets/skills/taphound-journey-brief-author/prompts/brief-author-role.zh-CN.md +80 -0
  20. package/assets/skills/taphound-journey-brief-author/prompts/context-analyze-project.md +309 -0
  21. package/assets/skills/taphound-journey-brief-author/schemas/context-refresh-result.json +123 -0
  22. package/assets/skills/taphound-journey-brief-author/schemas/project-context-module.json +192 -0
  23. package/assets/skills/taphound-journey-brief-author/schemas/project-context.json +152 -0
  24. package/assets/skills/taphound-journey-brief-author/templates/project-context-module.example.json +58 -0
  25. package/assets/skills/taphound-journey-brief-author/templates/project-context.example.json +51 -0
  26. package/assets/skills/taphound-journey-brief-author/templates/taphound-journey-brief.template.md +63 -0
  27. package/assets/skills/taphound-journey-generator/SKILL.md +507 -0
  28. package/assets/skills/{taphound-ai-journey → taphound-journey-generator}/prompts/check-completion.md +3 -0
  29. package/assets/skills/taphound-journey-generator/prompts/consume-journey-brief.md +52 -0
  30. package/assets/skills/taphound-journey-generator/prompts/generate-step.md +211 -0
  31. package/assets/skills/taphound-journey-generator/prompts/select-flow.md +91 -0
  32. package/assets/skills/taphound-journey-generator/references/bridge.md +35 -0
  33. package/assets/skills/taphound-journey-generator/references/mid-session.md +44 -0
  34. package/assets/skills/taphound-journey-generator/schemas/external-flow.json +37 -0
  35. package/assets/skills/taphound-journey-generator/schemas/flow.json +28 -0
  36. package/assets/skills/taphound-journey-generator/schemas/journey-source.json +25 -0
  37. package/assets/skills/{taphound-ai-journey → taphound-journey-generator}/schemas/observe-output.json +13 -4
  38. package/assets/skills/{taphound-ai-journey → taphound-journey-generator}/schemas/proposed-step-envelope.json +127 -5
  39. package/assets/skills/taphound-journey-generator/scripts/envelope.mjs +578 -0
  40. package/assets/skills/taphound-journey-generator/templates/external-flow.example.json +22 -0
  41. package/assets/skills/taphound-journey-generator/templates/flow.example.json +22 -0
  42. package/assets/skills/taphound-journey-generator/templates/journey-source.example.json +17 -0
  43. package/assets/skills/taphound-journey-generator/templates/taphound-journey-brief.example.md +70 -0
  44. package/assets/skills/taphound-verify-change/SKILL.md +91 -0
  45. package/assets/skills/taphound-verify-change/references/accept.md +38 -0
  46. package/assets/skills/taphound-verify-change/references/preserve.md +357 -0
  47. package/assets/skills/taphound-verify-change/schemas/workflow-manifest.schema.json +295 -0
  48. package/assets/skills/taphound-verify-change/scripts/handoff.mjs +482 -0
  49. package/assets/skills/taphound-verify-change/scripts/ui-refactor.mjs +505 -0
  50. package/dist/adapters/adb/adb-adapter.d.ts +16 -2
  51. package/dist/adapters/adb/adb-adapter.js +199 -0
  52. package/dist/adapters/adb/system-uiautomator-snapshot-provider.d.ts +13 -0
  53. package/dist/adapters/adb/system-uiautomator-snapshot-provider.js +122 -0
  54. package/dist/adapters/adb/ui-automator-parser.d.ts +3 -0
  55. package/dist/adapters/adb/ui-automator-parser.js +160 -0
  56. package/dist/adapters/adb/window-topology-parser.d.ts +2 -0
  57. package/dist/adapters/adb/window-topology-parser.js +101 -0
  58. package/dist/adapters/android-cli/android-cli-adapter.d.ts +16 -8
  59. package/dist/adapters/android-cli/android-cli-adapter.js +137 -15
  60. package/dist/adapters/android-cli/android-cli-snapshot-provider.d.ts +9 -0
  61. package/dist/adapters/android-cli/android-cli-snapshot-provider.js +99 -0
  62. package/dist/adapters/android-cli/layout-parser.js +12 -8
  63. package/dist/adapters/appium/appium-doctor.d.ts +7 -0
  64. package/dist/adapters/appium/appium-doctor.js +128 -0
  65. package/dist/adapters/appium/appium-ui-snapshot-provider.d.ts +42 -0
  66. package/dist/adapters/appium/appium-ui-snapshot-provider.js +309 -0
  67. package/dist/adapters/camera/camera-probe-adapter.d.ts +18 -0
  68. package/dist/adapters/camera/camera-probe-adapter.js +286 -0
  69. package/dist/adapters/filesystem/artifact-store.js +40 -1
  70. package/dist/adapters/filesystem/context-document-writer.d.ts +15 -0
  71. package/dist/adapters/filesystem/context-document-writer.js +112 -0
  72. package/dist/adapters/filesystem/diagnostics-journal.d.ts +17 -0
  73. package/dist/adapters/filesystem/diagnostics-journal.js +130 -0
  74. package/dist/adapters/filesystem/external-flow-registry.d.ts +17 -0
  75. package/dist/adapters/filesystem/external-flow-registry.js +325 -0
  76. package/dist/adapters/filesystem/generation-session-store.d.ts +17 -11
  77. package/dist/adapters/filesystem/generation-session-store.js +281 -855
  78. package/dist/adapters/filesystem/generation-store/session-lock.d.ts +29 -0
  79. package/dist/adapters/filesystem/generation-store/session-lock.js +202 -0
  80. package/dist/adapters/filesystem/generation-store/session-transitions.d.ts +24 -0
  81. package/dist/adapters/filesystem/generation-store/session-transitions.js +340 -0
  82. package/dist/adapters/filesystem/generation-store/store-files.d.ts +50 -0
  83. package/dist/adapters/filesystem/generation-store/store-files.js +363 -0
  84. package/dist/adapters/filesystem/journey-composition-store.d.ts +23 -0
  85. package/dist/adapters/filesystem/journey-composition-store.js +151 -0
  86. package/dist/adapters/filesystem/knowledge-registry.d.ts +12 -0
  87. package/dist/adapters/filesystem/knowledge-registry.js +223 -0
  88. package/dist/adapters/filesystem/project-bound-file.js +3 -5
  89. package/dist/adapters/filesystem/project-file-inspector.d.ts +2 -0
  90. package/dist/adapters/filesystem/project-file-inspector.js +57 -28
  91. package/dist/adapters/filesystem/project-identity-inspector.d.ts +7 -0
  92. package/dist/adapters/filesystem/project-identity-inspector.js +215 -0
  93. package/dist/adapters/filesystem/project-inventory-inspector.d.ts +8 -0
  94. package/dist/adapters/filesystem/project-inventory-inspector.js +93 -0
  95. package/dist/adapters/filesystem/project-module-discoverer.d.ts +6 -0
  96. package/dist/adapters/filesystem/project-module-discoverer.js +158 -0
  97. package/dist/adapters/filesystem/skill-installer.d.ts +7 -2
  98. package/dist/adapters/filesystem/skill-installer.js +40 -11
  99. package/dist/adapters/filesystem/workspace-layout.d.ts +7 -0
  100. package/dist/adapters/filesystem/workspace-layout.js +57 -0
  101. package/dist/adapters/git/node-git-diff.d.ts +17 -0
  102. package/dist/adapters/git/node-git-diff.js +114 -0
  103. package/dist/adapters/process/node-detached-process-launcher.d.ts +6 -0
  104. package/dist/adapters/process/node-detached-process-launcher.js +96 -0
  105. package/dist/adapters/process/node-process-runner.js +11 -2
  106. package/dist/adapters/prompt/inquirer-align-prompt.d.ts +27 -0
  107. package/dist/adapters/prompt/inquirer-align-prompt.js +65 -0
  108. package/dist/adapters/prompt/inquirer-generation-prompt.js +3 -0
  109. package/dist/adapters/prompt/inquirer-recorder-prompt.d.ts +9 -1
  110. package/dist/adapters/prompt/inquirer-recorder-prompt.js +63 -0
  111. package/dist/adapters/runtime/adb-runtime-backend.d.ts +67 -0
  112. package/dist/adapters/runtime/adb-runtime-backend.js +206 -0
  113. package/dist/adapters/runtime/fake-runtime-backend.d.ts +87 -0
  114. package/dist/adapters/runtime/fake-runtime-backend.js +240 -0
  115. package/dist/adapters/runtime/mobile-mcp/mcp-tool-client.d.ts +45 -0
  116. package/dist/adapters/runtime/mobile-mcp/mcp-tool-client.js +153 -0
  117. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-errors.d.ts +23 -0
  118. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-errors.js +39 -0
  119. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-responses.d.ts +20 -0
  120. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-responses.js +180 -0
  121. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-runtime-backend.d.ts +78 -0
  122. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-runtime-backend.js +379 -0
  123. package/dist/adapters/runtime/mobile-mcp/mobile-mcp-tools.d.ts +46 -0
  124. package/dist/adapters/runtime/session-adb-view.d.ts +53 -0
  125. package/dist/adapters/runtime/session-adb-view.js +193 -0
  126. package/dist/adapters/runtime/session-backed-ports.d.ts +21 -0
  127. package/dist/adapters/runtime/session-backed-ports.js +43 -0
  128. package/dist/adapters/runtime/shared-session-runtime-backend.d.ts +12 -0
  129. package/dist/adapters/runtime/shared-session-runtime-backend.js +64 -0
  130. package/dist/adapters/ui/auto-ui-snapshot-provider.d.ts +8 -0
  131. package/dist/adapters/ui/auto-ui-snapshot-provider.js +48 -0
  132. package/dist/adapters/ui/device-layout-temp.d.ts +6 -0
  133. package/dist/adapters/ui/device-layout-temp.js +18 -0
  134. package/dist/adapters/ui/device-ui-environment.d.ts +13 -0
  135. package/dist/adapters/ui/device-ui-environment.js +81 -0
  136. package/dist/adapters/ui/layout-normalization.d.ts +9 -0
  137. package/dist/adapters/ui/layout-normalization.js +44 -0
  138. package/dist/adapters/ui/ui-snapshot-error.d.ts +11 -0
  139. package/dist/adapters/ui/ui-snapshot-error.js +12 -0
  140. package/dist/adapters/ui/ui-snapshot-support.d.ts +15 -0
  141. package/dist/adapters/ui/ui-snapshot-support.js +12 -0
  142. package/dist/application/align/align-service.d.ts +42 -0
  143. package/dist/application/align/align-service.js +106 -0
  144. package/dist/application/assertion/expectation-evaluator.d.ts +18 -5
  145. package/dist/application/assertion/expectation-evaluator.js +156 -18
  146. package/dist/application/assertion/guarded-expectation.d.ts +45 -0
  147. package/dist/application/assertion/guarded-expectation.js +74 -0
  148. package/dist/application/checkpoint/baseline-capturer.d.ts +26 -0
  149. package/dist/application/checkpoint/baseline-capturer.js +163 -0
  150. package/dist/application/checkpoint/baseline-error.d.ts +5 -0
  151. package/dist/application/checkpoint/baseline-error.js +8 -0
  152. package/dist/application/checkpoint/baseline-service.d.ts +31 -0
  153. package/dist/application/checkpoint/baseline-service.js +147 -0
  154. package/dist/application/checkpoint/checkpoint-evaluator.d.ts +35 -0
  155. package/dist/application/checkpoint/checkpoint-evaluator.js +415 -0
  156. package/dist/application/checkpoint/regression-comparator.d.ts +18 -0
  157. package/dist/application/checkpoint/regression-comparator.js +192 -0
  158. package/dist/application/collector/logcat-collector.d.ts +22 -1
  159. package/dist/application/collector/logcat-collector.js +103 -15
  160. package/dist/application/collector/logcat-event.d.ts +8 -0
  161. package/dist/application/collector/logcat-event.js +79 -0
  162. package/dist/application/collector/logcat-stop.d.ts +2 -0
  163. package/dist/application/collector/logcat-stop.js +11 -0
  164. package/dist/application/context/context-generator.d.ts +45 -0
  165. package/dist/application/context/context-generator.js +228 -0
  166. package/dist/application/context/context-loader.d.ts +40 -0
  167. package/dist/application/context/context-loader.js +223 -0
  168. package/dist/application/context/context-refresher.d.ts +59 -0
  169. package/dist/application/context/context-refresher.js +349 -0
  170. package/dist/application/context/context-rehasher.d.ts +36 -0
  171. package/dist/application/context/context-rehasher.js +110 -0
  172. package/dist/application/context/context-validator.d.ts +23 -1
  173. package/dist/application/context/context-validator.js +116 -9
  174. package/dist/application/context/evidence-hash.d.ts +1 -0
  175. package/dist/application/context/evidence-hash.js +125 -0
  176. package/dist/application/context/evidence-match.d.ts +9 -0
  177. package/dist/application/context/evidence-match.js +8 -0
  178. package/dist/application/context/shard-identity.d.ts +2 -0
  179. package/dist/application/context/shard-identity.js +7 -0
  180. package/dist/application/contract/contract-loader.d.ts +25 -0
  181. package/dist/application/contract/contract-loader.js +68 -0
  182. package/dist/application/contract/contract-review.d.ts +25 -0
  183. package/dist/application/contract/contract-review.js +51 -0
  184. package/dist/application/contract/contract-verifier.d.ts +53 -0
  185. package/dist/application/contract/contract-verifier.js +645 -0
  186. package/dist/application/devices/resolve-device-assignments.d.ts +21 -0
  187. package/dist/application/devices/resolve-device-assignments.js +60 -0
  188. package/dist/application/diagnosis/failure-classifier.d.ts +23 -0
  189. package/dist/application/diagnosis/failure-classifier.js +179 -0
  190. package/dist/application/diagnostics/diagnostics-exporter.d.ts +29 -0
  191. package/dist/application/diagnostics/diagnostics-exporter.js +283 -0
  192. package/dist/application/diagnostics/ui-capture-telemetry.d.ts +16 -0
  193. package/dist/application/diagnostics/ui-capture-telemetry.js +81 -0
  194. package/dist/application/doctor/doctor-service.d.ts +36 -3
  195. package/dist/application/doctor/doctor-service.js +255 -25
  196. package/dist/application/generation/generation-app-preparer.d.ts +20 -0
  197. package/dist/application/generation/generation-app-preparer.js +28 -0
  198. package/dist/application/generation/generation-config-service.d.ts +21 -0
  199. package/dist/application/generation/generation-config-service.js +53 -0
  200. package/dist/application/generation/generation-confirmation-service.d.ts +14 -3
  201. package/dist/application/generation/generation-confirmation-service.js +109 -24
  202. package/dist/application/generation/generation-context-snapshot.d.ts +6 -0
  203. package/dist/application/generation/generation-context-snapshot.js +29 -0
  204. package/dist/application/generation/generation-finalizer.d.ts +15 -9
  205. package/dist/application/generation/generation-finalizer.js +167 -70
  206. package/dist/application/generation/generation-publisher.js +12 -8
  207. package/dist/application/generation/generation-recovery-service.d.ts +35 -0
  208. package/dist/application/generation/generation-recovery-service.js +144 -0
  209. package/dist/application/generation/generation-reopen-service.d.ts +15 -0
  210. package/dist/application/generation/generation-reopen-service.js +37 -0
  211. package/dist/application/generation/generation-replace-service.d.ts +32 -0
  212. package/dist/application/generation/generation-replace-service.js +116 -0
  213. package/dist/application/generation/generation-starter.d.ts +44 -4
  214. package/dist/application/generation/generation-starter.js +175 -8
  215. package/dist/application/generation/generation-step-executor.d.ts +67 -5
  216. package/dist/application/generation/generation-step-executor.js +471 -108
  217. package/dist/application/generation/proposed-step-validator.js +96 -30
  218. package/dist/application/generation/replay-policy-loader.d.ts +16 -0
  219. package/dist/application/generation/replay-policy-loader.js +29 -0
  220. package/dist/application/generation/risk-evaluator.d.ts +4 -1
  221. package/dist/application/generation/risk-evaluator.js +118 -3
  222. package/dist/application/generation/runtime-observer.d.ts +39 -7
  223. package/dist/application/generation/runtime-observer.js +193 -24
  224. package/dist/application/impact/impact-resolver.d.ts +32 -0
  225. package/dist/application/impact/impact-resolver.js +160 -0
  226. package/dist/application/init/init-service.js +26 -13
  227. package/dist/application/interaction/action-executor.d.ts +3 -2
  228. package/dist/application/interaction/action-executor.js +11 -1
  229. package/dist/application/interaction/action-target.d.ts +17 -0
  230. package/dist/application/interaction/action-target.js +40 -0
  231. package/dist/application/interaction/external-step-runner.d.ts +153 -0
  232. package/dist/application/interaction/external-step-runner.js +332 -0
  233. package/dist/application/interaction/fallback-resolver.d.ts +6 -3
  234. package/dist/application/interaction/fallback-resolver.js +7 -5
  235. package/dist/application/interaction/scroll-to-executor.d.ts +17 -3
  236. package/dist/application/interaction/scroll-to-executor.js +118 -36
  237. package/dist/application/journey/external-flow-resolver.d.ts +25 -0
  238. package/dist/application/journey/external-flow-resolver.js +22 -0
  239. package/dist/application/journey/journey-check-service.d.ts +54 -0
  240. package/dist/application/journey/journey-check-service.js +207 -0
  241. package/dist/application/journey/journey-promoter.d.ts +26 -0
  242. package/dist/application/journey/journey-promoter.js +123 -0
  243. package/dist/application/journey/journey-resolver.d.ts +42 -0
  244. package/dist/application/journey/journey-resolver.js +239 -0
  245. package/dist/application/journey/journey-retirer.d.ts +25 -0
  246. package/dist/application/journey/journey-retirer.js +87 -0
  247. package/dist/application/knowledge/anchor-resolver.d.ts +36 -0
  248. package/dist/application/knowledge/anchor-resolver.js +110 -0
  249. package/dist/application/knowledge/knowledge-loader.d.ts +16 -0
  250. package/dist/application/knowledge/knowledge-loader.js +36 -0
  251. package/dist/application/locator/layout-failure-summary.d.ts +2 -0
  252. package/dist/application/locator/layout-failure-summary.js +67 -0
  253. package/dist/application/locator/layout-traversal.d.ts +11 -0
  254. package/dist/application/locator/layout-traversal.js +18 -0
  255. package/dist/application/locator/locator-resolver.d.ts +13 -1
  256. package/dist/application/locator/locator-resolver.js +182 -18
  257. package/dist/application/observe/observe-service.d.ts +20 -0
  258. package/dist/application/observe/observe-service.js +91 -0
  259. package/dist/application/project/project-describer.d.ts +14 -6
  260. package/dist/application/project/project-describer.js +38 -5
  261. package/dist/application/recognition/screen-detector.d.ts +28 -0
  262. package/dist/application/recognition/screen-detector.js +111 -0
  263. package/dist/application/recorder/locator-selector.js +151 -17
  264. package/dist/application/recorder/recorder-service.d.ts +16 -4
  265. package/dist/application/recorder/recorder-service.js +420 -128
  266. package/dist/application/report/report-writer.d.ts +5 -0
  267. package/dist/application/report/report-writer.js +17 -1
  268. package/dist/application/runtime/cold-launch.d.ts +28 -0
  269. package/dist/application/runtime/cold-launch.js +59 -0
  270. package/dist/application/runtime/step-runner.d.ts +49 -4
  271. package/dist/application/runtime/step-runner.js +721 -130
  272. package/dist/application/runtime/verify-runtime.d.ts +57 -7
  273. package/dist/application/runtime/verify-runtime.js +577 -175
  274. package/dist/application/ui/cached-ui-snapshot-provider.d.ts +45 -0
  275. package/dist/application/ui/cached-ui-snapshot-provider.js +111 -0
  276. package/dist/application/ui/observed-ui-snapshot-provider.d.ts +15 -0
  277. package/dist/application/ui/observed-ui-snapshot-provider.js +66 -0
  278. package/dist/application/ui/ui-snapshot-lifecycle.d.ts +2 -0
  279. package/dist/application/ui/ui-snapshot-lifecycle.js +8 -0
  280. package/dist/application/ui/ui-stability-probe.d.ts +9 -0
  281. package/dist/application/ui/ui-stability-probe.js +24 -0
  282. package/dist/application/wait/idle-advice.d.ts +6 -0
  283. package/dist/application/wait/idle-advice.js +27 -0
  284. package/dist/application/wait/idle-profiles.d.ts +15 -0
  285. package/dist/application/wait/idle-profiles.js +75 -0
  286. package/dist/application/wait/idle-waiter.d.ts +28 -4
  287. package/dist/application/wait/idle-waiter.js +201 -15
  288. package/dist/cli/commands/align.d.ts +3 -0
  289. package/dist/cli/commands/align.js +124 -0
  290. package/dist/cli/commands/baseline.d.ts +3 -0
  291. package/dist/cli/commands/baseline.js +130 -0
  292. package/dist/cli/commands/context.js +300 -27
  293. package/dist/cli/commands/contract.d.ts +3 -0
  294. package/dist/cli/commands/contract.js +120 -0
  295. package/dist/cli/commands/diagnose.d.ts +3 -0
  296. package/dist/cli/commands/diagnose.js +84 -0
  297. package/dist/cli/commands/doctor.js +16 -9
  298. package/dist/cli/commands/failure.d.ts +3 -0
  299. package/dist/cli/commands/failure.js +63 -0
  300. package/dist/cli/commands/generation/lifecycle-commands.d.ts +5 -0
  301. package/dist/cli/commands/generation/lifecycle-commands.js +211 -0
  302. package/dist/cli/commands/generation/session-commands.d.ts +11 -0
  303. package/dist/cli/commands/generation/session-commands.js +472 -0
  304. package/dist/cli/commands/generation/shared.d.ts +1414 -0
  305. package/dist/cli/commands/generation/shared.js +291 -0
  306. package/dist/cli/commands/generation/step-commands.d.ts +8 -0
  307. package/dist/cli/commands/generation/step-commands.js +315 -0
  308. package/dist/cli/commands/generation.js +10 -507
  309. package/dist/cli/commands/impact.d.ts +3 -0
  310. package/dist/cli/commands/impact.js +87 -0
  311. package/dist/cli/commands/init.js +13 -6
  312. package/dist/cli/commands/journey.d.ts +3 -0
  313. package/dist/cli/commands/journey.js +382 -0
  314. package/dist/cli/commands/knowledge.d.ts +3 -0
  315. package/dist/cli/commands/knowledge.js +93 -0
  316. package/dist/cli/commands/observe.d.ts +3 -0
  317. package/dist/cli/commands/observe.js +127 -0
  318. package/dist/cli/commands/project.js +2 -1
  319. package/dist/cli/commands/record.js +18 -5
  320. package/dist/cli/commands/verify.js +326 -64
  321. package/dist/cli/dependencies.d.ts +136 -1
  322. package/dist/cli/dependencies.js +504 -52
  323. package/dist/cli/diagnostics-recorder.d.ts +31 -0
  324. package/dist/cli/diagnostics-recorder.js +82 -0
  325. package/dist/cli/diff-verification.d.ts +41 -0
  326. package/dist/cli/diff-verification.js +192 -0
  327. package/dist/cli/main.d.ts +1 -1
  328. package/dist/cli/main.js +107 -2
  329. package/dist/cli/output.d.ts +5 -3
  330. package/dist/cli/output.js +12 -0
  331. package/dist/cli/program.js +21 -1
  332. package/dist/cli/project-root.d.ts +1 -0
  333. package/dist/cli/project-root.js +6 -0
  334. package/dist/cli/runtime-selection.d.ts +22 -0
  335. package/dist/cli/runtime-selection.js +92 -0
  336. package/dist/cli/version.d.ts +1 -0
  337. package/dist/cli/version.js +14 -0
  338. package/dist/cli/workspace-guard.d.ts +2 -0
  339. package/dist/cli/workspace-guard.js +3 -0
  340. package/dist/domain/binding-reference.d.ts +4 -0
  341. package/dist/domain/binding-reference.js +23 -0
  342. package/dist/domain/checkpoint.d.ts +404 -0
  343. package/dist/domain/checkpoint.js +297 -0
  344. package/dist/domain/config.d.ts +107 -1
  345. package/dist/domain/config.js +52 -6
  346. package/dist/domain/contract.d.ts +413 -0
  347. package/dist/domain/contract.js +196 -0
  348. package/dist/domain/diagnostics.d.ts +1396 -0
  349. package/dist/domain/diagnostics.js +193 -0
  350. package/dist/domain/external-flow.d.ts +493 -0
  351. package/dist/domain/external-flow.js +15 -0
  352. package/dist/domain/failure-classification.d.ts +176 -0
  353. package/dist/domain/failure-classification.js +169 -0
  354. package/dist/domain/failure.d.ts +2 -1
  355. package/dist/domain/failure.js +123 -0
  356. package/dist/domain/generation.d.ts +1671 -132
  357. package/dist/domain/generation.js +202 -13
  358. package/dist/domain/geometry.d.ts +13 -0
  359. package/dist/domain/geometry.js +16 -0
  360. package/dist/domain/impact.d.ts +71 -0
  361. package/dist/domain/impact.js +76 -0
  362. package/dist/domain/init.d.ts +12 -4
  363. package/dist/domain/init.js +24 -18
  364. package/dist/domain/journey-composition.d.ts +2285 -0
  365. package/dist/domain/journey-composition.js +85 -0
  366. package/dist/domain/journey-lifecycle.d.ts +10 -0
  367. package/dist/domain/journey-lifecycle.js +9 -0
  368. package/dist/domain/journey.d.ts +2419 -212
  369. package/dist/domain/journey.js +384 -14
  370. package/dist/domain/knowledge.d.ts +165 -0
  371. package/dist/domain/knowledge.js +188 -0
  372. package/dist/domain/layout.d.ts +34 -5
  373. package/dist/domain/layout.js +64 -6
  374. package/dist/domain/locator-evidence.d.ts +3 -0
  375. package/dist/domain/locator-evidence.js +36 -0
  376. package/dist/domain/logcat-event.d.ts +54 -0
  377. package/dist/domain/logcat-event.js +40 -0
  378. package/dist/domain/observation.d.ts +33 -0
  379. package/dist/domain/observation.js +18 -0
  380. package/dist/domain/project-context.d.ts +219 -1
  381. package/dist/domain/project-context.js +209 -6
  382. package/dist/domain/proposed-step.d.ts +340 -60
  383. package/dist/domain/proposed-step.js +23 -3
  384. package/dist/domain/report.d.ts +1455 -28
  385. package/dist/domain/report.js +211 -14
  386. package/dist/domain/runtime-snapshot.d.ts +58 -1
  387. package/dist/domain/runtime-snapshot.js +14 -3
  388. package/dist/domain/runtime.d.ts +50 -0
  389. package/dist/domain/runtime.js +36 -0
  390. package/dist/domain/system-app-profiles.d.ts +6 -0
  391. package/dist/domain/system-app-profiles.js +43 -0
  392. package/dist/domain/ui-backend.d.ts +28 -0
  393. package/dist/domain/ui-backend.js +33 -0
  394. package/dist/domain/ui-cache.d.ts +11 -0
  395. package/dist/domain/ui-cache.js +10 -0
  396. package/dist/domain/verify-receipt.d.ts +17 -0
  397. package/dist/domain/verify-receipt.js +17 -0
  398. package/dist/domain/window-hierarchy.d.ts +84 -0
  399. package/dist/domain/window-hierarchy.js +172 -0
  400. package/dist/domain/workflow-manifest.d.ts +77 -0
  401. package/dist/domain/workflow-manifest.js +136 -0
  402. package/dist/domain/workspace.d.ts +30 -0
  403. package/dist/domain/workspace.js +74 -0
  404. package/dist/ports/adb.d.ts +34 -1
  405. package/dist/ports/align-prompt.d.ts +11 -0
  406. package/dist/ports/align-prompt.js +6 -0
  407. package/dist/ports/anchor-resolver.d.ts +30 -0
  408. package/dist/ports/anchor-resolver.js +1 -0
  409. package/dist/ports/annotated-screen-resolver.d.ts +4 -0
  410. package/dist/ports/annotated-screen-resolver.js +1 -0
  411. package/dist/ports/camera-probe.d.ts +23 -0
  412. package/dist/ports/camera-probe.js +8 -0
  413. package/dist/ports/context-document-writer.d.ts +24 -0
  414. package/dist/ports/context-document-writer.js +1 -0
  415. package/dist/ports/detached-process-launcher.d.ts +12 -0
  416. package/dist/ports/detached-process-launcher.js +1 -0
  417. package/dist/ports/diagnostics.d.ts +15 -0
  418. package/dist/ports/diagnostics.js +1 -0
  419. package/dist/ports/external-flow-registry.d.ts +37 -0
  420. package/dist/ports/external-flow-registry.js +1 -0
  421. package/dist/ports/generation-prompt.d.ts +2 -1
  422. package/dist/ports/generation-session-store.d.ts +12 -2
  423. package/dist/ports/git-diff.d.ts +9 -0
  424. package/dist/ports/git-diff.js +1 -0
  425. package/dist/ports/journey-composition-store.d.ts +17 -0
  426. package/dist/ports/journey-composition-store.js +1 -0
  427. package/dist/ports/knowledge-registry.d.ts +20 -0
  428. package/dist/ports/knowledge-registry.js +1 -0
  429. package/dist/ports/process-runner.d.ts +7 -0
  430. package/dist/ports/project-file-inspector.d.ts +1 -0
  431. package/dist/ports/project-identity-inspector.d.ts +24 -0
  432. package/dist/ports/project-identity-inspector.js +1 -0
  433. package/dist/ports/project-inventory-inspector.d.ts +21 -0
  434. package/dist/ports/project-inventory-inspector.js +1 -0
  435. package/dist/ports/project-module-discoverer.d.ts +26 -0
  436. package/dist/ports/project-module-discoverer.js +1 -0
  437. package/dist/ports/recorder-prompt.d.ts +10 -1
  438. package/dist/ports/runtime-backend.d.ts +89 -0
  439. package/dist/ports/runtime-backend.js +13 -0
  440. package/dist/ports/runtime-capability.d.ts +12 -0
  441. package/dist/ports/runtime-capability.js +20 -0
  442. package/dist/ports/runtime-session-ports.d.ts +25 -0
  443. package/dist/ports/runtime-session-ports.js +1 -0
  444. package/dist/ports/screenshot.d.ts +11 -0
  445. package/dist/ports/screenshot.js +1 -0
  446. package/dist/ports/skill-installer.d.ts +2 -2
  447. package/dist/ports/ui-snapshot.d.ts +35 -0
  448. package/dist/ports/ui-snapshot.js +1 -0
  449. package/dist/ports/ui-stability.d.ts +19 -0
  450. package/dist/ports/ui-stability.js +1 -0
  451. package/dist/ports/workspace-layout.d.ts +4 -0
  452. package/dist/ports/workspace-layout.js +1 -0
  453. package/dist/shared/errors.d.ts +2 -0
  454. package/dist/shared/errors.js +22 -0
  455. package/dist/shared/paths.d.ts +2 -0
  456. package/dist/shared/paths.js +24 -0
  457. package/dist/shared/strings.d.ts +2 -0
  458. package/dist/shared/strings.js +16 -0
  459. package/package.json +7 -2
  460. package/assets/skills/taphound-ai-journey/GUIDE.md +0 -862
  461. package/assets/skills/taphound-ai-journey/SKILL.md +0 -377
  462. package/assets/skills/taphound-ai-journey/prompts/analyze-project.md +0 -526
  463. package/assets/skills/taphound-ai-journey/prompts/generate-step.md +0 -109
  464. package/assets/skills/taphound-ai-journey/schemas/project-context.json +0 -81
  465. package/assets/skills/taphound-ai-journey/templates/project-context.example.json +0 -49
  466. package/dist/ports/android-cli.d.ts +0 -21
  467. /package/dist/{ports/android-cli.js → adapters/runtime/mobile-mcp/mobile-mcp-tools.js} +0 -0
package/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <img src="assets/brand/taphound-mark.svg" width="128" alt="TapHound HoundMark">
2
+ <img src="assets/brand/taphound-mark.svg" width="128" alt="TapHound - AI-Agent-driven Android UI testing and state verification CLI">
3
3
  </p>
4
4
 
5
5
  # TapHound
@@ -8,193 +8,93 @@ English | [简体中文](./README.zh-CN.md)
8
8
 
9
9
  > Follow every tap. Catch every regression.
10
10
 
11
- TapHound is a TypeScript/Node.js CLI for recording, generating, and deterministically verifying app journeys. The current development release, TapHound for Android, supports recording native Android workflows and AI-agent-driven journey generation based on a Project Context and live device state.
11
+ **An AI-Agent-driven CLI for native Android UI testing and state verification.**
12
12
 
13
- The TapHound Journey is a purpose-built JSON protocol with its own recorder, generation, replay, and assertion model. It is distinct from and incompatible with the Android CLI's official Journey concept. TapHound Core never invokes AI models: external agents may analyze source code and propose actions, but state binding, risk confirmation, device execution, final replay, and assertions are all handled deterministically by TapHound.
13
+ TapHound records, generates, and deterministically replays UI **Journeys** for native Android apps. The current development release is TapHound for Android. It is built for teams whose AI coding agents (Droid, Claude Code, Codex, Cursor, ...) write code faster than people can review it: the agent proposes test steps from your source code and live device state, and TapHound executes, verifies, and reports — deterministically, with no AI or visual guessing inside the replay loop — so "done" means proven on a device.
14
14
 
15
- TapHound only handles verification. Compiling and installing the APK are independent prerequisites, handled by the developer or AI agent in a separate loop:
15
+ The TapHound Journey is its own JSON protocol with its own recorder, generation, replay, and assertion model — distinct from and incompatible with the Android CLI's Journey concept.
16
+
17
+ ## How It Works
18
+
19
+ TapHound Core never invokes AI models. Agents may analyze source and propose actions, but state binding, risk confirmation, device execution, final replay, and assertions are all handled deterministically by TapHound.
20
+
21
+ TapHound only handles verification. Building and installing the APK are independent prerequisites in the developer/agent loop, which the bundled Skills check at two depths:
16
22
 
17
23
  ```
18
- edit code → build APK → install to device → taphound verify → loop until passing
24
+ classify the change → edit code → build & install → taphound-flash (seconds, smoke) → repeat
25
+ → taphound-verify-change (proof) → done
19
26
  ```
20
27
 
21
- ## Requirements
28
+ The change type picks the proof: new behavior (with or without UI) must pass an Acceptance Contract; a refactor, including an XML → Compose migration, must reproduce previously captured behavior. See [Workflow Skills](https://github.com/caikaidev/TapHound/blob/main/docs/workflow-skills.md).
22
29
 
23
- - Node.js 22 or newer
24
- - Android SDK, ADB, and an online device or emulator
25
- - Target APK already installed on the device (TapHound does not build or install)
26
- - The `android` CLI available on PATH
27
- - On macOS, grant Android CLI the required Accessibility and Screen Recording permissions
30
+ ## Capabilities
28
31
 
29
- Run environment diagnostics first:
32
+ - **Record** — interactively record a Journey on a real device (`taphound record`).
33
+ - **Verify** — deterministically replay a Journey and publish a report (`taphound verify`); `verify --diff <ref>` replays only the Journeys a Git change affects.
34
+ - **Generate** — AI-agent-driven Journey generation: evidence-bound steps, risk confirmation for sensitive actions, and a final exact replay before a Journey is published (`taphound generation ...`).
35
+ - **Trust chain** — Acceptance Contracts, behavior Baselines, and Failure Classification turn a replay into an auditable verdict.
36
+ - **Knowledge** — semantic Anchors and Screens let Journeys survive UI refactors and resource-id renames.
37
+ - **Agent Skills** — five installable Skills (`taphound init`): `taphound-flash` (a standalone adb-only smoke check while coding), `taphound-verify-change` (the done-gate: accept new behavior or preserve existing behavior), `taphound-journey-brief-author` and `taphound-journey-generator` (turn a Case into a verified Journey), and `taphound-case-suite` (many Cases, one at a time).
30
38
 
31
- ```bash
32
- taphound doctor --project /path/to/android-project
33
- ```
39
+ ## Requirements
34
40
 
35
- When `--device` is omitted, exactly one device with status `device` must be connected; use `--device <serial>` to select among multiple devices.
41
+ - Node.js 22 or newer
42
+ - Android SDK, ADB, and the `android` CLI on PATH
43
+ - An online device or emulator with the target APK already installed
44
+ - On macOS, grant Android CLI the Accessibility and Screen Recording permissions
36
45
 
37
- ## Installation and Local Development
46
+ `taphound-flash` alone needs only Node.js 18+ and ADB.
38
47
 
39
- Install from source:
48
+ Check your environment first:
40
49
 
41
50
  ```bash
42
- npm ci
43
- npm run build
44
- npm link
45
- taphound --help
51
+ taphound doctor --project /path/to/android-project
46
52
  ```
47
53
 
48
- Full local quality gate:
54
+ ## Installation
49
55
 
50
56
  ```bash
51
- npm test
52
- npm run typecheck
53
- npm run lint
54
- npm run build
55
- npm run brand:render
56
- git diff --exit-code -- assets/brand/png
57
+ npm ci
58
+ npm run dev:setup # tests, typecheck, lint, build, npm link
57
59
  ```
58
60
 
59
- See the [local testing guide](docs/local-testing.md) for source, npm tarball, and Android device validation steps. When switching dev machines, follow the [machine handoff TODO](TODO.md) to track remaining acceptance and npm `dev` pre-release.
61
+ See the [local testing guide](https://github.com/caikaidev/TapHound/blob/main/docs/local-testing.md) for tarball and device validation steps, and [Releasing](https://github.com/caikaidev/TapHound/blob/main/docs/releasing.md) for how versions are published.
60
62
 
61
- ## CLI Commands
63
+ ## Quick Start
62
64
 
63
- - `doctor`: checks Node.js, ADB, Android CLI, app installation, permissions, and device.
64
- - `record`: interactively execute actions and record a Journey.
65
- - `verify`: deterministically replay a Journey and publish a report.
66
- - `project describe`: output stable Android project facts.
67
- - `context validate` / `context status`: validate or check a Project Context.
68
- - `generation start` / `observe` / `step` / `confirm` / `manual` / `finalize`: manage deterministic Journey generation sessions.
69
- - `init`: install the TapHound AI Journey Skill for AI agents.
70
-
71
- ## Configuration
72
-
73
- Create a `taphound.config.json` in the Android project. `run.packageName` is required and never guessed from APK filenames or activities; see [`examples/taphound.config.json`](examples/taphound.config.json) for a complete example.
65
+ Create `.taphound/config.json` in your Android project (full reference: [config-schema](https://github.com/caikaidev/TapHound/blob/main/docs/config-schema.md), complete example: [`examples/.taphound/config.json`](https://github.com/caikaidev/TapHound/blob/main/examples/.taphound/config.json)):
74
66
 
75
67
  ```json
76
68
  {
77
69
  "version": 1,
78
- "run": {
79
- "packageName": "com.example.app",
80
- "activity": ".MainActivity"
81
- },
82
- "idle": {
83
- "pollIntervalMs": 200,
84
- "stablePolls": 2,
85
- "timeoutMs": 5000
86
- },
87
- "artifactsDir": ".taphound/runs"
70
+ "run": { "packageName": "com.example.app", "activity": ".MainActivity" }
88
71
  }
89
72
  ```
90
73
 
91
- ## Interactive Recording
92
-
93
- The TapHound Recorder displays the current layout, lets you choose an action and target, and executes it through ADB. It does not listen for arbitrary touch events. Each successful step automatically records `activity.before` and `activity.after`; failed steps are not added to the Journey; the complete file is written atomically only after you choose Finish.
94
-
95
- ```bash
96
- taphound record \
97
- --project /path/to/android-project \
98
- --config taphound.config.json \
99
- --name "Search flow" \
100
- --output journeys/search.json
101
- ```
102
-
103
- The Recorder does not auto-generate business `expect` assertions. Activity, Element, or Logcat assertions should be added explicitly by developers or external agents. See [Journey Schema](docs/journey-schema.md) for protocol details.
104
-
105
- Supported actions include `click`, `longClick`, `inputText`, `swipe`, `scrollTo`, `back`, and `wait`. `scrollTo` swipes within a deterministic `container` up to `maxSwipes` times, stopping once the target `locator` resolves uniquely without clicking it.
106
-
107
- ## Agent-Driven Journey Generation
108
-
109
- The repository ships a [`taphound-ai-journey` Skill](assets/skills/taphound-ai-journey/SKILL.md) that guides agents such as Droid, Claude Code, Copilot, and Cursor:
110
-
111
- 1. Use `project describe` and the Android project source to generate a Project Context with evidence hashes.
112
- 2. Use `context validate` / `context status` to check Context validity and freshness.
113
- 3. Start a `generation` session, iteratively observe authoritative device state, propose strict steps, and let TapHound execute them.
114
- 4. Use `generation finalize` to replay from the initial state and publish the Journey only after verification passes.
115
-
116
- ```bash
117
- taphound generation start \
118
- --project /path/to/android-project \
119
- --context .taphound/context/project-context.json \
120
- --device emulator-5554 \
121
- --json
122
- ```
123
-
124
- The device is bound at `generation start`; subsequent `observe`, `step`, `confirm`, and `manual` commands use that binding via the session. See the Skill's [`GUIDE.md`](assets/skills/taphound-ai-journey/GUIDE.md) for the full workflow.
125
-
126
- ### Installing the Skill for Other AI Agents
127
-
128
- `taphound init` copies the TapHound AI Journey Skill into each agent's Skill directory. Interactively select at least one agent:
74
+ Record a Journey, then replay it:
129
75
 
130
76
  ```bash
131
- taphound init
77
+ taphound record --project . --name "Search flow" --output .taphound/journeys/search.json
78
+ taphound verify --project . --journey .taphound/journeys/search.json
132
79
  ```
133
80
 
134
- Non-interactive mode:
81
+ For AI agents, install the bundled Skills and let the agent drive generation:
135
82
 
136
83
  ```bash
137
84
  taphound init --agent claude,codex,cursor,droid
138
85
  ```
139
86
 
140
- Global install (user-level directory):
141
-
142
- ```bash
143
- taphound init --agent claude --global
144
- ```
145
-
146
- Supported agents and paths:
147
-
148
- | Agent | Project-level path | User-level path |
149
- |---|---|---|
150
- | Claude Code | `.claude/skills/` | `~/.claude/skills/` |
151
- | Codex | `.agents/skills/` | `~/.agents/skills/` |
152
- | Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
153
- | Droid | `.factory/skills/` | `~/.factory/skills/` |
154
- | Other | `.agents/skills/` | `~/.agents/skills/` |
155
-
156
- The Skill is published with the npm package; `taphound init` copies it from the package to the target directory. Re-running `init` overwrites existing Skill files.
157
-
158
- ## Deterministic Verification
159
-
160
- ```bash
161
- taphound verify \
162
- --project /path/to/android-project \
163
- --config taphound.config.json \
164
- --journey journeys/search.json
165
- ```
166
-
167
- Temporarily override package, activity, device, or report path:
168
-
169
- ```bash
170
- taphound verify \
171
- --project /path/to/android-project \
172
- --journey journeys/search.json \
173
- --device emulator-5554 \
174
- --package com.example.app \
175
- --activity .MainActivity \
176
- --reports /tmp/taphound-runs
177
- ```
178
-
179
- For agent invocations:
180
-
181
- ```bash
182
- taphound verify --project . --journey journeys/search.json --json
183
- ```
184
-
185
- `--json` mode guarantees exactly one final JSON value on stdout; progress and diagnostics go to stderr. See [Agent Integration](docs/agent-integration.md) and [Report Schema](docs/report-schema.md).
186
-
187
- ## Reports
87
+ ## Documentation
188
88
 
189
- Each verification writes to an independent directory, always containing `report.json` and `summary.txt`, with step logs provided based on actual execution. A final screenshot and full Logcat are collected on a best-effort basis. The original verification failure is preserved in `primaryFailure`; screenshot or logcat collection issues go into `secondaryErrors` and never overwrite the original failure; corresponding optional artifacts may be missing.
89
+ - [Journey protocol](https://github.com/caikaidev/TapHound/blob/main/docs/journey-schema.md) · [Configuration reference](https://github.com/caikaidev/TapHound/blob/main/docs/config-schema.md) · [Report schema](https://github.com/caikaidev/TapHound/blob/main/docs/report-schema.md)
90
+ - [Principles](https://github.com/caikaidev/TapHound/blob/main/docs/principles.md) · [Workflow Skills and development scenarios](https://github.com/caikaidev/TapHound/blob/main/docs/workflow-skills.md) · [Agent integration](https://github.com/caikaidev/TapHound/blob/main/docs/agent-integration.md) · [Journey Generator guide](https://github.com/caikaidev/TapHound/blob/main/docs/journey-generator-guide.md)
91
+ - [Acceptance Contracts](https://github.com/caikaidev/TapHound/blob/main/docs/contract-schema.md) · [Baselines & regression](https://github.com/caikaidev/TapHound/blob/main/docs/checkpoint-regression.md) · [Failure classification](https://github.com/caikaidev/TapHound/blob/main/docs/failure-classification.md)
92
+ - [Semantic Anchors](https://github.com/caikaidev/TapHound/blob/main/docs/semantic-anchor.md) · [Capability matrix](https://github.com/caikaidev/TapHound/blob/main/docs/capability-matrix.md) · [`observe`](https://github.com/caikaidev/TapHound/blob/main/docs/observe.md)
93
+ - [Runtime backends](https://github.com/caikaidev/TapHound/blob/main/docs/architecture/runtime-backend.md) · [Local development & testing](https://github.com/caikaidev/TapHound/blob/main/docs/local-testing.md) · [Releasing](https://github.com/caikaidev/TapHound/blob/main/docs/releasing.md) · [Diagnostics and feedback](https://github.com/caikaidev/TapHound/blob/main/docs/diagnostics.md)
190
94
 
191
95
  ## Current Limitations
192
96
 
193
- - Only Android is supported, with a single explicitly selected device.
194
- - TapHound does not build or install the APK. It assumes the target app is already installed. Building and installing are done independently by the developer or AI agent in the verification loop.
195
- - The Recorder is a TapHound-mediated interaction flow; it does not observe arbitrary user touches on the device.
196
- - The Recorder only provides swipe for scrollable elements that have bounds from the Android CLI; Replay does not guess swipe regions for elements missing bounds.
197
- - Annotated screenshot fallback applies only to `click` and `longClick`, and requires an explicitly saved `#label`.
198
- - Replay, device operations, and assertions are fully deterministic, with no AI or visual inference.
199
- - The repository provides an Agent Skill installable via `taphound init` for other agents, but there is no dedicated SubAgent wrapper yet.
200
- - Regular tests do not require a real device; Replay and Generation device acceptance requires explicitly setting `TAPHOUND_ACCEPTANCE_DEVICE=1` and meeting external Android prerequisites.
97
+ - Android only, with a single explicitly selected device.
98
+ - TapHound does not build or install APKs; the target app must already be installed.
99
+ - The Recorder is a TapHound-mediated interaction flow; it does not observe arbitrary user touches.
100
+ - Replay, device operations, and assertions are fully deterministic — no AI or visual inference in Core.
package/README.zh-CN.md CHANGED
@@ -1,5 +1,5 @@
1
1
  <p align="center">
2
- <img src="assets/brand/taphound-mark.svg" width="128" alt="TapHound HoundMark">
2
+ <img src="assets/brand/taphound-mark.svg" width="128" alt="TapHound - 基于 AI Agent 的 Android UI 测试与状态验证 CLI 工具">
3
3
  </p>
4
4
 
5
5
  # TapHound
@@ -8,23 +8,42 @@
8
8
 
9
9
  > Follow every tap. Catch every regression.
10
10
 
11
- TapHound 是一个用于 App Journey 录制、生成与确定性验证的 TypeScript/Node.js CLI。当前开发版本 TapHound for Android 支持录制原生 Android 工作流,也支持外部 Agent 基于 Project Context 和实时设备状态生成 Journey。
11
+ **一款基于 AI Agent 驱动的 Android 原生应用 UI 测试与状态验证 CLI 工具。**
12
12
 
13
- TapHound Journey 是本项目完全自研的 JSON 协议、Recorder、Generation、Replay 与断言模型,与 Android CLI 官方 Journey 概念不同且不兼容。TapHound Core 不调用模型:外部 Agent 可以分析源码并提出操作,但状态绑定、风险确认、设备执行、最终 Replay 与断言均由 TapHound 确定性完成。
13
+ TapHound 面向原生 Android 应用,提供 UI **Journey** 的录制、生成与确定性回放,当前开发版本为 TapHound for Android。它面向这样的团队:AI 编码 Agent(Droid、Claude Code、Codex、Cursor 等)写代码的速度已经快过人能审阅的速度。Agent 基于源码与实时设备状态提出测试步骤,TapHound 负责执行、验证与报告——全程确定性,回放链路中不含任何 AI 或视觉猜测——让"完成"意味着在真机上被证明过。
14
14
 
15
- TapHound 只负责验证。编译和安装 APK 是独立的前置步骤,由开发者或 AI Agent 在验证循环中完成:
15
+ TapHound Journey 是本项目自研的 JSON 协议,拥有独立的 Recorder、Generation、Replay 与断言模型,与 Android CLI 官方 Journey 概念不同且不兼容。
16
+
17
+ ## 工作原理
18
+
19
+ TapHound Core 不调用 AI 模型。外部 Agent 可以分析源码并提出操作,但状态绑定、风险确认、设备执行、最终 Replay 与断言均由 TapHound 确定性完成。
20
+
21
+ TapHound 只负责验证。编译和安装 APK 是开发者/Agent 循环中独立的前置步骤,内置 Skill 在两个深度上做检查:
16
22
 
17
23
  ```
18
- 修改代码 → 编译 APK → 安装到设备 → taphound verify → 循环直到符合预期
24
+ 判断改动类型 → 修改代码 → 编译并安装 → taphound-flash(几秒,冒烟)→ 继续修改
25
+ → taphound-verify-change(证明)→ 完成
19
26
  ```
20
27
 
28
+ 改动类型决定证明方式:新行为(无论是否涉及 UI)必须通过 Acceptance Contract;重构(包括 XML → Compose 迁移)必须复现改动前采集的行为。详见 [Workflow Skills](https://github.com/caikaidev/TapHound/blob/main/docs/workflow-skills.md)。
29
+
30
+ ## 核心能力
31
+
32
+ - **录制** —— 在真机上交互式录制 Journey(`taphound record`)。
33
+ - **验证** —— 确定性回放 Journey 并发布报告(`taphound verify`);`verify --diff <ref>` 只回放某次 Git 变更影响的 Journey。
34
+ - **生成** —— AI Agent 驱动的 Journey 生成:步骤绑定证据、敏感操作需风险确认,发布前必须通过一次精确回放(`taphound generation ...`)。
35
+ - **信任链** —— Acceptance Contract、行为 Baseline 与 Failure Classification,把一次回放转化为可审计的判定结论。
36
+ - **知识体系** —— 语义化的 Anchor 与 Screen,让 Journey 在 UI 重构和 resource-id 改名后仍然可用。
37
+ - **Agent Skill** —— 五个可安装的 Skill(`taphound init`):`taphound-flash`(编码过程中只依赖 adb 的独立冒烟检查)、`taphound-verify-change`(完成前的把关:验收新行为或证明行为保持不变)、`taphound-journey-brief-author` 与 `taphound-journey-generator`(把一个 Case 变成经过验证的 Journey)、`taphound-case-suite`(多个 Case 逐个推进)。
38
+
21
39
  ## 环境要求
22
40
 
23
41
  - Node.js 22 或更高版本
24
- - Android SDK、ADB 和一个在线设备或模拟器
25
- - 目标 APK 已安装到设备(TapHound 不负责编译或安装)
26
- - 可调用的 `android` CLI
27
- - macOS 上授予 Android CLI 所需的辅助功能、屏幕录制等权限
42
+ - Android SDK、ADB,以及可调用的 `android` CLI
43
+ - 一个在线设备或模拟器,且目标 APK 已安装
44
+ - macOS 上需授予 Android CLI 辅助功能与屏幕录制权限
45
+
46
+ 单独使用 `taphound-flash` 只需要 Node.js 18+ 与 ADB。
28
47
 
29
48
  先执行环境诊断:
30
49
 
@@ -32,169 +51,50 @@ TapHound 只负责验证。编译和安装 APK 是独立的前置步骤,由开
32
51
  taphound doctor --project /path/to/android-project
33
52
  ```
34
53
 
35
- 未指定 `--device` 时必须恰好有一个状态为 `device` 的设备;存在多个设备时用 `--device <serial>` 明确选择。
36
-
37
- ## 安装与本地开发
38
-
39
- 当前版本可从源码安装:
54
+ ## 安装
40
55
 
41
56
  ```bash
42
57
  npm ci
43
- npm run build
44
- npm link
45
- taphound --help
46
- ```
47
-
48
- 完整本地质量门:
49
-
50
- ```bash
51
- npm test
52
- npm run typecheck
53
- npm run lint
54
- npm run build
55
- npm run brand:render
56
- git diff --exit-code -- assets/brand/png
58
+ npm run dev:setup # 测试、类型检查、Lint、构建、npm link
57
59
  ```
58
60
 
59
- 完整的源码、npm tarball 与 Android 设备验证步骤见[本地测试指南](docs/local-testing.md)。更换开发机器时按[换机后 TODO](TODO.md)继续跟踪剩余验收与 npm `dev` 预发布。
61
+ tarball 与真机验证步骤见[本地测试指南](https://github.com/caikaidev/TapHound/blob/main/docs/local-testing.md),版本发布流程见[发布](https://github.com/caikaidev/TapHound/blob/main/docs/releasing.md)。
60
62
 
61
- ## CLI 命令
63
+ ## 快速上手
62
64
 
63
- - `doctor`:检查 Node.js、ADB、Android CLI、应用安装、权限和设备。
64
- - `record`:交互式执行操作并录制 Journey。
65
- - `verify`:确定性重放 Journey 并发布报告。
66
- - `project describe`:输出稳定的 Android 项目事实。
67
- - `context validate` / `context status`:校验或检查 Project Context。
68
- - `generation start` / `observe` / `step` / `confirm` / `manual` / `finalize`:管理确定性 Journey 生成会话。
69
- - `init`:为 AI Agent 安装 TapHound AI Journey Skill。
70
-
71
- ## 配置
72
-
73
- 在 Android 项目中创建 `taphound.config.json`。`run.packageName` 必填,不会从 APK 文件名或 Activity 猜测;完整示例见 [`examples/taphound.config.json`](examples/taphound.config.json)。
65
+ 在 Android 项目中创建 `.taphound/config.json`(完整字段参考 [config-schema](https://github.com/caikaidev/TapHound/blob/main/docs/config-schema.md),完整示例见 [`examples/.taphound/config.json`](https://github.com/caikaidev/TapHound/blob/main/examples/.taphound/config.json)):
74
66
 
75
67
  ```json
76
68
  {
77
69
  "version": 1,
78
- "run": {
79
- "packageName": "com.example.app",
80
- "activity": ".MainActivity"
81
- },
82
- "idle": {
83
- "pollIntervalMs": 200,
84
- "stablePolls": 2,
85
- "timeoutMs": 5000
86
- },
87
- "artifactsDir": ".taphound/runs"
70
+ "run": { "packageName": "com.example.app", "activity": ".MainActivity" }
88
71
  }
89
72
  ```
90
73
 
91
- ## 交互式录制
92
-
93
- TapHound Recorder 展示当前 Layout,让用户选择 Action 和目标,然后由 TapHound 自己通过 ADB 执行操作。它不监听任意触摸。每个成功步骤自动记录 `activity.before` 与 `activity.after`;失败步骤不会加入 Journey;只有选择 Finish 后才原子写入完整文件。
94
-
95
- ```bash
96
- taphound record \
97
- --project /path/to/android-project \
98
- --config taphound.config.json \
99
- --name "Search flow" \
100
- --output journeys/search.json
101
- ```
102
-
103
- Recorder 不自动生成业务 `expect`。Activity、Element 或 Logcat 断言应由开发者或外部 Agent 显式补充。协议细节见 [Journey Schema](docs/journey-schema.md)。
104
-
105
- 支持的 Action 包括 `click`、`longClick`、`inputText`、`swipe`、`scrollTo`、`back` 和 `wait`。`scrollTo` 在确定的 `container` 中最多滑动 `maxSwipes` 次,目标 `locator` 唯一解析成功后停止,不会继续点击目标。
106
-
107
- ## Agent 驱动的 Journey 生成
108
-
109
- 源码仓库提供 [`taphound-ai-journey` Skill](assets/skills/taphound-ai-journey/SKILL.md),指导 Droid、Claude Code、Copilot、Cursor 等 Agent:
110
-
111
- 1. 使用 `project describe` 和 Android 项目源码生成带证据哈希的 Project Context。
112
- 2. 使用 `context validate` / `context status` 检查 Context 的有效性和时效性。
113
- 3. 启动 `generation` 会话,循环观察权威设备状态、提出严格步骤并交由 TapHound 执行。
114
- 4. 使用 `generation finalize` 从初始状态完整 Replay,并仅在验证通过后发布 Journey。
115
-
116
- ```bash
117
- taphound generation start \
118
- --project /path/to/android-project \
119
- --context .taphound/context/project-context.json \
120
- --device emulator-5554 \
121
- --json
122
- ```
123
-
124
- 设备在 `generation start` 时绑定,后续 `observe`、`step`、`confirm` 和 `manual` 命令通过 session 使用该绑定。完整流程见 Skill 的 [`GUIDE.md`](assets/skills/taphound-ai-journey/GUIDE.md)。
125
-
126
- ### 为其他 AI Agent 安装 Skill
127
-
128
- `taphound init` 将 TapHound AI Journey Skill 复制到各 Agent 的 Skill 目录。交互式多选至少选择一个 Agent:
74
+ 录制一条 Journey,然后回放验证:
129
75
 
130
76
  ```bash
131
- taphound init
77
+ taphound record --project . --name "Search flow" --output .taphound/journeys/search.json
78
+ taphound verify --project . --journey .taphound/journeys/search.json
132
79
  ```
133
80
 
134
- 非交互模式:
81
+ 面向 AI Agent:安装内置 Skill,由 Agent 驱动生成流程:
135
82
 
136
83
  ```bash
137
84
  taphound init --agent claude,codex,cursor,droid
138
85
  ```
139
86
 
140
- 全局安装(用户级目录):
141
-
142
- ```bash
143
- taphound init --agent claude --global
144
- ```
145
-
146
- 支持的 Agent 及路径:
147
-
148
- | Agent | 项目级路径 | 用户级路径 |
149
- |---|---|---|
150
- | Claude Code | `.claude/skills/` | `~/.claude/skills/` |
151
- | Codex | `.agents/skills/` | `~/.agents/skills/` |
152
- | Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
153
- | Droid | `.factory/skills/` | `~/.factory/skills/` |
154
- | Other | `.agents/skills/` | `~/.agents/skills/` |
155
-
156
- Skill 随 npm 包发布,`taphound init` 从包内复制到目标目录。重新运行 `init` 会覆盖已有 Skill 文件。
157
-
158
- ## 确定性验证
159
-
160
- ```bash
161
- taphound verify \
162
- --project /path/to/android-project \
163
- --config taphound.config.json \
164
- --journey journeys/search.json
165
- ```
166
-
167
- 临时覆盖 Package、Activity、设备或报告路径:
168
-
169
- ```bash
170
- taphound verify \
171
- --project /path/to/android-project \
172
- --journey journeys/search.json \
173
- --device emulator-5554 \
174
- --package com.example.app \
175
- --activity .MainActivity \
176
- --reports /tmp/taphound-runs
177
- ```
178
-
179
- Agent 调用时使用:
180
-
181
- ```bash
182
- taphound verify --project . --journey journeys/search.json --json
183
- ```
184
-
185
- `--json` 模式保证 stdout 只有一个最终 JSON 值,进度和诊断写入 stderr。详见 [Agent 集成](docs/agent-integration.md) 与 [报告协议](docs/report-schema.md)。
186
-
187
- ## 报告
87
+ ## 文档
188
88
 
189
- 每次验证写入独立目录,固定包含 `report.json` 与 `summary.txt`,按实际执行结果提供步骤日志,并尽力采集最终截图和完整 Logcat。原始验证失败保存在 `primaryFailure`;截图或日志采集问题进入 `secondaryErrors`,不会覆盖原始失败,对应可选产物也可能缺失。
89
+ - [Journey 协议](https://github.com/caikaidev/TapHound/blob/main/docs/journey-schema.md) · [配置参考](https://github.com/caikaidev/TapHound/blob/main/docs/config-schema.md) · [报告协议](https://github.com/caikaidev/TapHound/blob/main/docs/report-schema.md)
90
+ - [设计原则](https://github.com/caikaidev/TapHound/blob/main/docs/principles.md) · [Workflow Skill 与开发场景](https://github.com/caikaidev/TapHound/blob/main/docs/workflow-skills.md) · [Agent 集成](https://github.com/caikaidev/TapHound/blob/main/docs/agent-integration.md) · [Journey Generator 指南](https://github.com/caikaidev/TapHound/blob/main/docs/journey-generator-guide.md)
91
+ - [Acceptance Contract](https://github.com/caikaidev/TapHound/blob/main/docs/contract-schema.md) · [Baseline 与回归对比](https://github.com/caikaidev/TapHound/blob/main/docs/checkpoint-regression.md) · [失败分类](https://github.com/caikaidev/TapHound/blob/main/docs/failure-classification.md)
92
+ - [Semantic Anchor](https://github.com/caikaidev/TapHound/blob/main/docs/semantic-anchor.md) · [能力矩阵](https://github.com/caikaidev/TapHound/blob/main/docs/capability-matrix.md) · [`observe`](https://github.com/caikaidev/TapHound/blob/main/docs/observe.md)
93
+ - [运行时后端](https://github.com/caikaidev/TapHound/blob/main/docs/architecture/runtime-backend.md) · [本地开发与测试](https://github.com/caikaidev/TapHound/blob/main/docs/local-testing.md) · [发布](https://github.com/caikaidev/TapHound/blob/main/docs/releasing.md) · [诊断与反馈](https://github.com/caikaidev/TapHound/blob/main/docs/diagnostics.md)
190
94
 
191
95
  ## 当前限制
192
96
 
193
- - 只支持 Android 与单个明确选择的设备。
194
- - TapHound 不负责编译或安装 APK,假设目标应用已安装到设备。编译和安装由开发者或 AI Agent 在验证循环中独立完成。
97
+ - 仅支持 Android,且同一时刻只操作一台明确选择的设备。
98
+ - TapHound 不负责编译或安装 APK,目标应用必须已安装到设备。
195
99
  - Recorder 是 TapHound 介导的交互流程,不观察用户在设备上的任意触摸。
196
- - Recorder 只为 Android CLI 返回了 bounds 的 scrollable 元素提供 swipe;Replay 不会为缺失 bounds 的元素猜测滑动区域。
197
- - 标注截图回退只适用于 click 与 longClick,且必须显式保存 `#编号`。
198
- - Replay、设备操作和断言完全确定性,不包含 AI 或视觉推理。
199
- - 源码仓库提供 Agent Skill,也可通过 `taphound init` 为其他 Agent 安装,但尚无专用 SubAgent 封装。
200
- - 普通测试不要求真实设备;Replay 与 Generation 真机验收需要显式设置 `TAPHOUND_ACCEPTANCE_DEVICE=1` 并满足外部 Android 前提。
100
+ - 回放、设备操作与断言完全确定性,Core 中不包含 AI 或视觉推理。