Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.98 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.98 KB
Raw

me-check-links

A simple command-line tool to check the status of links

Installation

npm:
npm i @Jasper-mui/me-check-link -g


or

manually:

  1. Download files via the zip file or using git
  2. To install dependencies:
    npm install
  3. To create a symlink for the command:
    npm link

What is it for?

MCl command is used to quickly find bad links of HTTP status of 400 or 404. (Please do not rely on this tool as it is not robust enough to do so. Use it as an aid)

How to use

MCL - a command to check links of a HTML page
if no arguments are supplied, a help message will be displayed
Options:
-v or /v, to get the version number and name of the tool
-u or /u, to check the links of a HTML page of supplied URL
-j or /j, change output to json format, all links display in green no long follows color rules
-b or /b, this flag will only show bad links, no flag specified will show all links -g or /g, this flag will onyl show good links, no flag specified will show all links

Feature

  • The result of the links shows up in color to display the status of links. Does not apply to -j option as all links will show in green
  1. Green links are good links with an HTTP status of 200.
  2. Red links are bad links of HTTP status 400 or 404.
  3. Grey links are unknown with any other HTTP status.

  • The command can check HTML pages links via URL using -u option and supplying a valid HTTP URL.

  • The tool can check multiple URLs or HTML files to be checked at once if more than enter one URL or HTML file is entered one after another, separated by a space.
    But url and html cannot be mixed together in a single command.
    The -u option is still required when checking multiple URLs.

  • Handles Unix and windows style of args -u or /u

  • Handles links that cause timeouts smoothly

  • Output in JSON format

  • Flags to choice to only show good or bad links