https://github.com/adamisntdead/poke

A simple tool to check your site for broken links, media, iframes, stylesheets, scripts, forms or metadata.
https://github.com/adamisntdead/poke

cli report seo seo-optimization seotools

Last synced: 5 days ago
JSON representation

A simple tool to check your site for broken links, media, iframes, stylesheets, scripts, forms or metadata.

• Host: GitHub
• URL: https://github.com/adamisntdead/poke
• Owner: adamisntdead
• License: mit
• Created: 2018-02-08T15:56:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-12T22:46:11.000Z (over 6 years ago)
• Last Synced: 2024-10-25T03:58:52.725Z (21 days ago)
• Topics: cli, report, seo, seo-optimization, seotools
• Language: JavaScript
• Size: 13.3 MB
• Stars: 24
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Poke

[![npm](https://img.shields.io/npm/v/poke-site.svg)](https://www.npmjs.com/package/poke-site)

[![Build Status](https://travis-ci.org/adamisntdead/poke.svg?branch=master)](https://travis-ci.org/adamisntdead/poke)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

A simple tool to check your site for broken links, media, iframes, stylesheets, scripts, forms or metadata.

Will also test for images over 500kb.

## Usage

1. Install it: `npm install -g poke-site`

2. Run it: `poke ` where  is the base of the site you want to test

3. Profit

```

  Usage: poke [options] 

  Options:

    -V, --version               output the version number

    -r, --retry [value]         broken links are retried with new hostname

    -s, --shallow               do not check pages rooted outside of provided url

    -m, --max-img-size [value]  looks for images that are over this size in kb. Defaults to 500

    -q, --quiet                 Supress warnings and loading messages(for ci)

    -m, --method [head|post]    HTTP method used to check links, defaults to head

    --skip-images               Skip the image checks

    --skip-duplicates           Skip the duplicate page checks

    -h, --help                  output usage information

```

Sample Output

![Sample Output](https://raw.githubusercontent.com/adamisntdead/poke/master/test/public/output.png)

Usually you should run with the `--shallow` option, otherwise you might get into checking for broken links in twitter or another external site, which you may not want!

## License

MIT