Guidepup Record Library

Guidepup Record provides tools for screen recording.

Here's a typical example:

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

(async () => {
  // Start the screen recording.
  const stopRecording = record("./recordings/screenRecording.mp4");

  // ... perform some commands.

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

On Linux, recording requires an X11 display identified by the DISPLAY environment variable. Wayland-only sessions are not supported.

Contents:

• linuxRecord
• macOSRecord
• record
• windowsRecord

linuxRecord

See: linuxRecord

Start a screen recording on Linux using an X11 display.

macOSRecord

See: macOSRecord

Start a screen recording on macOS.

record

See: record

Start a screen recording using the recorder for the current operating system.

windowsRecord

See: windowsRecord

Start a screen recording on Windows.