project-checkurl
v1.2.0
Published
CLI tool to detect active URLs
Downloads
0
Readme
project-checkurl
My first repository on Github for Release 0.1
This is a CLI Tool made in Node.js to take a file name as argument, then scan each valid URL found within the document for their availability.
Features:
- Color coded outputs, 🟢green for good links, 🔴red for bad links, 🟡yellow for links with errors and ⚫gray for unknown links.
- Supports windows and unix arguments for version display.
- Request timeout is set to 5 seconds to prevent program from freezing, other errors are catched and displayed back to the client.
- Allows for JSON output format.
Arguments available:
- --v (or --version, /v or /version) to view the current tool's version.
- --g (or --good) to list all good links.
- --b (or --bad) to list all bad links.
- --a (or --all) to view all links.
- --j (or --json) to convert the output into JSON format.
- [filename] (will scan the file of URLs and determine their availability.)
- --i (or --ignore) [ignoreFile] ignores all listed URLs from the document.
How to Use
Installing the package: npm install -g project-checkurl
Check the current version: project-checkurl --v
or project-checkurl --version
Scan file for working URLs: project-checkurl filename.txt
Filter good links only: project-checkurl --g filename.txt
or project-checkurl --good filename.txt
Filter bad links only: project-checkurl --b filename.txt
or project-checkurl --bad filename.txt
Show all links: project-checkurl --a filename.txt
or project-checkurl --all filename.txt
JSON output format: project-checkurl --j filename.txt
or project-checkurl --json filename.txt
Ignore Urls from files: project-checkurl --i ignore-urls.txt filename.txt
or project-checkurl --ignore ignore-urls.txt filename.txt