# node-screencapture

> Desktop screencapture using nodejs and vlc

Latest version **1.0.0** (published 2015-03-19) · WTF license · 0 weekly downloads

## Install

```sh
npm install node-screencapture
pnpm add node-screencapture
yarn add node-screencapture
bun add node-screencapture
```

Provides the command `node-screencapture`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-03-19 |
| First published | 2015-03-19 |
| Weekly downloads | 0 |
| License | WTF |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | maboiteaspam |
| Maintainers | maboiteaspam |
| Keywords | nodejs, screencapture, screenshot |

## Links

- npm: https://www.npmjs.com/package/node-screencapture
- Repository: https://github.com/maboiteaspam/node-screencapture
- Issues: https://github.com/maboiteaspam/node-screencapture/issues
- npm.io page: https://npm.io/package/node-screencapture

## Dependencies (2)

- [temp](https://npm.io/package/temp.md) ^0.8.1
- [commander](https://npm.io/package/commander.md) ^2.7.1

## Recent versions

- 1.0.0 (latest) — 2015-03-19

## README

# node-screencapture

A command line binary to take a screenshot of the desktop.

It is using vlc to realize screenshot.

### Requirements

Get vlc installed. This module won t check or install it for you.

### Install

```
npm i node-screencapture -g
```

### Usage

```
  Usage: node-screencapture [options]
  node-screencapture --output some.png

  Options:

    -h, --help               output usage information
    -V, --version            output the version number
    --format <format>        File format jpg, png
    -o, --output <filePath>  Output file path
    --vlc <vlcPath>          VLC binary path
```

### Api

```js
var shooter = new VlcScreenshot();

shooter.format = program.format || 'png';
shooter.vlcPath = program.vlc || 'cvlc';

shooter.shoot(program.output, function(){
  console.error('All done  !');
});

```

---
_Source: https://npm.io/package/node-screencapture · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._