Jarink

Jarink is a program to help web administrator and developers to inspect and maintains their website.

SYNOPSIS

jarink [OPTIONS] <COMMAND> <args...>

Available commands,

brokenlinks - scan the website for broken links (page and images).
help        - print the usage of the command.
version     - print the version of program.

USAGE

The brokenlinks command

[OPTIONS] brokenlinks <URL>

The brokenlinks command scan for broken links on the web server pointed by URL. Links will be scanned on the anchor href attribute ("<a href=...>") or on the image src attribute ("<img src=...>").

The URL can be set to domain or with path. Scanning with path will report broken links on that path and their sub paths.

Once finished it will print the page and list of broken links in JSON format to standard output,

{
  "$PAGE": [{
    "value": <string>,
    "url": <string>,
    "error": <string>,
    "status_code": <integer>
  },{
  ...
}

This command accept the following options,

-ignore-status=<comma separated HTTP status code>: List of HTTP status code that will be ignored during scan.

-insecure: Ignore website with invalid certificates.

-past-result=<path to JSON file>: Scan only the pages reported by result from past scan based on the content in JSON file. This minimize the time to re-scan the pages once we have fixed the URLs.

EXAMPLES

Given a website that have the following pages,

web.tld (base)
web.tld/page1
web.tld/page1/sub1
web.tld/page2
web.tld/page2/sub1

The following command will scan all of the pages in the website web.tld.

$ jarink brokenlinks https://web.tld

Invoking brokenlinks on path "/page2" only scan "/page2" and "/page2/sub1".

$ jarink brokenlinks https://web.tld/page2

Ignore HTTP status code 403 and 418,

$ jarink -ignore-status=403,418 brokenlinks https://web.tld/page2

INSTALL

Requirements,

Go compiler
git SCM
make program

Manual installation using Go,

$ go install git.sr.ht/~shulhan/jarink/cmd/jarink
$

This will install the jarink program into $GOBIN directory. Run go env to find out where $GOBIN is located.

Building from source code,

$ git clone https://git.sr.ht/~shulhan/jarink
$ cd jarink
$ make build
$

This will build the jarink program into the current directory.

LICENSE

This software is licensed under GPL 3.0. See the LICENSE file for more information.