broken-link-checker [![NPM Version][npm-image]][npm-url] ![Build Status][ci-image] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency Monitor][greenkeeper-image]][greenkeeper-url]
Find broken links, missing images, etc within your HTML.
- ✅ Complete: Unicode, redirects, compression, basic authentication, absolute/relative/local URLs.
- ⚡️ Fast: Concurrent, streamed and cached.
- 🍰 Easy: Convenient defaults and very configurable.
Other features:
- Support for many HTML elements and attributes; not only
<a href> and <img src>.
- Support for relative URLs with
<base href>.
- WHATWG specifications-compliant HTML and URL parsing.
- Honor robot exclusions (robots.txt, headers and
rel), optionally.
- Detailed information for reporting and maintenance.
- URL keyword filtering with simple wildcards.
- Pause/Resume at any time.
Installation
Node.js >= 14 is required. There're two ways to use it:
Command Line Usage
To install, type this at the command line:
npm install broken-link-checker -g
After that, check out the help for available options:
blc --help
[npm-image]: https://img.shields.io/npm/v/broken-link-checker.svg
[npm-url]: https://npmjs.org/package/broken-link-checker
[ci-image]: https://img.shields.io/github/workflow/status/stevenvachon/broken-link-checker/tests
[coveralls-image]: https://img.shields.io/coveralls/stevenvachon/broken-link-checker.svg
[coveralls-url]: https://coveralls.io/github/stevenvachon/broken-link-checker
[greenkeeper-image]: https://badges.greenkeeper.io/stevenvachon/broken-link-checker.svg
[greenkeeper-url]: https://greenkeeper.io/