ptywright 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,188 @@
+# ptywright
+
+一个通用的“终端版 DevTools / Playwright driver”原型：通过 PTY 启动任意 CLI/TUI，把 ANSI/VT 输出喂给 `@xterm/headless` 重建屏幕网格，并以 MCP（stdio）暴露工具接口。
+
+## Run
+
+```bash
+bun install
+
+# 默认：启动 MCP server（等价 `ptywright mcp`）
+bun run bin/ptywright
+
+# 显式写法：
+# bun run bin/ptywright mcp
+
+# 可选：以 Streamable HTTP 方式启动（Web transport）
+# bun run bin/ptywright mcp-http --port 3000
+
+# 可选：减少 tool 数量（降低 Agent 上下文压力）
+# bun run bin/ptywright mcp --caps core
+# 或：PTYWRIGHT_CAPS=core bun run bin/ptywright
+```
+
+## Tools (MVP)
+
+工具默认全量开启（等价 `PTYWRIGHT_CAPS=all`）。如需减少 tool 数量，可设置 `PTYWRIGHT_CAPS=core` 或按需组合：
+
+- 默认：`PTYWRIGHT_CAPS=all`
+- 最小：`PTYWRIGHT_CAPS=core`
+- 组合：`PTYWRIGHT_CAPS=core,debug,script,recording`
+
+### core
+
+- `list_sessions` / `select_session`：管理与选择会话
+- `launch_session`：启动 PTY 会话（会自动成为默认会话）
+- `send_text` / `press_key`：发送输入
+- `snapshot_text`：返回可见屏幕文本（适合 Agent “看界面”与做 golden）
+- `snapshot_view`：更适合人看的快照（带元信息+行号）
+- `wait_for_text`：等待文本/正则出现
+- `wait_for_stable_screen`：等待屏幕在 quiet window 内稳定（降低 flaky）
+- `assert`：对当前屏幕做断言（text/regex/semantic）
+- `close_session`：关闭会话
+
+### debug（可选）
+
+- `snapshot_ansi`：返回带 ANSI/SGR 样式的可见屏幕（适合 debug/人眼验收）
+- `snapshot_view_ansi`：带 ANSI/SGR 样式的 `snapshot_view`
+
+### script（可选）
+
+- `run_routine`：一键执行多步交互（type/key/wait/assert/snapshot）
+- `run_script`：运行 `scriptPath=file.json|file.ts` 并产出 artifacts（cast/report/失败快照）
+- `run_all_scripts`：批量运行目录内脚本（递归；支持 `includeEntries/maxEntries` 控制输出）
+- `generate_test_from_doc`：从文档（本地/URL）生成可执行脚本
+- `inspect_failure`：查看最近一次失败的屏幕与错误
+
+### recording（可选）
+
+- `start_script_recording` / `stop_script_recording`：录制 MCP 工具调用并导出可复跑脚本（JSON + goldens）
+- `mark`：在 trace 中打点（asciicast marker event）
+
+`mask`（可选）：`snapshot_text/snapshot_ansi/snapshot_view/snapshot_view_ansi` 支持 `mask=[{regex,flags?,replacement?,preserveLength?}]`，用于把随机 id/时间戳等变成可 diff 的稳定快照
+
+### `press_key` Key Spec
+
+支持单键与“修饰键 + 单键”的组合写法（大小写不敏感，`+`/`-` 都可作为分隔符）：
+- 单字符：`"a"` / `"?"`（原样写入 PTY）
+- 特殊键：`Enter|Return`、`Esc|Escape`、`Backspace`、`Space`、`Tab`、`BackTab`
+- 组合键：`Ctrl+C`、`Ctrl+Shift+R`、`Alt+X`/`Meta+X`、`Shift+Tab`、`Ctrl+Up`
+- 导航键：`Up/Down/Left/Right`、`Home/End`、`PageUp/PageDown`、`Insert/Delete`、`F1..F12`
+- 兼容：`c-x`（等价 `Ctrl+X`）
+
+## Tests
+
+```bash
+bun test
+```
+
+包含：
+- PTY + xterm 解析与快照测试
+- MCP server 端到端 smoke（client 通过 stdio 启动 server 并调用 tools）
+
+## Use With MCP Clients（可选）
+
+本仓库也提供了一个可选的 Codex skill：`skills/ptywright-testing/`，用于指导 Agent 如何用 ptywright MCP/CLI 跑回归并读取 `run.summary.json`（尽量不把超长报告塞进上下文）。
+
+本项目是一个 stdio transport 的 MCP server。直接启动：
+
+```bash
+# 默认等价 `ptywright mcp`
+bun run bin/ptywright
+```
+
+也可以用 Streamable HTTP 启动（默认 endpoint: `http://127.0.0.1:3000/mcp`）：
+
+```bash
+bun run bin/ptywright mcp-http --port 3000
+```
+
+然后在你使用的 MCP client 里把它作为一个 stdio server 配置进去即可（不同 client 的配置方式不同）。
+
+## Script Runner (JSON)
+
+把一次 TUI 测试写成 JSON：启动 → 输入 → 等待 → 快照（可 mask）→ 断言，并自动产出 `.cast` + `report.html`。
+
+可选：在 JSON 顶部加上 schema（编辑器补全/校验更友好）：
+
+```json
+{ "$schema": "../schemas/ptywright-script.schema.json" }
+```
+
+```bash
+bun run script:run scripts/m5_mask_demo.json
+# 或（CLI）
+bun run bin/ptywright run scripts/m5_mask_demo.json
+# 或
+bun run script:m5-mask-demo
+```
+
+批量执行（本地/CI）：
+
+```bash
+bun run script:run-all
+# 或（CLI）
+bun run bin/ptywright run-all
+```
+
+会生成一个总览报告（类似 Playwright report 首页）：
+- 默认：`.tmp/run-all/index.html` + `.tmp/run-all/run.summary.json`
+- 若传入 `--artifacts-root <dir>`：写到 `<dir>/index.html` + `<dir>/run.summary.json`
+
+如果 JSON 里用到了 `type:"custom"`，用 `--steps <module.ts>` 注入 handlers（模块导出 `steps` 对象即可）：
+
+```bash
+bun run script:run examples/json_custom_steps_demo.json --steps scripts/m6_json_custom_steps.ts
+```
+
+产物默认写到 `.tmp/runs/<name>/`（可用 `--artifacts-dir` 覆盖）。
+
+失败时会额外落盘：
+- `failure.error.txt`（错误堆栈）
+- `failure.step.json`（失败的 step 信息）
+- `failure.last.txt` / `failure.last.view.txt`（最后一帧快照）
+
+`report.html` 现在包含 **Timeline View**，展示每一步操作后的屏幕快照（不仅是失败时）。点击顶部 `debug` badge 可切换到调试视图。
+
+Cast Playback（完整录屏）会优先加载 report 同目录的 `asciinema-player.min.js` / `asciinema-player.css`（生成 report 时自动复制），因此离线打开 report 也可播放；若本地资源缺失则会 fallback 到 CDN。
+
+内置 steps（无需 `--steps`）：
+- `assert`：**[NEW]** 断言文本/正则（`text`/`regex`）
+- `assertSemantic`：**[NEW]** 语义断言占位符（`prompt`）
+- `sleep`：固定等待
+- `expectMeta`：断言终端 meta
+- `waitForExit`：等待进程退出
+- `sendMouse`：发送 SGR 鼠标事件
+
+## Script Recording (MCP)
+
+如果你设置了 `PTYWRIGHT_CAPS` 且未包含 `recording`，需要开启 `recording`（例如 `PTYWRIGHT_CAPS=core,recording`）。
+
+在任意 MCP client/Agent 通过 MCP tools 驱动时，可以一键把工具调用“录成脚本”，并在 `mark` 处自动落盘 golden：
+
+1) `start_script_recording(name="my_flow")`
+2) 正常执行：`launch_session/send_text/press_key/wait_for_*`
+3) 关键节点打点：`mark(label="checkpoint")`（会自动生成 `snapshot + expectGolden`）
+4) `stop_script_recording(recordingId=...)`（写入 `scripts/my_flow.json` + `tests/golden/scripts/my_flow/*.txt`）
+
+## Script DSL (TypeScript)
+
+用 TS builder 写 script（类型安全，可组合，支持自定义 step），底层仍复用同一个 runner：
+
+```bash
+bun run script:run scripts/m6_dsl_demo.ts
+```
+
+约定：
+- module 默认导出（`export default`），或导出 `script`。
+- 可选导出 `steps`（custom step handlers），用于执行 `type:"custom"` 的步骤。
+- 常用 handlers 可复用：`src/script/steps/*`。
+- 需要测试“粘贴”时可用 `pasteText("...", { bracketed: true })`（bracketed paste）。
+
+## Cast -> SVG/GIF (可选)
+
+录像类产物建议只用于失败诊断或人工验收；稳定回归优先用 `snapshot_grid` 做 diff。
+
+- SVG: `svg-term`（例如：`bunx svg-term --in <castPath> --out <outSvg>`）
+- TXT: `bun run src/trace/cast_to_txt.ts --in <castPath> --out <outTxt>`
+- GIF: `asciinema/agg`（例如：`agg --fps 30 <castPath> <outGif>`）

