# @electron-stagewright/core 中文文档

规范地址：https://npmcn.com/package/%40electron-stagewright/core/

版本：0\.9\.0
npm 元数据更新时间：2026-11-14T03:29:26.321Z
中文译文更新时间：2026-11-14T03:32:10.082Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40electron-stagewright/core
原文对照：https://npmcn.com/package/%40electron-stagewright/core/?lang=original
项目主页：https://electron-stagewright.github.io/electron-stagewright/
源码仓库：https://github.com/electron-stagewright/electron-stagewright

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2.4 MB，620 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：5 个
- peer 依赖：electron \>=12\.2\.0，playwright \>=1\.49\.0
- 首次发布：2026-06-23T04:20:11.036Z
- 最新版本发布：2026-11-14T03:29:26.125Z
- 近 30 天下载量：2528（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

真实的Electronapp的代理UX测试:发射,检查,互动,断言,并通过MCP获取证据.

## 安装

```sh
npm install @electron-stagewright/core
```

也可以使用：`pnpm add @electron-stagewright/core`、`yarn add @electron-stagewright/core`、`bun add @electron-stagewright/core`

## README

# @ electron- stagewright/ core (英语)

MCP 核心服务器 [电相机](https://github.com/electron-stagewright/electron-stagewright)数字 : 真实Electron应用软件的代理UX测试.

启动或附加,检查无障碍树,通过稳定的Refs互动,断言行为 重新尝试预期,并通过《示范背景协议》获取有限度的证据.

> 早释. 在macOS、Windows和 Linux; APIs可能仍然在1.0之前进化.

[运行软件包演示](https://electron-stagewright.github.io/electron-stagewright/guides/demo.html) 或读取 [正在启动指南](https://electron-stagewright.github.io/electron-stagewright/guides/getting-started.html) 在将服务器指向自己的应用程序之前.

## 使用已发布的软件包

要求节点( Node.js 24)或更新,并在Linux上显示服务器(`DISPLAY`, (中文(简体) ), `WAYLAND_DISPLAY`, (中文(简体) ), 或者说 `xvfb-run -a`) (中文(简体) ). 默认发射运输使用 Playwright 和 Electron 运行时间, 因此,启动 CLI ,所有三个可用的软件包。 在将命令交给 MCP 主机之前, 一次在终端上准备: 电子下载它的二进制 第一次有东西加载它, 而下载会打印进取到 stdout, 这将破坏主机的 stdio 协议。 获取 带有 Electron 的 二进制 `install-electron` 选项,然后检查 `doctor` 报告 `"ok": true`。 。 。 . `--prefix ~/` 保留 `npx` 跳过列表软件包,因为 当前工程已经拥有此版本, 这将使服务器无法加载它 :

```bash
npx -y --prefix ~/ --package @electron-stagewright/core@0.9.0 \
  --package playwright@1.63.0 --package electron@42.11.10 install-electron
npx -y --prefix ~/ --package @electron-stagewright/core@0.9.0 \
  --package playwright@1.63.0 --package electron@42.11.10 electron-stagewright doctor --json
```

然后配置或运行正常的服务器命令 :

```bash
npx -y --prefix ~/ --package @electron-stagewright/core@0.9.0 \
  --package playwright@1.63.0 --package electron@42.11.10 electron-stagewright
```

或安装全部三个并直接运行本站:

```bash
npm install -g @electron-stagewright/core@0.9.0 playwright@1.63.0 electron@42.11.10
install-electron
electron-stagewright
```

## 退出时使用

```bash
pnpm install
pnpm build
node packages/core/dist/cli.js
```

有用的 CLI 旗帜 :

-   `--allow-eval` 登记册 `electron_eval_main` 财务报告和审定财务报表 `electron_eval_renderer`。 。 。 .
-   `--tool-profile <essential|testing|debug|full>` 选择一个清晰的核心工具表面. `full` 默认,所以现有设施保存完整的核心目录; eval 并明确 装入的插件独立组成 . `testing` 包含 `electron_screenshot` 测试证据 在不要求更广泛的诊断剖面的情况下进行捕获.
-   `--screenshot-dir <path>` 当工具被写入时更改截图 调用不会通过一条明确的路径.
-   `--app-root <path>` 限制发射/文件路径和制作 `electron_launch({ main })` 使用安装在该工程内的电源包(`runtime: "server"` 选择退出)。 服务器而不是代理选择此根 .
-   `doctor --json` 运行一个机器可读预飞 为节点, Playwright, Electron, 显示设置、 配置路径、 eval 策略、 目标运行时间对齐以及准确服务 配置 。 通过您要使用的同一插件/ 配置/ profile/ 超时/ 演示旗; 医生导入并简单设置那些明确信任的插件, 验证服务器对象 图表,然后把它撕下来。 运行它 `electron-stagewright doctor --json`,从未作为 MCP 服务器 参数.
-   `production validate --app <path> --json` 代表macOS、Windows或 Linux 发布艺术 验证为单独安装 `@electron-stagewright/plugin-production` 软件包。 它离开 没有启动 MCP stdio.

## 用克劳德代码

```bash
claude mcp add electron-stagewright -- \
  npx -y --prefix ~/ --package @electron-stagewright/core@0.9.0 \
  --package playwright@1.63.0 --package electron@42.11.10 \
  electron-stagewright --tool-profile essential
```

运行 `claude mcp list` 确认服务器已连接;其工具显示为 `mcp__electron-stagewright__electron_launch` 诸如来.

本地取出时,请在 `--` 与 `node /abs/path/to/electron-stagewright/packages/core/dist/cli.js`。 。 。 . Claude Code 的默认本地范围限制此设置到当前工程; 使用 `--scope project` 只有在你打算共同犯罪时 `.mcp.json` 配置 .

## 许可证

麻省理工学院. 见 [自由主义](https://npmcn.com/package/LICENSE) 在寄存器根处.

## 常见问题

### @electron-stagewright/core 是什么？

真实的Electronapp的代理UX测试:发射,检查,互动,断言,并通过MCP获取证据\.

### 如何安装 @electron-stagewright/core？

在项目目录运行 npm install @electron-stagewright/core，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 electron-stagewright，可以用 npx electron-stagewright 直接运行。

### @electron-stagewright/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @electron-stagewright/core 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @electron-stagewright/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @electron-stagewright/core 可以商用吗？

@electron-stagewright/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @electron-stagewright/core 的下载量有多少？

根据 npm 官方下载统计，@electron-stagewright/core 在 2026/10/14 – 2026/11/12 这 30 天内被下载 2,528 次，日均约 84 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @electron-stagewright/core 还在维护吗？

最新版本 0\.9\.0 发布于 2026/11/14（今天）；至今共发布 16 个版本，其中过去 12 个月发布了 16 个；首次发布于 2026/06/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。