Skip to main content

check links in web documents or full websites

Project description

Build Status License

Check for broken links in web sites.


  • 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


Python 3.7 or later is needed. Using pip to install LinkChecker:

pip3 install linkchecker

The version in the pip repository may be old, to find out how to get the latest code, plus platform-specific information and other advice see doc/install.txt in the source code archive.


Execute linkchecker For other options see linkchecker --help, and for more information the manual pages linkchecker(1) and linkcheckerrc(5).

Docker usage

If you do not want to install any additional libraries/dependencies you can use the Docker image which is published on GitHub Packages.

Example for external web site check:

docker run --rm -it -u $(id -u):$(id -g) --verbose

Local HTML file check:

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

In addition to the rolling latest image, uniquely tagged images can also be found on the packages page.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

LinkChecker-10.2.0.tar.gz (545.3 kB view hashes)

Uploaded Source

Built Distribution

LinkChecker-10.2.0-py3-none-any.whl (286.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page