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, eg. HTML syntax and antivirus checks.


See doc/install.txt in the source code archive. Python 2.7.2 or later is needed. It doesn’t work with Python 3 yet, see #40 for details.

pip install linkchecker should NOT be used for now, as it will install the old version of linkchecker. See #4.


Execute linkchecker For other options see linkchecker --help.

Docker usage

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 `

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

Project details

Download files

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

Files for LinkChecker, version 9.4.0
Filename, size File type Python version Upload date Hashes
Filename, size LinkChecker-9.4.0.tar.gz (474.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page