lychee(1) General Commands Manual lychee(1) (NAME) lychee - (SYNOPSIS) lychee [-a|--accept] [--accept-timeouts] [--archive] [-b|--base-url] [--base] [--basic-auth] [-c|--config] [--cache] [--cache-exclude-status] [--cookie-jar] [--default-extension] [--dump] [--dump-inputs] [-E|--exclude-all-private] [--exclude] [--exclude-file] [--exclude-link-local] [--exclude-loopback] [--exclude-path] [--exclude-private] [--extensions] [-f|--format] [--fallback-extensions] [--files-from] [--generate] [--github-token] [--glob-ignore-case] [-h|--help] [-H|--header] [--hidden] [--host-concurrency] [--host-request-interval] [--host-stats] [-i|--insecure] [--include] [--include-fragments] [--include-mail] [--include-verbatim] [--include-wikilinks] [--index-files] [-m|--max-redirects] [--max-cache-age] [--max-concurrency] [--max-retries] [--min-tls] [--mode] [-n|--no-progress] [--no-ignore] [-o|--output] [--offline] [-p|--preprocess] [-q|--quiet]... [-r|--retry-wait-time] [--remap] [--require-https] [--root-dir] [-s|--scheme] [--skip-missing] [--suggest] [-t|--timeout] [-T|--threads] [-u|--user-agent] [-v|--verbose]... [-V|--version] [-X|--method] [inputs] (DESCRIPTION) lychee (asynchronous) . Markdown HTML . lychee lychee-lib (Rust) . (OPTIONS) -a, --accept (status codes) . : [start]..[[=]end]|code. : - 200 ( 200 ) - ..204 ( 204 ) - ..=204 ( 204 ) - 200..=204 ( 200 204 ) - 200..205 ( 200 205 205 200..=204) lychee --accept '200..=204, 429, 500' ... . 200 201 202 203 204 429 500 . [: 100..=103,200..=299] --accept-timeouts[=] (timeout) 0 ( ). --archive --suggest . [: wayback] : o wayback -b, --base-url (Base URL) . . https://example.com/dir/page a https://example.com/dir/a /b https://example.com/b . . () . . https://example.com/dir/page/ a https://example.com/dir/page/a . . URL ( /scheme) . URL data mailto . --base --base-url . --basic-auth (Basic Authentication). : http://example.com username:password -c, --config . . . [: lychee.toml] --cache[=] () .lycheecache . --cache-exclude-status () . : [start]..[[=]end]|code. : - 429 ( 429 ) - 500.. ( 500 ) - ..100 ( 100 ) - 500..=599 ( 500 599 ) - 500..600 ( 500 600 600 500..=599) lychee --cache-exclude-status '429, 500..502' ... . 429 500 501 . --cookie-jar . . . --default-extension . . . : --default-extension md --default-extension html --dump[=] . --dump-inputs[=] . -E, --exclude-all-private[=] IP . --exclude-private --exclude-link-local --exclude-loopback. --exclude URL . (regex) . --exclude-file --exclude-path . --exclude-link-local[=] IP (link-local) . --exclude-loopback[=] IP (loopback) localhost . --exclude-path . (regex) . --exclude-private[=] IP . --extensions . . . HTML .html .htm . : --extensions html,htm,php,asp,aspx,jsp,cgi. ( file1.html file2.md ...) . [: md,mkd,mdx,mdown,mdwn,mkdn,mkdown,markdown,html,htm,css,txt,xml] -f, --format . [: compact] : o compact o detailed o json o junit o markdown --fallback-extensions (fallback) . . . : --fallback-extensions html,htm,php,asp,aspx,jsp,cgi : file:// file:// ( --index-files) . --files-from ( '-' ). . : lychee --files-from list.txt find . -name '*.md' | lychee --files-from - echo 'README.md' | lychee --files-from - : - ( URL glob). - '#' . - . --generate ( /man) . : o man o complete-bash o complete-elvish o complete-fish o complete-powershell o complete-zsh --github-token API github.com (rate limiting). --glob-ignore-case[=] glob . -h, --help ( -h). -H, --header . . 'Name: Value' 'Accept: text/html'. curl wget . . . hosts . --hidden[=] . --host-concurrency (: 10). (rate limits) . hosts . : --host-concurrency 2 # API --host-concurrency 20 # API --host-request-interval (: 50ms). . ( ) . hosts . : --host-request-interval 50ms # API --host-request-interval 1s # API --host-stats[=] . -i, --insecure[=] ( TLS ). --include URL ( ). . --include-fragments[=] (fragments) . none anchor-only (anchor) #section text-only #:~:text=example full . anchor-only . --include-mail[=] . --include-verbatim[=] pre code. --include-wikilinks[=] (WikiLinks) Markdown --base-url . --index-files (index) . . . --index-files . . . ( ) . : `--index-files index.html,readme.md` index.html readme.md . : `--index-files index.html,.` index.html . : `--index-files ''` . . : file:// . -m, --max-redirects (redirects). [: 10] --max-cache-age () . [: 1d] --max-concurrency . [: 128] --max-retries . [: 3] --min-tls TLS. : o TLSv1_0 o TLSv1_1 o TLSv1_2 o TLSv1_3 --mode . . [: color] : o plain o color o emoji o task -n, --no-progress[=] . ( / CI) . --no-ignore[=] '.gitignore' '.ignore' (global ignore) . -o, --output . --offline[=] . -p, --preprocess . lychee COMMAND PATH . lychee . URL. (wrapper) . : #!/usr/bin/env bash case "$1" in *.pdf) exec pdftohtml -i -s -stdout "$1" ;; *.odt|*.docx|*.epub|*.ipynb) exec pandoc "$1" --to=html --wrap=none ;; *) # exec cat ;; esac -q, --quiet ( -q -qq). -r, --retry-wait-time ( ) . [: 1] --remap URI URI . --require-https[=] HTTPS HTTP . --root-dir . . ( / ). . /root/dir /page.html /root/dir/page.html . --base-url . URL : --base-url --root-dir . -s, --scheme (schemes) ( https) . . http https file mailto . --skip-missing[=] ( ). --suggest[=] . --archive . -t, --timeout . [: 20] -T, --threads (threads) . . -u, --user-agent (User Agent). [: lychee/x.y.z] -v, --verbose (verbosity) ( -v -vv). -V, --version . -X, --method (HTTP Request Method). [: get] [inputs] ( ). : ( README.md) ( '~/git/*/README.md') ( https://example.com/README.md) (-). --files-from . : -- . (EXAMPLES) : $ lychee . glob: $ lychee README.md test.html info.txt $ lychee 'public/**/*.html' '*.md' : $ lychee https://example.com (stdin): $ cat test.md | lychee - $ echo 'https://example.com' | lychee - : $ lychee --exclude '^https?://blog\.example\.com' --exclude '\.(pdf|zip|png|jpg)$' . https://lychee.cli.rs . (EXIT CODES) 0 . . 1 . 2 . . 3 . (REPORTING BUGS) https://github.com/lycheeverse/lychee/issues. : https://github.com/lycheeverse/lychee/discussions. (VERSION) v0.24.2 (AUTHORS) Matthias Endler Thomas Zahner . lychee 0.24.2 2026-05-01 lychee(1)