mirror of
https://github.com/vladocar/screenshoteer.git
synced 2024-11-17 01:18:32 +01:00
81 lines
2.5 KiB
Markdown
81 lines
2.5 KiB
Markdown
<h1 align="center"> Screenshoteer </h1>
|
|
|
|
<p align="center"> Makes web screenshots and mobile emulations from the command line. </p>
|
|
|
|
<p align="center"><img src="carbon-shot.png" /></p>
|
|
<hr/>
|
|
|
|
<p>Tool based on <a href="https://github.com/GoogleChrome/puppeteer">puppeteer</a>. </p>
|
|
|
|
<h4>Installation </h4>
|
|
|
|
```shell
|
|
npm i -g screenshoteer
|
|
```
|
|
<p>You can use screenshoteer like this:</p>
|
|
|
|
```shell
|
|
screenshoteer --url https://www.example.com
|
|
|
|
or .html localy copy the url path from the browser
|
|
|
|
screenshoteer --url file:///Users/../index.html
|
|
screenshoteer --url file:///C:/Users/../Random-HTML-file.html
|
|
```
|
|
|
|
<p>And with the help of puppeteer(Headless Chrome) it will generate screenshot of the entire web page.</p>
|
|
|
|
<p>
|
|
Parameters:
|
|
|
|
--url web page url
|
|
--emulate - emulate web device example: --emulate "iPhone 6"
|
|
--fullpage - can be true or false. It will take screenshot of entire web page if is true. True is the default parameter.
|
|
--pdf - generate additional pdf
|
|
--w - width of the Web Page in px
|
|
--h - height of the Web Page in px
|
|
--waitfor - wait time for the page load in milliseconds
|
|
--el - css selector document.querySelector
|
|
--auth - basic http authentication
|
|
--no - exclude "image", "stylesheet", "script", "font"
|
|
--click - example: ".selector>a" excellent way to close popups or to click some buttons on the page.
|
|
--file - output file name (optional, otherwise based on page title and timestamp)
|
|
<p>
|
|
|
|
<h4>Example: </h4>
|
|
|
|
```shell
|
|
screenshoteer --url https://news.ycombinator.com --fullpage false
|
|
|
|
screenshoteer --url https://www.reddit.com/r/nodejs --emulate "iPhone 7"
|
|
|
|
screenshoteer --url https://www.nytimes.com --emulate "Nexus 4"
|
|
|
|
screenshoteer --url https://www.reddit.com/r/javascript/ --w 600 --h 800 --fullpage false
|
|
|
|
screenshoteer --url https://www.reddit.com/r/javascript/ --w 600 --h 0 --fullpage false
|
|
|
|
screenshoteer --url https://lobste.rs --pdf
|
|
|
|
screenshoteer --url https://lobste.rs --w 500
|
|
|
|
screenshoteer --url https://news.ycombinator.com/item?id=18598672 --el ".fatitem"
|
|
|
|
screenshoteer --url https://site.com --auth "username;password"
|
|
|
|
screenshoteer --url https://www.nytimes.com --no "image"
|
|
|
|
screenshoteer --url https://www.nytimes.com --no "script"
|
|
|
|
screenshoteer --url https://www.economist.com/ --click ".ribbon__close-button"
|
|
|
|
screenshoteer --url file:///Users/../index.html
|
|
|
|
screenshoteer --url https://www.slashdot.org --file /tmp/slashdot.png
|
|
```
|
|
<p> List of of supported mobile devices: https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js
|
|
</p>
|
|
|
|
<h3>License</h3>
|
|
|
|
This project is licensed under the MIT License
|