diff options
| author | Shulhan <ms@kilabit.info> | 2025-06-12 21:36:47 +0700 |
|---|---|---|
| committer | Shulhan <ms@kilabit.info> | 2025-06-12 21:40:55 +0700 |
| commit | 23f6c2f1df71a8c244c09ce4fd6dd221ad658ddc (patch) | |
| tree | cc6f920a7ecad96f6b9c4ea1633532d3777dd808 /README | |
| parent | a02e915388723a5d8cc3b555fb3dfec477fc2a55 (diff) | |
| download | jarink-23f6c2f1df71a8c244c09ce4fd6dd221ad658ddc.tar.xz | |
all: rename README to README.adoc
Diffstat (limited to 'README')
| -rw-r--r-- | README | 77 |
1 files changed, 0 insertions, 77 deletions
@@ -1,77 +0,0 @@ -= Jarink - -Jarink is a program to help web administrator and developers to inspect -and maintains their website. - -== Synopsis - - jarink [OPTIONS] <COMMAND> <args...> - -Available command, - - brokenlinks - scan the website for broken links (page and images). - help - print the usage of the command. - -== Usage - -[OPTIONS] brokenlinks <URL> - - Scan for broken links on the web server pointed by URL. - Links will be scanned on anchor href attribute ("<a href=...>") or - on the image src attribute ("<img src=..."). - - The URL can be start from base or from sub path. - Scanning from path only report brokenlinks 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": [{ - "link": <string>, - "error": <string>, - "code": <integer> - }, - ... - ], - ... - } - - This command accept the following options, - - -verbose - - Print the page that being scanned to standard error. - - -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. - - For example, 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 - - Invoking brokenlinks with - - $ jarink brokenlinks https://web.tld - - will scan all of the pages, but invoking brokenlinks on path - "/page2" - - $ jarink brokenlinks https://web.tld/page2 - - only scan "/page2" and "/page2/sub1". - - -== Notes - -jarink version 0.1.0. - -Source code - https://git.sr.ht/~shulhan/jarink |