https://github.com/umpox/generateDeviceScreenshots
A simple command line tool to generate device screenshots of different webpages.
https://github.com/umpox/generateDeviceScreenshots
device-screenshots headless-chrome nodejs screenshot-generator
Last synced: about 1 year ago
JSON representation
A simple command line tool to generate device screenshots of different webpages.
- Host: GitHub
- URL: https://github.com/umpox/generateDeviceScreenshots
- Owner: umpox
- License: mit
- Created: 2017-08-17T12:16:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-25T11:11:06.000Z (almost 9 years ago)
- Last Synced: 2025-03-30T22:41:48.532Z (over 1 year ago)
- Topics: device-screenshots, headless-chrome, nodejs, screenshot-generator
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 70
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# generate-device-screenshots
A simple command line tool to generate device screenshots of different webpages.
## Installation
*generate-device-screenshots requires Node version 7.10 or greater*
To use generate-device-screenshots in your project, run:
```
npm i generate-device-screenshots
```
Then add the following to your `package.json` file
```
"scripts":{
"generate-device-screenshots": "generate-device-screenshots"
}
```
> **Note**: Installing generate-device-screenshots will install [Puppeteer](https://github.com/GoogleChrome/puppeteer), a headless version of Chromium (~71Mb Mac, ~90Mb Linux, ~110Mb Win)
## Usage
#### Generate screenshot from a single device
`npm run generate-device-screenshots https://example.com "iPhone 6"`
#### Generate screenshots from multiple devices
`npm run generate-device-screenshots https://example.com "iPhone 6, Nexus 10, iPhone 4"`
#### Generate screenshots from [every device currently available in Google developer tools](https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js)
`npm run generate-device-screenshots https://example.com "all"`
#### Generate fullscreen screenshot
`npm run generate-device-screenshots https://example.com "iPhone 6" fullscreen`
#### Generate screenshot without prompting the user for confirmation (used in a build process)
`npm run generate-device-screenshots https://example.com "iPhone 6" force-yes`
## Parameter documentation
`npm run generate-device-screenshots `
```
- Required
- Example: https://example.com
```
```
- Required
- Example 1: "iPhone 6"
- Example 2: "iPhone 6, iPhone 5"
- Example 3: "all"
- Must be a valid and exact name from the list of available devices or "all" to use every device
```
```
- Optional
- Example: fullscreen
```
```
- Optional
- Example: force-yes
```
## [Example Screenshots](EXAMPLES.md)