README.md

Record

Getting Started

Install to your project:

npm install @guidepup/record

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

Resources

• Contributing
• Changelog
• MIT License