Giter VIP home page Giter VIP logo

screen-scout's Introduction

Screen-Scout

screen-scout_logo

Screen-Scout is a tool for capturing screenshots of web pages and their linked pages. It's built on top of Puppeteer and allows users to recursively capture screenshots of a web page and all linked pages within specified depth and page limits.

Features

  • Webpage Screenshot Capturing: Take screenshots of individual web pages.
  • Recursive Link Navigation: Follow links within a page to capture screenshots of linked pages.
  • Customizable Depth and Page Limits: Control how deep the tool goes into linked pages and the maximum number of pages to capture.
  • Resolution and File Type Options: Specify the resolution of the screenshots and choose between different file formats (PNG, JPEG, WebP, PDF).
  • Enhanced Link Filtering: Option to include or exclude external links and avoid capturing duplicate or same-page links.

Installation

Ensure you have Node.js installed, then clone the repository and run:

npm install

This will install all required dependencies, including Puppeteer.

Usage

Run the script from the command line, specifying the required options. Here is an example command:

node screen-scout.js --url "https://example.com" --resolution "1280x720" --output "./output" --type "png" --depth 2 --maxPages 10 --followExternal false

Command Line Options

  • --url, -u: The URL of the webpage to capture (required).
  • --resolution, -r: Screen resolution in the format WIDTHxHEIGHT (default: '1920x1080').
  • --output, -o: Directory to save the screenshot or PDF (default: './screenshots').
  • --type, -t: Output file type (options: 'png', 'jpeg', 'webp', 'pdf'; default: 'png').
  • --depth, -d: Recursion depth for following links (default: 1).
  • --maxPages, -m: Maximum number of pages to capture (default: 10).
  • --followExternal, -f: Whether to follow external links (default: false).

Contributing

Contributions to Screen-Scout are welcome! Feel free to open issues or submit pull requests.

License

Screen-Scout is released under the MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.