cross-capture

cross-capture

Capture screenshots programmatically. Cross-platform, with support for MacOS (Darwin), Windows, and Linux.

Please consider following this project's author, undefined, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save cross-capture

Usage

import {
  capture, // Automatically detect platform
  captureLinux, // Capture on Linux
  captureDarwin, // Capture on MacOS
  captureWindows // Capture on Windows
} from 'cross-capture';

capture({
  cursor: true
  format: 'png', // this is the default
  window: { interactive: true } // this is the default
})

Requirements

• macOS: Built-in support
• Linux: One of:
  • grim + slurp (Wayland)
  • maim (X11)
  • ImageMagick (import command)
• Windows: PowerShell 5.0+

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2025, . Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on February 17, 2025.