https://github.com/mozzo1000/brkn-lnk

No frills link checker
https://github.com/mozzo1000/brkn-lnk

brokenlinkfinder brokenlinks linkchecker python python3

Last synced: about 5 hours ago
JSON representation

No frills link checker

• Host: GitHub
• URL: https://github.com/mozzo1000/brkn-lnk
• Owner: Mozzo1000
• Created: 2024-09-03T16:38:42.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T16:56:55.000Z (2 months ago)
• Last Synced: 2024-09-07T18:35:08.920Z (2 months ago)
• Topics: brokenlinkfinder, brokenlinks, linkchecker, python, python3
• Language: Python
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# brkn-lnk

brkn-lnk (broken link) is a link checker

# Install

>[!NOTE]

> Binaries are only provided for Windows. 

> 

> The software has only been tested on Windows 11 but may work on other platforms if built from source.

1. Download latest release from the [releases page](https://github.com/Mozzo1000/brkn-lnk/releases) 

2. Save the .exe file in a folder of your choosing.

3. Edit your PATH environment variable to point to the folder that contains the .exe file.

   1. See https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/ for how to edit PATH.

# Usage

## Check single url

`brknlnk https://google.com`

## Check multiple urls

Multiple urls can be passed to the program, separated by spaces.

`brknlnk https://google.com https://bing.com`

## Check urls from CSV file

Passing a csv file will have the program read the file and check every link inside it.

`brknlnk urls.csv`

## Results

By default, a simple list with information on how many urls have passed, returned with warnings or failed to load

```

✅ Passed: 2

⚠️ Warning: 0

❌ Failed: 0

```

A more verbose output can be printed by using the flags `-o stdout-all,stdout-passed,stdout-warning,stdout-failed`.

## Explanation of results

|Status   |Explanation      | 

|----------|-------------|

|Passed |Any 2XX HTTP responsde code  |

|Warning |Other types of errors like bad ssl certificate or unability to connect to host for other reasons than HTTP response codes.  |

|Failed|Any HTTP response code between 3XX and 5XX  |

# Scope

- Provide url(s) and get back http status code.

- If multiple urls are provided they should be processed concurrently (default max 20 connections at a time).

- Configurable options.

- Clean printout to console when processing urls and when everything is finished.