rms-link-checker
rms-link-checker is a Python command-line application that crawls a website starting from a given root URL, checks all discovered links for validity, detects misplaced asset files, and produces a plain-text report summarizing the results.
Full documentation is available at rms-link-checker.readthedocs.io.
Features
- Crawls an entire website starting from a single root URL
- Checks all discovered links (internal and external) for validity
- Detects broken links (4xx/5xx responses) and broken anchor fragments
- Follows and reports redirect chains
- Detects misplaced asset files (images, documents, scripts, etc.)
- Configurable depth limit, request limit, and thread count
- YAML configuration file support with CLI override precedence
- Non-HTTP scheme links (mailto:, tel:, etc.) recorded and reported
- SSL certificate errors reported per domain
- Plain-text report with 11 sections
Installation
End-user (recommended)
pipx install rms-link-checker
Developer
git clone https://github.com/SETI/rms-link-checker.git
cd rms-link-checker
python3 -m venv venv
source venv/bin/activate
pip install -e ".[dev]"
Quick Start
link_check https://example.com
With options:
link_check https://example.com --max-depth 3 --max-threads 20 -o report.txt
With a configuration file:
link_check --config-file config.yaml
Contributing
Information on contributing to this package can be found in the Contributing Guide.
Licensing
This code is licensed under the Apache License v2.0.
2 maintainers
Metadata
2 maintainers
Release files for rms-link-checker 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rms_link_checker-2.0.0.tar.gz | 127.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rms_link_checker-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 165.3 kB
Release files / rms_link_checker-2.0.0.tar.gz
| Download URL | rms_link_checker-2.0.0.tar.gz |
|---|---|
| Size | 127.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c16649c9b8bf434cf78cf9b07bf65203ebb0c955df03bf74eea612a1966a5a5
|
|
BLAKE2b-256 checksum How to use checksums |
e1ac91c00ca6470d06400e66edfabdbdf0b7217b7a1f47e8f6e9dc490c0120e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / rms_link_checker-2.0.0-py3-none-any.whl
| Download URL | rms_link_checker-2.0.0-py3-none-any.whl |
|---|---|
| Size | 38.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
83e32516e75872fdc20df61fdc4ea1d4dc09d3527226532988c5a2d0440640e4
|
|
BLAKE2b-256 checksum How to use checksums |
ffa96264971911f143081fa42e8c86aafeb16ff42211050a84ca1fcbcb45d60b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
