# screencapture

> Take a screenshot of your desktop

Latest version **0.3.1** (published 2018-04-03) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2018-04-03 |
| First published | 2014-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 46.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 48 |
| Author | uiureo |
| Maintainers | uiureo |

## Links

- npm: https://www.npmjs.com/package/screencapture
- Repository: https://github.com/uiureo/node-screencapture
- Homepage: https://github.com/uiureo/node-screencapture#readme
- Issues: https://github.com/uiureo/node-screencapture/issues
- npm.io page: https://npm.io/package/screencapture

## Dependencies (1)

- [tmp](https://npm.io/package/tmp.md) 0.0.33

## Recent versions

- 0.3.1 (latest) — 2018-04-03
- 0.3.0 — 2016-11-04
- 0.2.1 — 2015-11-26
- 0.2.0 — 2015-10-17
- 0.1.0 — 2015-09-07
- 0.0.3 — 2014-05-24
- 0.0.2 — 2014-05-22
- 0.0.1 — 2014-05-21

## README

# node-screencapture
[![Build Status](https://travis-ci.org/uiureo/node-screencapture.svg)](https://travis-ci.org/uiureo/node-screencapture)

Take a screenshot of your desktop interactively.

Available in OSX, Linux, FreeBSD and Windows.

``` javascript
var screencapture = require('screencapture')

screencapture(function (err, imagePath) {
  // then you have imagePath as png.
  //
  // When an user exits screencapture without taking a screenshot,
  // imagePath == null
})
```

You can specify an output file path.
``` javascript
screencapture('/path/to/output.png', function (err, imagePath) {
  // imagePath is '/path/to/output.png' or null
})
```

You can use env named `CAPTURE_COMMAND` for capture.
This is formatted with `%s` for file path; `CAPTURE_COMMAND="shutter -s -e -o %s"`.

## Installation
```
npm install -g screencapture
```

In Linux, you need to install imagemagick.

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