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: and local file links support

  • restrict link checking with regular expression filters for URLs

  • proxy support

  • username/password authorization for HTTP and FTP

  • honors robots.txt exclusion protocol

  • Cookie support

  • HTML5 support

  • a command line and web interface

  • various check plugins available

Installation

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

pip3 install linkchecker

pipx can also be used to 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.

Usage

Execute linkchecker https://www.example.com. 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) ghcr.io/linkchecker/linkchecker:latest --verbose https://www.example.com

Local HTML file check:

docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt ghcr.io/linkchecker/linkchecker:latest --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.6.0.tar.gz (547.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

LinkChecker-10.6.0-py3-none-any.whl (280.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: LinkChecker-10.6.0.tar.gz
  • Upload date:
  • Size: 547.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for LinkChecker-10.6.0.tar.gz
Algorithm Hash digest
SHA256 fb7e8facda7749c2fa5fa5dc241c0adc302da3d31d588964a2570db501aa49e5
MD5 d40ecbc729dc6c6f262d385ca0f29903
BLAKE2b-256 6e601ad47dd9db638546c4e70b49b5adfddfaadb2c6669a1a9b06a4dcf140d7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for LinkChecker-10.6.0.tar.gz:

Publisher: release-files.yml on linkchecker/linkchecker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: LinkChecker-10.6.0-py3-none-any.whl
  • Upload date:
  • Size: 280.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for LinkChecker-10.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5268587ed0b0f7e7521b75905128c96856f30f67dad49f66e2c963bc174ca92d
MD5 55caa5d4c881556d00d20243ae8d6536
BLAKE2b-256 d207ff8a29330fa35483a19221fd89e102e7ebf700acda8f0ba0b66ef14bcd48

See more details on using hashes here.

Provenance

The following attestation bundles were made for LinkChecker-10.6.0-py3-none-any.whl:

Publisher: release-files.yml on linkchecker/linkchecker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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