Skip to content
Switch branches/tags


Failed to load latest commit information.
Latest commit message
Commit time


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 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+


Execute linkchecker 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

Local HTML file check:

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