@guidepup/record

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

Tools for screen recording.

原始使用文档
文档目录6 节
  1. Getting Started
  2. Automatic platform selection
  3. Windows
  4. MacOS
  5. Linux
  6. Resources

Record

Available on NPM Test workflows This project uses the MIT license

Getting Started

Install to your project:

npm install @guidepup/record

Automatic platform selection

Use record to select the recorder for the current operating system:

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

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

// ... perform some commands.

await stopRecording();

On Linux, automatic selection uses the X11 recorder and requires the DISPLAY environment variable. Wayland-only sessions are not supported.

Windows

Start a screen recording on 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();
})();

MacOS

Start a screen recording on 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();
})();

Linux

Start a screen recording on Linux using an X11 display. The DISPLAY environment variable must identify the display. Wayland-only sessions are not supported by this recorder.

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();
})();

Resources

版本与发布记录

@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 是什么?

Tools for screen recording.

如何安装 @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 和提交记录判断。