Welcome to 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.

Developer's Guide: