LinkStatus

README

LinkStatus Release v1.0.3

LinkStatus reads a supplied file, finds, and checks links via a GET request. The program returns the status codes of the links and lists them for the user in colour. A few test files are included within the project.

This program was developed using the GO programming language.

Introduction

Hello to the person reading this. This is my release 0.1 project for the DPS909 class. The class is about open source development and this project had us use git and communicate with one another to solve problems we had during development.

I have a blog going alongside the development of this project and future projects for this class which you can find here.

Installation

Install GO on your machine and reboot. Then:

Use the package manager to install LinkStatus OR download the zip from the lastest tag and extract it within your go/src/

If installed via package manager

git clone https://github.com/MSTEWARDSON/LinkStatus.git
cd LinkStatus
go install

If you downloaded, run:

go get github.com/MSTEWARDSON/LinkStatus

Usage

After installing, navigate to any directory and run any of the following commands:

To recieve help information run the program with no arguments:

LinkStatus

To see the current version run:

LinkStatus -v or --version

To run the program with a file and check the links use:

LinkStatus filename

To output the data in JSON format:

LinkStatus filename -j or --json

To output all url response types:

LinkStatus filename -a or --all

To output only good url response types:

LinkStatus filename -g or --good

To output only bad url response types:

LinkStatus filename -b or --bad

To ingnore url patterns in ignore.txt:

LinkStatus filename -i or --ignore

Libraries Used

• net http: Used to handle the GET requests and Timeout features
• regexp: Used to search for http and https links in a string
• fatih color: USed to bring colour to the console output
• pflag: Used to add the optional -v or --version command line arguments

License

MIT