npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@17ued/pappet

v0.0.1

Published

A command-line tool to crawl websites using puppeteer.

Downloads

3

Readme

pappet

npm npm

Pappet is a command-line tool to crawl websites using puppeteer. It allows you to crawl multiple pages in parallel and recursively. Take screenshots or create PDFs in seconds.

Install

npm i -g pappet

Usage

Usage: pappet [OPTION]... [URL]...
Options:
  --help                 Show help
  --version              Show version number
  -q, --quit             Be quit
  -t, --tabs             Set number of pages
  -s, --screenshot       Take a screenshot
  -p, --pdf              Take a PDF
  -m, --mhtml            Save as mhtml
  -r, --recursive        Recursively visit links
  -l, --level            Set recursion depth
  -w, --width            Set page width
  -h, --height           Set page height
  -f, --full-page        Take a screenshot of the full scrollable page
  -L, --relative         Follow relative links only
  --device-scale-factor  Specify device scale factor
  --is-mobile            Take meta viewport into account
  --has-touch            Support touch events
  --is-landscape         Set viewport in landscape mode
  --https-only           Follow HTTPS links only
  --same-origin          Only visit pages with same origin
  --disable-js           Disable javascript
  --user-agent           Set user agent
  --pattern              Only follow links that match the supplied regular expression

Examples

Pappet allows you to write most of the options in a long and short form. I will use the shorter syntax here for convenience.

Take a screenshot (-s, --screenshot)
pappet -s https://example.com

You can also specify the width and height of the viewport.

pappet -s -w 800 -h 600 https://example.com

Take a screenshot of the full scrollable page. By specifying the option -f or --full-page.

pappet -sf https://example.com
Take a PDF (-p, --pdf)
pappet -p https://example.com
Save page as mhtml (-m, --mhtml)
pappet -m https://example.com
Crawl a website recursively and take screenshots (-r, --recursive)
pappet -sr https://example.com

When crawling websites recursively you should specify a maximum depth (default 1) for not crawling to long. You can do that by using the -l or --level option.

pappet -srl2 https://example.com
Crawl multiple pages at once

You can specify a infinite number of URLs to crawl.

pappet -rs https://example.com https://example.com

When doing this it's recommended to use the option -t or --tabs. This will set the maximum number of pages used by puppeteer (default 2). The more pages you have the faster it will be. Be careful by specifying this option. Some websites may block you, for sending to many requests at once.

pappet -rst4 https://example.com
Disable javascript and take a screenshot
pappet -sf --disable-js https://example.com
Only visit pages with same origin

This will only follow links of the same origin (example.com).

pappet -rs --same-origin https://example.com
Only follow relative links
pappet -rsL https://example.com
Using regular expression
pappet -rp --pattern "/articles/.*" https://example.com