@guidepup/record

中文文档
0.3.0发布于 2026/10/11MITTypeScriptCommonJS构建来源已验证近 30 天下载 13.8万

用于屏幕记录的工具 .

中文使用文档
文档目录6 节
  1. 开始
  2. 自动选择平台
  3. 窗口
  4. 麦克OS
  5. 链接
  6. 资源

记录

Available on NPM Test workflows This project uses the MIT license

开始

安装到您的工程 :

npm install @guidepup/record

自动选择平台

使用 record 以选择当前操作系统的记录器 :

import { record } from "@guidepup/record";

const stopRecording = record("./recordings/screenRecording.mp4");

// ... perform some commands.

await stopRecording();

在 Linux 上,自动选择使用 X11 记录器并需要 DISPLAY 环境变量。 仅Wayland会话不支持.

窗口

在 Windows 上开始屏幕记录 :

import { windowsRecord } from "@guidepup/record";

(async () => {
  // Start the screen recording passing the location to save the recording.
  const stopRecording = windowsRecord("./recordings/screenRecording.mp4");

  // ... perform some commands.

  // Stop the screen recording.
  await stopRecording();
})();

麦克OS

在MacOS上开始屏幕录制.

import { macOSRecord } from "@guidepup/record";

(async () => {
  // Start the screen recording passing the location to save the recording.
  const stopRecording = macOSRecord("./recordings/screenRecording.mov");

  // ... perform some commands.

  // Stop the screen recording.
  await stopRecording();
})();

链接

使用 X11 显示器在 Linux 上启动屏幕记录 。 这个 DISPLAY 环境变量必须识别显示。 只有Wayland会议不是 由此记录器支持.

import { linuxRecord } from "@guidepup/record";

(async () => {
  // Start the screen recording passing the location to save the recording.
  const stopRecording = linuxRecord("./recordings/screenRecording.mp4");

  // ... perform some commands.

  // Stop the screen recording.
  await stopRecording();
})();

资源

版本与发布记录

@guidepup/record 共发布 3 个版本,首次发布于 2024/09/14;过去 12 个月发布了 2 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.0latest2026/10/111 个月前
0.2.02026/09/281 个月前
0.1.02024/09/142 年前

关于 @guidepup/record 的常见问题

@guidepup/record 是什么?

用于屏幕记录的工具 .

如何安装 @guidepup/record?

在项目目录运行 npm install @guidepup/record,或使用 pnpm add / yarn add / bun add。

@guidepup/record 支持 TypeScript 吗?

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

@guidepup/record 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@guidepup/record 可以商用吗?

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

@guidepup/record 的下载量有多少?

根据 npm 官方下载统计,@guidepup/record 在 2026/10/17 – 2026/11/15 这 30 天内被下载 137,617 次,日均约 4,587 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@guidepup/record 还在维护吗?

最新版本 0.3.0 发布于 2026/10/11(1 个月前);至今共发布 3 个版本,其中过去 12 个月发布了 2 个;首次发布于 2024/09/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。