LinkChecker
============
|Build Status|_ |License|_
.. |Build Status| image:: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml/badge.svg?branch=master
.. _Build Status: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml
.. |License| image:: https://img.shields.io/badge/license-GPL2-d49a6a.svg
.. _License: https://opensource.org/licenses/GPL-2.0
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.
.. _doc/install.txt: https://linkchecker.github.io/linkchecker/install.html
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)`_.
.. _linkchecker(1): https://linkchecker.github.io/linkchecker/man/linkchecker.html
.. _linkcheckerrc(5): https://linkchecker.github.io/linkchecker/man/linkcheckerrc.html
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.
.. _packages: https://github.com/linkchecker/linkchecker/pkgs/container/linkchecker
Raw data
{
"_id": null,
"home_page": null,
"name": "LinkChecker",
"maintainer": "LinkChecker Authors",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "checking, crawling, link, site, url, validation, verification",
"author": "LinkChecker Authors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6e/60/1ad47dd9db638546c4e70b49b5adfddfaadb2c6669a1a9b06a4dcf140d7b/LinkChecker-10.6.0.tar.gz",
"platform": null,
"description": "LinkChecker\n============\n\n|Build Status|_ |License|_\n\n.. |Build Status| image:: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml/badge.svg?branch=master\n.. _Build Status: https://github.com/linkchecker/linkchecker/actions/workflows/build.yml\n.. |License| image:: https://img.shields.io/badge/license-GPL2-d49a6a.svg\n.. _License: https://opensource.org/licenses/GPL-2.0\n\nCheck for broken links in web sites.\n\nFeatures\n---------\n\n- recursive and multithreaded checking and site crawling\n- output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats\n- HTTP/1.1, HTTPS, FTP, mailto: and local file links support\n- restrict link checking with regular expression filters for URLs\n- proxy support\n- username/password authorization for HTTP and FTP\n- honors robots.txt exclusion protocol\n- Cookie support\n- HTML5 support\n- a command line and web interface\n- various check plugins available\n\nInstallation\n-------------\n\nPython 3.9 or later is needed. Using pip to install LinkChecker:\n\n``pip3 install linkchecker``\n\npipx can also be used to install LinkChecker.\n\nThe version in the pip repository may be old, to find out how to get the latest\ncode, plus platform-specific information and other advice see `doc/install.txt`_\nin the source code archive.\n\n.. _doc/install.txt: https://linkchecker.github.io/linkchecker/install.html\n\n\nUsage\n------\nExecute ``linkchecker https://www.example.com``.\nFor other options see ``linkchecker --help``, and for more information the\nmanual pages `linkchecker(1)`_ and `linkcheckerrc(5)`_.\n\n.. _linkchecker(1): https://linkchecker.github.io/linkchecker/man/linkchecker.html\n\n.. _linkcheckerrc(5): https://linkchecker.github.io/linkchecker/man/linkcheckerrc.html\n\nDocker usage\n-------------\n\nIf you do not want to install any additional libraries/dependencies you can use\nthe Docker image which is published on GitHub Packages.\n\nExample for external web site check::\n\n docker run --rm -it -u $(id -u):$(id -g) ghcr.io/linkchecker/linkchecker:latest --verbose https://www.example.com\n\nLocal HTML file check::\n\n docker run --rm -it -u $(id -u):$(id -g) -v \"$PWD\":/mnt ghcr.io/linkchecker/linkchecker:latest --verbose index.html\n\nIn addition to the rolling latest image, uniquely tagged images can also be found\non the `packages`_ page.\n\n.. _packages: https://github.com/linkchecker/linkchecker/pkgs/container/linkchecker\n",
"bugtrack_url": null,
"license": null,
"summary": "check links in web documents or full websites",
"version": "10.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/linkchecker/linkchecker/issues",
"Changelog": "https://github.com/linkchecker/linkchecker/blob/master/doc/changelog.txt",
"Homepage": "https://linkchecker.github.io/linkchecker/",
"Repository": "https://github.com/linkchecker/linkchecker"
},
"split_keywords": [
"checking",
" crawling",
" link",
" site",
" url",
" validation",
" verification"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d207ff8a29330fa35483a19221fd89e102e7ebf700acda8f0ba0b66ef14bcd48",
"md5": "55caa5d4c881556d00d20243ae8d6536",
"sha256": "5268587ed0b0f7e7521b75905128c96856f30f67dad49f66e2c963bc174ca92d"
},
"downloads": -1,
"filename": "LinkChecker-10.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55caa5d4c881556d00d20243ae8d6536",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 280937,
"upload_time": "2025-07-28T18:43:48",
"upload_time_iso_8601": "2025-07-28T18:43:48.932030Z",
"url": "https://files.pythonhosted.org/packages/d2/07/ff8a29330fa35483a19221fd89e102e7ebf700acda8f0ba0b66ef14bcd48/LinkChecker-10.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6e601ad47dd9db638546c4e70b49b5adfddfaadb2c6669a1a9b06a4dcf140d7b",
"md5": "d40ecbc729dc6c6f262d385ca0f29903",
"sha256": "fb7e8facda7749c2fa5fa5dc241c0adc302da3d31d588964a2570db501aa49e5"
},
"downloads": -1,
"filename": "LinkChecker-10.6.0.tar.gz",
"has_sig": false,
"md5_digest": "d40ecbc729dc6c6f262d385ca0f29903",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 547746,
"upload_time": "2025-07-28T18:43:50",
"upload_time_iso_8601": "2025-07-28T18:43:50.884917Z",
"url": "https://files.pythonhosted.org/packages/6e/60/1ad47dd9db638546c4e70b49b5adfddfaadb2c6669a1a9b06a4dcf140d7b/LinkChecker-10.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 18:43:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "linkchecker",
"github_project": "linkchecker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "beautifulsoup4",
"specs": [
[
">=",
"4.8.1"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.20"
]
]
},
{
"name": "dnspython",
"specs": [
[
">=",
"2.0"
]
]
},
{
"name": "argcomplete",
"specs": [
[
">=",
"1.8.1"
]
]
},
{
"name": "pdfminer.six",
"specs": [
[
">=",
"20181108"
]
]
}
],
"tox": true,
"lcname": "linkchecker"
}
JSON
