Skip to main content

check links in web documents or full websites

Project description

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

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.0.0.tar.gz (523.0 kB view details)

Uploaded Source

Built Distribution

LinkChecker-10.0.0-py3-none-any.whl (267.0 kB view details)

Uploaded Python 3

File details

Details for the file LinkChecker-10.0.0.tar.gz.

File metadata

  • Download URL: LinkChecker-10.0.0.tar.gz
  • Upload date:
  • Size: 523.0 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for LinkChecker-10.0.0.tar.gz
Algorithm Hash digest
SHA256 f966238ea635526fcb159a5534980e2d0af83f0fba866b024142687ea7e1fcb7
MD5 d222e8223dd123bb833e42448726623c
BLAKE2b-256 db0224196f3296bb6982fb31a5f84907095e1636d5a9c90f22884e15d175ba44

See more details on using hashes here.

File details

Details for the file LinkChecker-10.0.0-py3-none-any.whl.

File metadata

  • Download URL: LinkChecker-10.0.0-py3-none-any.whl
  • Upload date:
  • Size: 267.0 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for LinkChecker-10.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd24f86a3c165071093d88cdf2040832ac1fbfb72078ab608d129701cb953d1e
MD5 c94a81eb28481270d1a6690916198ea6
BLAKE2b-256 9e897183de883f6451d01407cc7a39e047cc9dd2f90b1bde8f4417b0e3794e62

See more details on using hashes here.

Supported by

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