package/bin/ptywright

@@ -0,0 +1,4 @@
+#!/usr/bin/env bun
+import { main } from "../src/cli";
+
+await main();

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "ptywright",
+  "version": "0.1.0",
+  "description": "Terminal/TUI automation driver over PTY + xterm, exposed as MCP tools",
+  "keywords": [
+    "agent",
+    "automation",
+    "mcp",
+    "playwright",
+    "pty",
+    "terminal",
+    "testing",
+    "tui"
+  ],
+  "homepage": "https://github.com/kingsword09/ptywright/tree/main#readme",
+  "bugs": {
+    "url": "https://github.com/kingsword09/ptywright/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "Kingsword kingsword09 <kingsword09@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kingsword09/ptywright.git"
+  },
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./mcp": "./src/mcp/server.ts",
+    "./session": "./src/session/terminal_session.ts",
+    "./script": "./src/script/runner.ts"
+  },
+  "bin": {
+    "ptywright": "bin/ptywright"
+  },
+  "files": [
+    "bin",
+    "src",
+    "schemas",
+    "skills",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "scripts": {
+    "dev": "bun run src/index.ts",
+    "test": "bun test",
+    "test:mcp-all-tools": "bun test tests/mcp_all_tools_smoke.test.ts",
+    "lint": "oxlint --type-aware --type-check .",
+    "format": "oxfmt src tests '!tests/fixtures/**'",
+    "format:check": "oxfmt --check src tests '!tests/fixtures/**'",
+    "trace:report": "bun run src/trace/report.ts",
+    "trace:cast-to-txt": "bun run src/trace/cast_to_txt.ts",
+    "script:run": "bun run src/script/run.ts",
+    "script:run-all": "bun run src/script/run_all.ts",
+    "script:m5-mask-demo": "bun run src/script/run.ts scripts/m5_mask_demo.json",
+    "prepublishOnly": "bun run format:check && bun run lint && bun test"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.25.2",
+    "@xterm/headless": "^6.0.0",
+    "asciinema-player": "3.9.0",
+    "bun-pty": "^0.4.7",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "bun-types": "^1.3.6",
+    "oxfmt": "^0.24.0",
+    "oxlint": "^1.39.0",
+    "oxlint-tsgolint": "^0.11.1",
+    "typescript": "^5.9.2"
+  },
+  "engines": {
+    "bun": ">=1.3.6"
+  },
+  "packageManager": "bun@1.3.6"
+}