Skip to main content

Build Status License

Check for broken links in web sites.

Features

  • recursive and multithreaded checking and site crawling

  • output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats

  • HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and local file links support

  • restrict link checking with regular expression filters for URLs

  • proxy support

  • username/password authorization for HTTP, FTP and Telnet

  • honors robots.txt exclusion protocol

  • Cookie support

  • HTML5 support

  • a command line and web interface

  • various check plugins available, eg. HTML syntax and antivirus checks.

Installation

See doc/install.txt in the source code archive for general information. Except the given information there, please take note of the following:

Python 3.6 or later is needed.

The version in the pip repository may be old. Instead, you can use pip to install the latest code from git: pip3 install git+https://github.com/linkchecker/linkchecker.git.

Usage

Execute linkchecker https://www.example.com. For other options see linkchecker --help.

Docker usage

The Docker images are out-of-date, pip installation is the only currently recommended method.

If you do not want to install any additional libraries/dependencies you can use the Docker image.

Example for external web site check:

docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://www.example.com

Local HTML file check:

docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html

Metadata

Release files for LinkChecker 10.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for LinkChecker 10.0.0
File Size Uploaded
LinkChecker-10.0.0.tar.gz 523.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for LinkChecker 10.0.0
File Interpreter ABI Platform
LinkChecker-10.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 790.0 kB

Release files / LinkChecker-10.0.0.tar.gz

Download URL LinkChecker-10.0.0.tar.gz
Size 523.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f966238ea635526fcb159a5534980e2d0af83f0fba866b024142687ea7e1fcb7
BLAKE2b-256 checksum
How to use checksums
db0224196f3296bb6982fb31a5f84907095e1636d5a9c90f22884e15d175ba44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.14.2 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5

Release files / LinkChecker-10.0.0-py3-none-any.whl

Download URL LinkChecker-10.0.0-py3-none-any.whl
Size 267.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cd24f86a3c165071093d88cdf2040832ac1fbfb72078ab608d129701cb953d1e
BLAKE2b-256 checksum
How to use checksums
9e897183de883f6451d01407cc7a39e047cc9dd2f90b1bde8f4417b0e3794e62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.14.2 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5

Release history Release notifications | RSS feed

10.6.0

2 release files

10.4.0

2 release files

10.3.0

2 release files

10.2.0

2 release files

10.1.0

2 release files

10.0.1

2 release files

This release

10.0.0 This release

2 release files

9.4.0

1 release file

9.3

1 release file

9.2

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page