Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-03-16 20:50:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
⚡ Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!
140 commits 1 branch 0 tags 5.1 MiB
Rust 98.6%
Dockerfile 0.7%
Nix 0.3%
Makefile 0.3%
Shell 0.1%
Find a file
Paweł Romanowski e197012e7a
Update troubleshooting guide, add .editorconfig (#60)
2020-12-02 23:07:52 +01:00
.github/workflows Use more descriptive name for cargo test action 2020-10-16 14:47:54 +02:00
assets Use different icons for feature comparison (#32) 2020-11-09 11:46:45 +01:00
fixtures Make GITHUB_TOKEN optional (#22) 2020-10-26 23:31:31 +01:00
src Make README.md the default when no inputs are given 2020-11-25 10:40:36 +01:00
tests Use builder pattern and channels (fixes #12) (#33) 2020-11-24 21:30:06 +01:00
.editorconfig Update troubleshooting guide, add .editorconfig (#60) 2020-12-02 23:07:52 +01:00
.gitignore Extract from hello-rust/show repository 2020-08-05 00:32:37 +02:00
Cargo.lock Bump structopt from 0.3.20 to 0.3.21 (#57) 2020-12-01 11:08:51 +01:00
Cargo.toml Bump check-if-email-exists from 0.8.13 to 0.8.15 (#49) 2020-11-30 15:44:01 +01:00
lychee.example.toml Add support for include patterns (#23) 2020-10-25 13:41:06 +01:00
README.md Update troubleshooting guide, add .editorconfig (#60) 2020-12-02 23:07:52 +01:00
TROUBLESHOOTING.md Update troubleshooting guide, add .editorconfig (#60) 2020-12-02 23:07:52 +01:00

README.md

lychee

Rust

A fast, async, resource-friendly link checker written in Rust.
For GitHub links, it can optionally use a GITHUB_TOKEN to avoid getting blocked by the rate limiter.

Lychee demo

Features

This comparison is made on a best-effort basis. Please create a PR to fix outdated information.

lychee awesome_bot muffet broken-link-checker linkinator linkchecker markdown-link-check fink
Language Rust Ruby Go JS TypeScript Python JS PHP
Async/Parallel yes yes yes yes yes yes yes yes
Static binary yes no yes no no ️ no no no
Markdown files yes yes no no no no ️ yes no
HTML files yes no no yes yes no no no
Text files yes no no no no no no no
Website support yes no yes yes yes yes no yes
Chunked encodings yes maybe maybe maybe maybe no yes yes
GZIP compression yes maybe maybe yes maybe yes maybe no
Basic Auth yes no no yes no yes no no
Custom user agent yes no no yes no yes no no
Relative URLs yes yes no yes yes yes yes yes
Skip relative URLs yes no no maybe no no no no
Include patterns yes️ yes no yes no no no no
Exclude patterns yes no yes yes yes yes yes yes
Handle redirects yes yes yes yes yes yes yes yes
Ignore insecure SSL yes yes yes no no yes no yes
File globbing yes yes no no yes no yes no
Limit scheme yes no no yes no yes no no
Custom headers yes no yes no no no yes yes
Summary yes yes yes maybe yes yes no yes
HEAD requests yes yes no yes yes yes no no
Colored output yes maybe yes maybe yes yes no yes
Filter status code yes yes no no no no yes no
Custom timeout yes yes yes no yes yes no yes
E-mail links yes no no no no yes no no
Progress bar yes yes no no no yes yes yes
Retry and backoff yes no no no yes no yes no
Skip private domains yes no no no no no no no
Use as lib no yes no yes yes no yes no
Quiet mode yes no no no yes yes yes yes
Amazing lychee logo yes no no no no no no no
Config file yes no no no yes yes yes no

Contributing to lychee

We'd be thankful for any contribution.
We try keep the issue-tracker up-to-date so you can quickly find a task to work on.

Try one of these links to get started:

Installation

cargo install lychee

Usage

Run it inside a repository with a README.md, or specify a file with

lychee <yourfile>

Optional (to avoid getting rate-limited): set an environment variable with your Github token like so GITHUB_TOKEN=xxxx, or use the --github-token CLI option. It can also be set in the config file.

CLI exit codes

  • 0 for success (all links checked successfully or excluded/skipped as configured)
  • 1 for any unexpected runtime failures or config errors
  • 2 for link check failures (if any non-excluded link failed the check)

Troubleshooting and workarounds

We collect a list of common workarounds for various websites in our troubleshooting guide.

Users

Credits

The first prototype of lychee was built in episode 10 of Hello Rust. Thanks to all Github- and Patreon sponsors for supporting the development since the beginning. Also, thanks to all the great contributors who have since made this project more mature.