Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 1.37 KB

README.md

File metadata and controls

95 lines (61 loc) · 1.37 KB
Raw

linkChek

CLI tool to check links from a html file or url

Install

npm install -g link-chek
npx link-chek

How to use

linkChek -l [Filename or Webpage (Absolute) URL]

GIF PREVIEW

GIF PREVIEW

HTTP Responses

  • [GOOD] HTTP Response Code 200 - Success
  • [BAD] HTTP Response Code 400/404 - Bad Request/Not Found
  • [UNKNOWN] HTTP Response Code 3XX/5XX/etc. - Other Response (Redirect, Server Error, etc.)

Options

To check if HTTP links work with HTTPS

linkChek -l [Filename or Webpage (Absolute) URL] -o

To set a Timeout

linkChek -l [Filename or Webpage (Absolute) URL] -t 7000

Output JSON Option


Outputs JSON array consisting of url, and response status values

linkChek -l [Filename or Webpage (Absolute) URL] -j

All/Good/Bad Flags

  • All - Outputs all results (Default)
  • Good - Outputs only [GOOD] (200) Results
  • Bad - Outputs only [BAD] (400/404) Results
linkChek -l [Filename or Webpage (Absolute) URL] --all/--good/--bad

Version Number

linkChek -v

Help Option

linkChek -h

Tests

To run tests, use the npm script

npm test

or

npm test [component].test.js

License

This project is licensed under the MIT License - see the LICENSE file for details