README.md

link-checker-tool

This tool is used to check whether an URL is available or not.

Features

• Offline support
• Check all valid URLs in a file
• Read multiple files at once
• Check if an URL is available
• Optimize code for header requests
• Check archived versions of a website
• Output json format result
• Only display good/bad urls from a file
• Exclude URLs from our check based on a URL pattern file.

Usage

To Install the package

$ npm -i link-checker-tool

or to install globally

$ npm install -g link-checker-tool

Check all URL in a file

$ lct -f foo.js

Check a single URL

$ lct -u https://github.com/phast184/link-checker-tool.git
$ lct --url https://github.com/phast184/link-checker-tool.git

Check archived versions of a website

$ lct -a https://www.google.com/
$ lct --archived https://www.google.com/

Read multiple files at once

$ lct -f index2.html test1.txt test.txt

Output only good urls (from multiple files)

$ lct -g foo.js
$ lct --good foo.js

$ lct -g foo.js foo1.js
$ lct --good foo.js foo1.js

Output only bad urls (from multiple files)

$ lct -b foo.js
$ lct --bad foo.js

$ lct -b foo.js foo1.js
$ lct --bad foo.js foo1.js

JSON format output

$ lct -j https://github.com/phast184/link-checker-tool
$ lct --json https://github.com/phast184/link-checker-tool

Ignore URL Patterns

$ lct -i ingonre-urls.txt -f test.txt

Note: i option can be used with any other available options : -f-,-g, -b, -a

Output

GOOD: the URL is available with the status code of 200

BAD: the URL is not available with the status code of 400 or 404

UNKNOWN: other status code will be shown as unknown

License

MIT © [Thanh Tien Phat Nguyen]