{"id":13456985,"url":"https://github.com/lycheeverse/lychee","last_synced_at":"2026-03-14T11:10:46.055Z","repository":{"id":37031481,"uuid":"285115432","full_name":"lycheeverse/lychee","owner":"lycheeverse","description":"⚡ Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!","archived":false,"fork":false,"pushed_at":"2026-01-25T21:45:44.000Z","size":6108,"stargazers_count":3281,"open_issues_count":103,"forks_count":190,"subscribers_count":14,"default_branch":"master","last_synced_at":"2026-01-26T02:21:51.245Z","etag":null,"topics":["broken-links","check","link","link-checker","link-checkers","link-checking","validator"],"latest_commit_sha":null,"homepage":"https://lychee.cli.rs","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lycheeverse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"open_collective":"lychee-collective","github":"mre"}},"created_at":"2020-08-04T22:31:45.000Z","updated_at":"2026-01-25T21:21:31.000Z","dependencies_parsed_at":"2023-12-29T05:33:44.467Z","dependency_job_id":"3fe3752e-e2c4-42f5-aa1d-d9018c8e71c9","html_url":"https://github.com/lycheeverse/lychee","commit_stats":{"total_commits":1420,"total_committers":82,"mean_commits":"17.317073170731707","dds":0.5669014084507042,"last_synced_commit":"c0be8c551bc88b9dea71377c6ed2a25f3db29900"},"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"purl":"pkg:github/lycheeverse/lychee","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lycheeverse%2Flychee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lycheeverse%2Flychee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lycheeverse%2Flychee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lycheeverse%2Flychee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lycheeverse","download_url":"https://codeload.github.com/lycheeverse/lychee/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lycheeverse%2Flychee/sbom","scorecard":{"id":607028,"data":{"date":"2025-08-11","repo":{"name":"github.com/lycheeverse/lychee","commit":"5476d9570392cf554b93106953e248ca30ee26e7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.1,"checks":[{"name":"Maintained","score":10,"reason":"30 commit(s) and 25 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":8,"reason":"Found 15/18 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/nightly.yml:18","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-binary.yml:102","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-binary.yml:149","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-binary.yml:38","Warn: no topLevel permission defined: .github/workflows/auto-merge.yml:1","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/debug-build.yml:1","Warn: no topLevel permission defined: .github/workflows/docker.yml:1","Warn: no topLevel permission defined: .github/workflows/links.yml:1","Warn: no topLevel permission defined: .github/workflows/nightly.yml:1","Warn: no topLevel permission defined: .github/workflows/release-binary.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release-plz.yml:8","Warn: no topLevel permission defined: .github/workflows/snap.yml:1","Warn: no topLevel permission defined: .github/workflows/update-toc.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE-APACHE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE-APACHE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-merge.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/auto-merge.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-merge.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/auto-merge.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:64: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:97: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:111: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/debug-build.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/debug-build.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/debug-build.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/debug-build.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/debug-build.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/debug-build.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/debug-build.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/debug-build.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/debug-build.yml:108: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/debug-build.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/debug-build.yml:113: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/debug-build.yml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/debug-build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docker.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yml:117: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/docker.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/links.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/links.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/links.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/links.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/links.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/links.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/nightly.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:108: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:111: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:138: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:162: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:164: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-binary.yml:167: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-binary.yml:174: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-binary.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-plz.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-plz.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-plz.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-plz.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-plz.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/release-plz.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snap.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/snap.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/snap.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/snap.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/snap.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/snap.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-toc.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/update-toc.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-toc.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/lycheeverse/lychee/update-toc.yml/master?enable=pin","Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:4","Warn: containerImage not pinned by hash: Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile:26: pin your Docker image by updating debian:bookworm-slim to debian:bookworm-slim@sha256:b1a741487078b369e78119849663d7f1a5341ef2768798f7b7406c4240f86aef","Warn: containerImage not pinned by hash: Dockerfile-CI.Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile-CI.Dockerfile:24: pin your Docker image by updating debian:bookworm-slim to debian:bookworm-slim@sha256:b1a741487078b369e78119849663d7f1a5341ef2768798f7b7406c4240f86aef","Warn: containerImage not pinned by hash: Dockerfile-CI.alpine.Dockerfile:1","Warn: containerImage not pinned by hash: Dockerfile-CI.alpine.Dockerfile:19: pin your Docker image by updating alpine:latest to alpine:latest@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1","Info:   0 out of  25 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  44 third-party GitHubAction dependencies pinned","Info:   0 out of   7 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/docker.yml:20"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":3,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'master'","Info: 'force pushes' disabled on branch 'master'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'master'","Warn: could not determine whether codeowners review is allowed","Warn: no status checks found to merge onto branch 'master'","Warn: PRs are not required to make changes on branch 'master'; or we don't have data to detect it.If you think it might be the latter, make sure to run Scorecard with a PAT or use Repo Rules (that are always public) instead of Branch Protection settings"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact nightly not signed: https://api.github.com/repos/lycheeverse/lychee/releases/240181299","Warn: release artifact lychee-v0.19.1 not signed: https://api.github.com/repos/lycheeverse/lychee/releases/225539810","Warn: release artifact lychee-lib-v0.19.1 not signed: https://api.github.com/repos/lycheeverse/lychee/releases/225539441","Warn: release artifact lychee-v0.19.0 not signed: https://api.github.com/repos/lycheeverse/lychee/releases/224622406","Warn: release artifact lychee-lib-v0.19.0 not signed: https://api.github.com/repos/lycheeverse/lychee/releases/224621717","Warn: release artifact nightly does not have provenance: https://api.github.com/repos/lycheeverse/lychee/releases/240181299","Warn: release artifact lychee-v0.19.1 does not have provenance: https://api.github.com/repos/lycheeverse/lychee/releases/225539810","Warn: release artifact lychee-lib-v0.19.1 does not have provenance: https://api.github.com/repos/lycheeverse/lychee/releases/225539441","Warn: release artifact lychee-v0.19.0 does not have provenance: https://api.github.com/repos/lycheeverse/lychee/releases/224622406","Warn: release artifact lychee-lib-v0.19.0 does not have provenance: https://api.github.com/repos/lycheeverse/lychee/releases/224621717"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":8,"reason":"2 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: RUSTSEC-2024-0388","Warn: Project is vulnerable to: RUSTSEC-2024-0421 / GHSA-h97m-ww89-6jmq"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T01:50:18.567Z","repository_id":37031481,"created_at":"2025-08-21T01:50:18.567Z","updated_at":"2025-08-21T01:50:18.567Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28844407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T10:53:21.605Z","status":"ssl_error","status_checked_at":"2026-01-28T10:53:20.789Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["broken-links","check","link","link-checker","link-checkers","link-checking","validator"],"created_at":"2024-07-31T08:01:31.349Z","updated_at":"2026-03-14T11:10:46.038Z","avatar_url":"https://github.com/lycheeverse.png","language":"Rust","readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ca name=\"back-to-top\"\u003e\u003c/a\u003e\n![lychee](assets/logo.svg)\n\n[![Homepage](https://img.shields.io/badge/Homepage-Online-EA3A97)](https://lychee.cli.rs/)\n[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-lychee-blue.svg?colorA=24292e\u0026colorB=0366d6\u0026style=flat\u0026longCache=true\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/lychee-broken-link-checker)\n[![Rust](https://github.com/lycheeverse/lychee/workflows/CI/badge.svg)](https://github.com/lycheeverse/lychee/actions/workflows/ci.yml)\n[![docs.rs](https://img.shields.io/docsrs/lychee-lib/latest)](https://docs.rs/lychee-lib/latest/lychee_lib/)\n[![Check Links](https://github.com/lycheeverse/lychee/actions/workflows/links.yml/badge.svg)](https://github.com/lycheeverse/lychee/actions/workflows/links.yml)\n[![Docker Pulls](https://img.shields.io/docker/pulls/lycheeverse/lychee?color=%23099cec\u0026logo=Docker)](https://hub.docker.com/r/lycheeverse/lychee)\n\n⚡ A fast, async, stream-based link checker written in Rust ⚡\\\nFinds broken hyperlinks and mail addresses in websites\nand Markdown, HTML, and other file formats!\\\nAvailable as command-line utility,\n[library](https://docs.rs/lychee-lib/latest/lychee_lib/) and\n[GitHub Action](https://github.com/lycheeverse/lychee-action).\n\n\u003c/div\u003e\n\n![Lychee demo](./assets/screencast.svg)\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n## Table of Contents\n\n- [Development](#development)\n- [Installation](#installation)\n- [Features](#features)\n- [Commandline usage](#commandline-usage)\n- [Supported file formats](#supported-file-formats)\n- [Library usage](#library-usage)\n- [GitHub Action Usage](#github-action-usage)\n- [Pre-commit Usage](#pre-commit-usage)\n- [Contributing to lychee](#contributing-to-lychee)\n- [Troubleshooting and Workarounds](#troubleshooting-and-workarounds)\n- [Users](#users)\n- [Credits](#credits)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Development\n\nAfter [installing Rust](https://rust-lang.org/tools/install/) use [Cargo](https://doc.rust-lang.org/cargo/) for building and testing.\nFor Nix we provide a flake so you can use `nix develop` and `nix build`.\n\n## Installation\n\n\u003cdetails\u003e\u003csummary\u003e\u003cb\u003eView installation instructions\u003c/b\u003e\u003c/summary\u003e\n\n### Arch Linux\n\n```sh\npacman -S lychee\n```\n\n### OpenSUSE Tumbleweed\n\n```sh\nzypper in lychee\n```\n\n### Ubuntu\n\n```sh\nsnap install lychee\n```\n\n### Alpine Linux\n\n```sh\n # available for Alpine Edge in testing repositories\napk add lychee\n```\n\n### macOS\n\nVia [Homebrew](https://brew.sh):\n\n```sh\nbrew install lychee\n```\n\nVia [MacPorts](https://www.macports.org):\n\n```sh\nsudo port install lychee\n```\n\n### Docker\n\n```sh\ndocker pull lycheeverse/lychee\n```\n\n### Nix\n\n```sh\nnix-shell -p lychee\n```\n\nOr let Nix even check a packaged site with [`testers.lycheeLinkCheck`](https://nixos.org/manual/nixpkgs/stable/#tester-lycheeLinkCheck) `{ site = …; }`\n\n### FreeBSD\n\n```sh\npkg install lychee\n```\n\n### Termux\n\n```sh\npkg install lychee\n```\n\n### Conda\n\n```sh\nconda install lychee -c conda-forge\n```\n\n### Windows\n\nVia [scoop](https://scoop.sh/):\n\n```sh\nscoop install lychee\n```\n\nVia [WinGet](https://github.com/microsoft/winget-cli):\n\n```sh\nwinget install --id lycheeverse.lychee\n```\n\nVia [Chocolatey](https://chocolatey.org/):\n\n```sh\nchoco install lychee\n```\n\n\u003c/details\u003e\n\n### Pre-built binaries\n\nWe provide binaries for Linux, macOS, and Windows for every release. \\\nYou can download them from the [releases page](https://github.com/lycheeverse/lychee/releases).\n\n### Cargo\n\n#### Build dependencies\n\nOn APT/dpkg-based Linux distros (e.g. Debian, Ubuntu, Linux Mint and Kali Linux)\nthe following commands will install all required build dependencies, including\nthe Rust toolchain and `cargo`:\n\n```sh\ncurl -sSf 'https://sh.rustup.rs' | sh\napt install gcc pkg-config libc6-dev libssl-dev\n```\n\n#### Compile and install lychee\n\n```sh\ncargo install lychee\n```\n\n#### Feature flags\n\nLychee supports the following feature flags:\n\n- `email-check` enables checking email addresses using the [mailify-lib](https://crates.io/crates/mailify-lib) crate.\n- `check_example_domains` allows checking example domains such as `example.com`. This feature is useful for testing.\n\nBy default, `email-check` is enabled.\nNote that in the past lychee could be configured to use either OpenSSL or Rustls.\n[It was decided](https://github.com/lycheeverse/lychee/pull/1928)\nto fully switch to Rustls and drop OpenSSL support.\nPlease tell us if this this negatively affects you in any way.\n\n## Features\n\nThis comparison is made on a best-effort basis. Please create a PR to fix\noutdated information.\n\n|                      | lychee  | [awesome_bot] | [muffet] | [broken-link-checker] | [linkinator] | [linkchecker]        | [markdown-link-check] | [fink] |\n| -------------------- | ------- | ------------- | -------- | --------------------- | ------------ | -------------------- | --------------------- | ------ |\n| Language             | Rust    | Ruby          | Go       | JS                    | TypeScript   | Python               | JS                    | PHP    |\n| Async/Parallel       | ![yes]  | ![yes]        | ![yes]   | ![yes]                | ![yes]       | ![yes]               | ![yes]                | ![yes] |\n| JSON output          | ![yes]  | ![no]         | ![yes]   | ![yes]                | ![yes]       | ![maybe]\u003csup\u003e1\u003c/sup\u003e | ![yes]                | ![yes] |\n| Static binary        | ![yes]  | ![no]         | ![yes]   | ![no]                 | ![no]        | ️![no]               | ![no]                 | ![no]  |\n| Markdown files       | ![yes]  | ![yes]        | ![no]    | ![no]                 | ![no]        | ![yes]               | ![yes]                | ![no]  |\n| HTML files           | ![yes]  | ![no]         | ![no]    | ![yes]                | ![yes]       | ![no]                | ![yes]                | ![no]  |\n| Text files           | ![yes]  | ![no]         | ![no]    | ![no]                 | ![no]        | ![no]                | ![no]                 | ![no]  |\n| Website support      | ![yes]  | ![no]         | ![yes]   | ![yes]                | ![yes]       | ![yes]               | ![no]                 | ![yes] |\n| Chunked encodings    | ![yes]  | ![maybe]      | ![maybe] | ![maybe]              | ![maybe]     | ![no]                | ![yes]                | ![yes] |\n| GZIP compression     | ![yes]  | ![maybe]      | ![maybe] | ![yes]                | ![maybe]     | ![yes]               | ![maybe]              | ![no]  |\n| Basic Auth           | ![yes]  | ![no]         | ![no]    | ![yes]                | ![no]        | ![yes]               | ![no]                 | ![no]  |\n| Custom user agent    | ![yes]  | ![no]         | ![no]    | ![yes]                | ![no]        | ![yes]               | ![no]                 | ![no]  |\n| Relative URLs        | ![yes]  | ![yes]        | ![no]    | ![yes]                | ![yes]       | ![yes]               | ![yes]                | ![yes] |\n| Anchors/Fragments    | ![yes]  | ![no]         | ![no]    | ![no]                 | ![no]        | ![yes]               | ![yes]                | ![no]  |\n| Include patterns     | ![yes]️  | ![yes]        | ![no]    | ![yes]                | ![no]        | ![no]                | ![no]                 | ![no]  |\n| Exclude patterns     | ![yes]  | ![no]         | ![yes]   | ![yes]                | ![yes]       | ![yes]               | ![yes]                | ![yes] |\n| Handle redirects     | ![yes]  | ![yes]        | ![yes]   | ![yes]                | ![yes]       | ![yes]               | ![yes]                | ![yes] |\n| Ignore insecure SSL  | ![yes]  | ![yes]        | ![yes]   | ![no]                 | ![no]        | ![yes]               | ![no]                 | ![yes] |\n| File globbing        | ![yes]  | ![yes]        | ![no]    | ![no]                 | ![yes]       | ![no]                | ![yes]                | ![no]  |\n| Limit scheme         | ![yes]  | ![no]         | ![no]    | ![yes]                | ![no]        | ![yes]               | ![no]                 | ![no]  |\n| [Custom headers]     | ![yes]  | ![no]         | ![yes]   | ![no]                 | ![no]        | ![no]                | ![yes]                | ![yes] |\n| Summary              | ![yes]  | ![yes]        | ![yes]   | ![maybe]              | ![yes]       | ![yes]               | ![no]                 | ![yes] |\n| `HEAD` requests      | ![yes]  | ![yes]        | ![no]    | ![yes]                | ![yes]       | ![yes]               | ![no]                 | ![no]  |\n| Colored output       | ![yes]  | ![maybe]      | ![yes]   | ![maybe]              | ![yes]       | ![yes]               | ![no]                 | ![yes] |\n| [Filter status code] | ![yes]  | ![yes]        | ![no]    | ![no]                 | ![no]        | ![no]                | ![yes]                | ![no]  |\n| Custom timeout       | ![yes]  | ![yes]        | ![yes]   | ![no]                 | ![yes]       | ![yes]               | ![no]                 | ![yes] |\n| E-mail links         | ![yes]  | ![no]         | ![no]    | ![no]                 | ![no]        | ![yes]               | ![no]                 | ![no]  |\n| Progress bar         | ![yes]  | ![yes]        | ![no]    | ![no]                 | ![no]        | ![yes]               | ![yes]                | ![yes] |\n| Retry and backoff    | ![yes]  | ![no]         | ![no]    | ![no]                 | ![yes]       | ![no]                | ![yes]                | ![no]  |\n| Per-host throttling  | ![yes]  | ![no]         | ![yes]   | ![yes]                | ![no]        | ![yes]               | ![no]                 | ![no]  |\n| Respect rate limits  | ![yes]  | ![no]         | ![no]    | ![no]                 | ![no]        | ![no]                | ![no]                 | ![no]  |\n| Skip private domains | ![yes]  | ![no]         | ![no]    | ![no]                 | ![no]        | ![no]                | ![no]                 | ![no]  |\n| [Use as library]     | ![yes]  | ![yes]        | ![no]    | ![yes]                | ![yes]       | ![no]                | ![yes]                | ![no]  |\n| Quiet mode           | ![yes]  | ![no]         | ![no]    | ![no]                 | ![yes]       | ![yes]               | ![yes]                | ![yes] |\n| [Config file]        | ![yes]  | ![no]         | ![no]    | ![no]                 | ![yes]       | ![yes]               | ![yes]                | ![no]  |\n| Cookies              | ![yes]  | ![no]         | ![yes]   | ![no]                 | ![no]        | ![yes]               | ![no]                 | ![yes] |\n| Recursion            | ![no]   | ![no]         | ![yes]   | ![yes]                | ![yes]       | ![yes]               | ![yes]                | ![no]  |\n| Amazing lychee logo  | ![yes]  | ![no]         | ![no]    | ![no]                 | ![no]        | ![no]                | ![no]                 | ![no]  |\n\n[awesome_bot]: https://github.com/dkhamsing/awesome_bot\n[muffet]: https://github.com/raviqqe/muffet\n[broken-link-checker]: https://github.com/stevenvachon/broken-link-checker\n[linkinator]: https://github.com/JustinBeckwith/linkinator\n[linkchecker]: https://github.com/linkchecker/linkchecker\n[markdown-link-check]: https://github.com/tcort/markdown-link-check\n[fink]: https://github.com/dantleech/fink\n[yes]: ./assets/yes.svg\n[no]: ./assets/no.svg\n[maybe]: ./assets/maybe.svg\n[custom headers]: https://github.com/rust-lang/crates.io/issues/788\n[filter status code]: https://github.com/tcort/markdown-link-check/issues/94\n[skip private domains]: https://github.com/appscodelabs/liche/blob/a5102b0bf90203b467a4f3b4597d22cd83d94f99/url_checker.go\n[use as library]: https://github.com/raviqqe/liche/issues/13\n[config file]: https://github.com/lycheeverse/lychee/blob/master/lychee.example.toml\n\n\u003csup\u003e1\u003c/sup\u003e Other machine-readable formats like CSV are supported.\n\n## Commandline usage\n\n```sh\n# recursively check all links in supported files inside the current directory\nlychee .\n\n# check links in specific local file(s):\nlychee README.md test.html info.txt\n\n# check links on a website:\nlychee https://endler.dev\n```\n\nFor more examples check out our\n[usage guide](https://lychee.cli.rs/guides/getting-started/#usage).\n\n\u003cdetails\u003e\u003csummary\u003e\u003cb\u003eDocker Usage\u003c/b\u003e\u003c/summary\u003e\n\nHere's how to mount a local directory into the container and check some input\nwith lychee.\n\n- The `--init` parameter is passed so that lychee can be stopped from the terminal.\n- We also pass `-it` to start an interactive terminal, which is required to show the progress bar.\n- The `--rm` removes not used anymore container from the host after the run (self-cleanup).\n- The `-w /input` points to `/input` as the default workspace\n- The `-v $(pwd):/input` does local volume mounting to the container for lychee access.\n\n\u003e By default a Debian-based Docker image is used. If you want to run an Alpine-based image, use the `latest-alpine` tag.\n\u003e For example, `lycheeverse/lychee:latest-alpine`\n\n#### Linux/macOS shell command\n\n```sh\ndocker run --init -it --rm -w /input -v $(pwd):/input lycheeverse/lychee README.md\n```\n\n#### Windows PowerShell command\n\n```powershell\ndocker run --init -it --rm -w /input -v ${PWD}:/input lycheeverse/lychee README.md\n```\n\n\u003c/details\u003e\n\n### GitHub Token\n\nTo avoid getting rate-limited while checking GitHub links, you can optionally\nset an environment variable with your GitHub token like so `GITHUB_TOKEN=xxxx`,\nor use the `--github-token` CLI option. It can also be set in the config file.\n[Here is an example config file][config file].\n\nThe token can be generated on your [GitHub account settings page](https://github.com/settings/tokens).\nA personal access token with no extra permissions is enough to be able to check public repo links.\n\nFor more scalable organization-wide scenarios you can consider a [GitHub App][github-app-overview].\nIt has a higher rate limit than personal access tokens but requires additional configuration steps on your GitHub workflow.\nPlease follow the [GitHub App Setup][github-app-setup] example.\n\n[github-app-overview]: https://docs.github.com/en/apps/overview\n[github-app-setup]: https://github.com/github/combine-prs/blob/main/docs/github-app-setup.md#github-app-setup\n\n### Commandline Parameters\n\nUse `lychee --help` or `man lychee` to see all available command line parameters.\n\n\u003cdetails\u003e\u003csummary\u003e\u003cb\u003eView full help message\u003c/b\u003e\u003c/summary\u003e\n\n```help-message\nlychee is a fast, asynchronous link checker which detects broken URLs and mail addresses in local files and websites. It supports Markdown and HTML and works with other file formats.\n\nlychee is powered by lychee-lib, the Rust library for link checking.\n\nUsage: lychee [OPTIONS] [inputs]...\n\nArguments:\n  [inputs]...\n          Inputs for link checking (where to get links to check from).\n          These can be: files (e.g. `README.md`), file globs (e.g. `'~/git/*/README.md'`),\n          remote URLs (e.g. `https://example.com/README.md`), or standard input (`-`).\n          Alternatively, use `--files-from` to read inputs from a file.\n\n          NOTE: Use `--` to separate inputs from options that allow multiple arguments.\n\nOptions:\n  -a, --accept \u003cACCEPT\u003e\n          A List of accepted status codes for valid links\n\n          The following accept range syntax is supported: [start]..[[=]end]|code.\n          Some valid examples are:\n\n          - 200 (accepts the 200 status code only)\n          - ..204 (accepts any status code \u003c 204)\n          - ..=204 (accepts any status code \u003c= 204)\n          - 200..=204 (accepts any status code from 200 to 204 inclusive)\n          - 200..205 (accepts any status code from 200 to 205 excluding 205, same as 200..=204)\n\n          Use \"lychee --accept '200..=204, 429, 500' \u003cinputs\u003e...\" to provide a comma-\n          separated list of accepted status codes. This example will accept 200, 201,\n          202, 203, 204, 429, and 500 as valid status codes.\n\n          [default: 100..=103,200..=299]\n\n      --accept-timeouts\n          Accept timed out requests and return exit code 0 when encountering timeouts but not any other errors\n\n      --archive \u003cARCHIVE\u003e\n          Web archive to use to provide suggestions for `--suggest`.\n\n          [default: wayback]\n\n          [possible values: wayback]\n\n  -b, --base-url \u003cBASE_URL\u003e\n          Base URL to use when resolving relative URLs in local files. If specified,\n          relative links in local files are interpreted as being relative to the given\n          base URL.\n\n          For example, given a base URL of `https://example.com/dir/page`, the link `a`\n          would resolve to `https://example.com/dir/a` and the link `/b` would resolve\n          to `https://example.com/b`. This behavior is not affected by the filesystem\n          path of the file containing these links.\n\n          Note that relative URLs without a leading slash become siblings of the base\n          URL. If, instead, the base URL ended in a slash, the link would become a child\n          of the base URL. For example, a base URL of `https://example.com/dir/page/` and\n          a link of `a` would resolve to `https://example.com/dir/page/a`.\n\n          Basically, the base URL option resolves links as if the local files were hosted\n          at the given base URL address.\n\n          The provided base URL value must either be a URL (with scheme) or an absolute path.\n          Note that certain URL schemes cannot be used as a base, e.g., `data` and `mailto`.\n\n      --base \u003cBASE\u003e\n          Deprecated; use `--base-url` instead\n\n      --basic-auth \u003cBASIC_AUTH\u003e\n          Basic authentication support. E.g. `http://example.com username:password`\n\n  -c, --config \u003cFILE_PATH\u003e\n          Configuration file to use. Can be specified multiple times.\n\n          If given multiple times, the configs are merged and later\n          occurrences take precedence over previous occurrences.\n\n          [default: lychee.toml]\n\n      --cache\n          Use request cache stored on disk at `.lycheecache`\n\n      --cache-exclude-status \u003cCACHE_EXCLUDE_STATUS\u003e\n          A list of status codes that will be ignored from the cache\n\n          The following exclude range syntax is supported: [start]..[[=]end]|code. Some valid\n          examples are:\n\n          - 429 (excludes the 429 status code only)\n          - 500.. (excludes any status code \u003e= 500)\n          - ..100 (excludes any status code \u003c 100)\n          - 500..=599 (excludes any status code from 500 to 599 inclusive)\n          - 500..600 (excludes any status code from 500 to 600 excluding 600, same as 500..=599)\n\n          Use \"lychee --cache-exclude-status '429, 500..502' \u003cinputs\u003e...\" to provide a\n          comma-separated list of excluded status codes. This example will not cache results\n          with a status code of 429, 500 and 501.\n\n      --cookie-jar \u003cCOOKIE_JAR\u003e\n          Read and write cookies using the given file. Cookies will be stored in the\n          cookie jar and sent with requests. New cookies will be stored in the cookie jar\n          and existing cookies will be updated.\n\n      --default-extension \u003cEXTENSION\u003e\n          This is the default file extension that is applied to files without an extension.\n\n          This is useful for files without extensions or with unknown extensions.\n          The extension will be used to determine the file type for processing.\n\n          Examples:\n            --default-extension md\n            --default-extension html\n\n      --dump\n          Don't perform any link checking. Instead, dump all the links extracted from inputs that would be checked\n\n      --dump-inputs\n          Don't perform any link extraction and checking. Instead, dump all input sources from which links would be collected\n\n  -E, --exclude-all-private\n          Exclude all private IPs from checking.\n          Equivalent to `--exclude-private --exclude-link-local --exclude-loopback`\n\n      --exclude \u003cEXCLUDE\u003e\n          Exclude URLs and mail addresses from checking. The values are treated as regular expressions\n\n      --exclude-file \u003cEXCLUDE_FILE\u003e\n          Deprecated; use `--exclude-path` instead\n\n      --exclude-link-local\n          Exclude link-local IP address range from checking\n\n      --exclude-loopback\n          Exclude loopback IP address range and localhost from checking\n\n      --exclude-path \u003cEXCLUDE_PATH\u003e\n          Exclude paths from getting checked. The values are treated as regular expressions\n\n      --exclude-private\n          Exclude private IP address ranges from checking\n\n      --extensions \u003cEXTENSIONS\u003e\n          A list of file extensions. Files not matching the specified extensions are skipped.\n\n          Multiple extensions can be separated by commas. Note that if you want to check filetypes,\n          which have multiple extensions, e.g. HTML files with both .html and .htm extensions, you need to\n          specify both extensions explicitly.\n          An example is: `--extensions html,htm,php,asp,aspx,jsp,cgi`.\n\n          This is useful when the default extensions are not enough and you don't\n          want to provide a long list of inputs (e.g. file1.html, file2.md, etc.)\n\n          [default: md,mkd,mdx,mdown,mdwn,mkdn,mkdown,markdown,html,htm,css,txt,xml]\n\n  -f, --format \u003cFORMAT\u003e\n          Output format of final status report\n\n          [default: compact]\n\n          [possible values: compact, detailed, json, junit, markdown]\n\n      --fallback-extensions \u003cFALLBACK_EXTENSIONS\u003e\n          When checking locally, attempts to locate missing files by trying the given\n          fallback extensions. Multiple extensions can be separated by commas. Extensions\n          will be checked in order of appearance.\n\n          Example: --fallback-extensions html,htm,php,asp,aspx,jsp,cgi\n\n          Note: This option takes effect on `file://` URIs which do not exist and on\n                `file://` URIs pointing to directories which resolve to themself (by the\n                --index-files logic).\n\n      --files-from \u003cPATH\u003e\n          Read input filenames from the given file or stdin (if path is '-').\n\n          This is useful when you have a large number of inputs that would be\n          cumbersome to specify on the command line directly.\n\n          Examples:\n\n              lychee --files-from list.txt\n              find . -name '*.md' | lychee --files-from -\n              echo 'README.md' | lychee --files-from -\n\n          File Format:\n          - Each line should contain one input (file path, URL, or glob pattern).\n          - Lines starting with '#' are treated as comments and ignored.\n          - Empty lines are also ignored.\n\n      --generate \u003cGENERATE\u003e\n          Generate special output (e.g. the man page) instead of performing link checking\n\n          [possible values: man, complete-bash, complete-elvish, complete-fish, complete-powershell, complete-zsh]\n\n      --github-token \u003cGITHUB_TOKEN\u003e\n          GitHub API token to use when checking github.com links, to avoid rate limiting\n\n          [env: GITHUB_TOKEN]\n\n      --glob-ignore-case\n          Ignore case when expanding filesystem path glob inputs\n\n  -h, --help\n          Print help (see a summary with '-h')\n\n  -H, --header \u003cHEADER:VALUE\u003e\n          Set custom header for requests.\n\n          Some websites require custom headers to be passed in order to return valid responses.\n          You can specify custom headers in the format 'Name: Value'. For example, 'Accept: text/html'.\n          This is the same format that other tools like curl or wget use.\n          Multiple headers can be specified by using the flag multiple times.\n          The specified headers are used for ALL requests.\n          Use the `hosts` option to configure headers on a per-host basis.\n\n      --hidden\n          Do not skip hidden directories and files\n\n      --host-concurrency \u003cHOST_CONCURRENCY\u003e\n          Default maximum concurrent requests per host (default: 10)\n\n          This limits the maximum amount of requests that are sent simultaneously\n          to the same host. This helps to prevent overwhelming servers and\n          running into rate-limits. Use the `hosts` option to configure this\n          on a per-host basis.\n\n          Examples:\n            --host-concurrency 2   # Conservative for slow APIs\n            --host-concurrency 20  # Aggressive for fast APIs\n\n      --host-request-interval \u003cHOST_REQUEST_INTERVAL\u003e\n          Minimum interval between requests to the same host (default: 50ms)\n\n          Sets a baseline delay between consecutive requests to prevent\n          overloading servers. The adaptive algorithm may increase this based\n          on server responses (rate limits, errors). Use the `hosts` option\n          to configure this on a per-host basis.\n\n          Examples:\n            --host-request-interval 50ms   # Fast for robust APIs\n            --host-request-interval 1s     # Conservative for rate-limited APIs\n\n      --host-stats\n          Show per-host statistics at the end of the run\n\n  -i, --insecure\n          Proceed for server connections considered insecure (invalid TLS)\n\n      --include \u003cINCLUDE\u003e\n          URLs to check (supports regex). Has preference over all excludes\n\n      --include-fragments\n          Enable the checking of fragments in links\n\n      --include-mail\n          Also check email addresses\n\n      --include-verbatim\n          Find links in verbatim sections like `pre`- and `code` blocks\n\n      --include-wikilinks\n          Check WikiLinks in Markdown files, this requires specifying --base-url\n\n      --index-files \u003cINDEX_FILES\u003e\n          When checking locally, resolves directory links to a separate index file.\n          The argument is a comma-separated list of index file names to search for. Index\n          names are relative to the link's directory and attempted in the order given.\n\n          If `--index-files` is specified, then at least one index file must exist in\n          order for a directory link to be considered valid. Additionally, the special\n          name `.` can be used in the list to refer to the directory itself.\n\n          If unspecified (the default behavior), index files are disabled and directory\n          links are considered valid as long as the directory exists on disk.\n\n          Example 1: `--index-files index.html,readme.md` looks for index.html or readme.md\n                     and requires that at least one exists.\n\n          Example 2: `--index-files index.html,.` will use index.html if it exists, but\n                     still accept the directory link regardless.\n\n          Example 3: `--index-files ''` will reject all directory links because there are\n                     no valid index files. This will require every link to explicitly name\n                     a file.\n\n          Note: This option only takes effect on `file://` URIs which exist and point to a directory.\n\n  -m, --max-redirects \u003cMAX_REDIRECTS\u003e\n          Maximum number of allowed redirects\n\n          [default: 10]\n\n      --max-cache-age \u003cMAX_CACHE_AGE\u003e\n          Discard all cached requests older than this duration\n\n          [default: 1d]\n\n      --max-concurrency \u003cMAX_CONCURRENCY\u003e\n          Maximum number of concurrent network requests\n\n          [default: 128]\n\n      --max-retries \u003cMAX_RETRIES\u003e\n          Maximum number of retries per request\n\n          [default: 3]\n\n      --min-tls \u003cMIN_TLS\u003e\n          Minimum accepted TLS Version\n\n          [possible values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3]\n\n      --mode \u003cMODE\u003e\n          Set the output display mode. Determines how results are presented in the terminal\n\n          [default: color]\n\n          [possible values: plain, color, emoji, task]\n\n  -n, --no-progress\n          Do not show progress bar.\n          This is recommended for non-interactive shells (e.g. for continuous integration)\n\n      --no-ignore\n          Do not skip files that would otherwise be ignored by '.gitignore', '.ignore', or the global ignore file\n\n  -o, --output \u003cOUTPUT\u003e\n          Output file of status report\n\n      --offline\n          Only check local files and block network requests\n\n  -p, --preprocess \u003cCOMMAND\u003e\n          Preprocess input files with the given command.\n\n          For each file input, this flag causes lychee to execute `COMMAND PATH` and process\n          its standard output instead of the original contents of PATH. This allows you to\n          convert files that would otherwise not be understood by lychee. The preprocessor\n          COMMAND is only run on input files, not on standard input or URLs.\n\n          To invoke programs with custom arguments or to use multiple preprocessors, use a\n          wrapper program such as a shell script. An example script looks like this:\n\n          ```\n          #!/usr/bin/env bash\n          case \"$1\" in\n          *.pdf)\n              exec pdftohtml -i -s -stdout \"$1\"\n              ;;\n          *.odt|*.docx|*.epub|*.ipynb)\n              exec pandoc \"$1\" --to=html --wrap=none\n              ;;\n          *)\n              # identity function, output input without changes\n              exec cat\n              ;;\n          esac\n          ```\n\n  -q, --quiet...\n          Less output per occurrence (e.g. `-q` or `-qq`)\n\n  -r, --retry-wait-time \u003cRETRY_WAIT_TIME\u003e\n          Minimum wait time in seconds between retries of failed requests\n\n          [default: 1]\n\n      --remap \u003cREMAP\u003e\n          Remap URI matching pattern to different URI\n\n      --require-https\n          When HTTPS is available, treat HTTP links as errors\n\n      --root-dir \u003cROOT_DIR\u003e\n          Root directory to use when checking absolute links in local files. This option is\n          required if absolute links appear in local files, otherwise those links will be\n          flagged as errors. This must be an absolute path (i.e., one beginning with `/`).\n\n          If specified, absolute links in local files are resolved by prefixing the given\n          root directory to the requested absolute link. For example, with a root-dir of\n          `/root/dir`, a link to `/page.html` would be resolved to `/root/dir/page.html`.\n\n          This option can be specified alongside `--base-url`. If both are given, an\n          absolute link is resolved by constructing a URL from three parts: the domain\n          name specified in `--base-url`, followed by the `--root-dir` directory path,\n          followed by the absolute link's own path.\n\n  -s, --scheme \u003cSCHEME\u003e\n          Only test links with the given schemes (e.g. https).\n          Omit to check links with any other scheme.\n          At the moment, we support http, https, file, and mailto.\n\n      --skip-missing\n          Skip missing input files (default is to error if they don't exist)\n\n      --suggest\n          Suggest link replacements for broken links, using a web archive. The web archive can be specified with `--archive`\n\n  -t, --timeout \u003cTIMEOUT\u003e\n          Website timeout in seconds from connect to response finished\n\n          [default: 20]\n\n  -T, --threads \u003cTHREADS\u003e\n          Number of threads to utilize. Defaults to number of cores available to the system\n\n  -u, --user-agent \u003cUSER_AGENT\u003e\n          User agent\n\n          [default: lychee/x.y.z]\n\n  -v, --verbose...\n          Set verbosity level; more output per occurrence (e.g. `-v` or `-vv`)\n\n  -V, --version\n          Print version\n\n  -X, --method \u003cMETHOD\u003e\n          Request method\n\n          [default: get]\n```\n\n\u003c/details\u003e\n\n### Exit codes\n\n0   Success. The operation was completed successfully as instructed.\n\n1   Missing inputs or any unexpected runtime failures or configuration errors\n\n2   Link check failures. At least one non-excluded link failed the check.\n\n3   Encountered errors in the config file.\n\n### Ignoring and excluding links\n\nYou can exclude links from getting checked by specifying regex patterns\nwith `--exclude` (e.g. `--exclude example\\.(com|org)`) or by putting\nthem into a file called `.lycheeignore`.\nTo exclude files and directories from being scanned use `--exclude-path`.\nFor more detailed explanations, check out our comprehensive\n[guide on excluding links](https://lychee.cli.rs/recipes/excluding-links/).\n\n### Caching\n\nIf the `--cache` flag is set, lychee will cache responses in a file called\n`.lycheecache` in the current directory. If the file exists and the flag is set,\nthen the cache will be loaded on startup. This can greatly speed up future runs.\nNote that by default lychee will not store any data on disk.\nThis is explained in more detail in [our documentation](https://lychee.cli.rs/recipes/caching/).\n\n## Supported file formats\n\nlychee supports HTML and Markdown file formats.\nFor any other file format, lychee falls back to a \"plain text\" mode.\nThis means that [linkify](https://github.com/robinst/linkify)\nattempts to extract URLs on a best-effort basis.\n\nFor non-plaintext files (pdf, epub, docx, etc.) or for files\nwhich don't work well with the fallback extraction method (csv, ipynb, etc.)\nyou can make use of the `--preprocess` option.\n\nTake a look at [lychee-all](https://github.com/lycheeverse/lychee-all) for more information.\n\n## Library usage\n\nYou can use lychee as a library for your own projects!\nTake a look at the [library documentation](https://docs.rs/lychee-lib/latest/lychee_lib/).\nAlso check out the [examples](examples) directory for small practical examples.\nThese examples can be run with `cargo run --example \u003cexample\u003e`.\n\n## GitHub Action Usage\n\nA GitHub Action that uses lychee is available as a separate repository: [lycheeverse/lychee-action](https://github.com/lycheeverse/lychee-action)\nwhich includes usage instructions.\n\n## Pre-commit Usage\n\nLychee can also be used as a [pre-commit](https://pre-commit.com/) hook.\n\n```yaml\n# .pre-commit-config.yaml\nrepos:\n  - repo: https://github.com/lycheeverse/lychee.git\n    rev: v0.15.1\n    hooks:\n      - id: lychee\n        # Optionally include additional CLI arguments\n        args: [\"--no-progress\", \"--exclude\", \"file://\"]\n```\n\nRather than running on staged-files only, Lychee can be run against an entire repository.\n\n```yaml\n- id: lychee\n  args: [\"--no-progress\", \".\"]\n  pass_filenames: false\n```\n\n## Contributing to lychee\n\nWe'd be thankful for any contribution. \\\nWe try to keep the issue tracker up-to-date so you can quickly find a task to work on.\n\nTry one of these links to get started:\n\n- [good first issues](https://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)\n- [help wanted](https://github.com/lycheeverse/lychee/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)\n\nFor more detailed instructions, head over to [`CONTRIBUTING.md`](/CONTRIBUTING.md).\n\n## Troubleshooting and Workarounds\n\nWe collect a list of common workarounds for various websites in our [troubleshooting guide](./docs/TROUBLESHOOTING.md).\n\n## Users\n\n\u003cdetails\u003e\u003csummary\u003e\u003cb\u003eHere is a list of some notable projects who are using lychee.\u003c/b\u003e\u003c/summary\u003e\n\n- https://github.com/InnerSourceCommons/InnerSourcePatterns\n- https://github.com/opensearch-project/OpenSearch\n- https://github.com/ramitsurana/awesome-kubernetes\n- https://github.com/papers-we-love/papers-we-love\n- https://github.com/pingcap/docs\n- https://github.com/microsoft/WhatTheHack\n- https://github.com/nix-community/awesome-nix\n- https://github.com/balena-io/docs\n- https://github.com/launchdarkly/LaunchDarkly-Docs\n- https://github.com/pawroman/links\n- https://github.com/analysis-tools-dev/static-analysis\n- https://github.com/analysis-tools-dev/dynamic-analysis\n- https://github.com/mre/idiomatic-rust\n- https://github.com/bencherdev/bencher\n- https://github.com/sindresorhus/execa\n- https://github.com/tldr-pages/tldr-maintenance\n- https://github.com/git-ecosystem/git-credential-manager\n- https://github.com/git/git-scm.com\n- https://github.com/OWASP/threat-dragon\n- https://github.com/oxc-project/oxc\n- https://github.com/hugsy/gef\n- https://github.com/mermaid-js/mermaid\n- https://github.com/hashicorp/consul\n- https://github.com/Unleash/unleash\n- https://github.com/fastify/fastify\n- https://github.com/nuxt/nuxt\n- https://github.com/containerd/containerd\n- https://github.com/rolldown/rolldown\n- https://github.com/rerun-io/rerun\n- https://github.com/0xAX/asm\n- https://github.com/mainmatter/100-exercises-to-learn-rust\n- https://github.com/GoogleCloudPlatform/generative-ai\n- https://github.com/DioxusLabs/dioxus\n- https://github.com/ministryofjustice/modernisation-platform\n- https://github.com/orhun/binsider\n- https://github.com/NVIDIA/aistore\n- https://github.com/gradle/gradle\n- https://github.com/duobaseio/forui\n- https://github.com/FreeBSD-Ask/FreeBSD-Ask\n- https://github.com/prosekit/prosekit\n- https://github.com/tldr-pages/tldr\n- https://gitlab.torproject.org/tpo/web/marble/support\n- https://github.com/lycheeverse/lychee (yes, lychee is checked with lychee 🤯)\n\nIf you are using lychee for your project, **please add it here**.\n\n\u003c/details\u003e\n\n## Credits\n\nThe first prototype of lychee was built in [episode 10 of Hello\nRust](https://hello-rust.github.io/10/). Thanks to all GitHub and Patreon sponsors\nfor supporting the development since the beginning. Also, thanks to all the\ngreat contributors who have since made this project more mature.\n\n## License\n\nlychee is licensed under either of\n\n- Apache License, Version 2.0, ([LICENSE-APACHE](https://github.com/lycheeverse/lychee/blob/master/LICENSE-APACHE) or\n  https://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](https://github.com/lycheeverse/lychee/blob/master/LICENSE-MIT) or https://opensource.org/license/MIT)\n\nat your option.\n\n\u003cbr\u003e\u003chr\u003e\n[🔼 Back to top](#back-to-top)\n","funding_links":["https://opencollective.com/lychee-collective","https://github.com/sponsors/mre"],"categories":["Rust","Command Line Tools","Quality Assurance","others","Tools","Uncategorized","\u003ca name=\"webdev\"\u003e\u003c/a\u003eWeb development","General Tools","Other"],"sub_categories":["Uncategorized","Checker \u0026 Formatter"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flycheeverse%2Flychee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flycheeverse%2Flychee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flycheeverse%2Flychee/lists"}