lycheeverse/lychee

これは何？

主な機能

• 01Markdown、HTML、CSS、XML、プレーンテキストのファイルに加え、ローカルファイルやWebサイト内のリンクをチェックします。
• 02オプションでメールアドレスや、URLのアンカー／テキストフラグメントもチェックします。
• 03同時実行数やホストごとのリクエスト制限、リトライを設定して非同期に実行します。
• 04結果をディスクにキャッシュし、繰り返し実行するときの処理を高速化します。
• 05正規表現パターンまたは.lycheeignoreファイルでリンクを除外します。
• 06簡易、詳細、JSON、JUnit、Markdown形式でレポートを出力します。

ユースケース

• 変更をマージする前に、ドキュメントリポジトリ内のリンク切れを検出する。
• GitHub ActionまたはDockerイメージを使って、CIパイプラインでリンクチェックを実行する。
• 既存のWebサイトを監査し、リンク切れの外部リンクを見つける。
• lychee-libクレートを使って、Rustアプリケーションにリンクチェックを組み込む。

クイックスタート

1. 1

   Homebrewでlycheeをインストール（macOS）

   brew install lychee
2. 2

   Cargoでlycheeをインストール（Rustが使えるすべてのプラットフォーム）

   cargo install lychee
3. 3

   公式Dockerイメージをプルする

   docker pull lycheeverse/lychee

収録されている特集

トピック

よくある質問

lychee とは？

MarkdownやHTML、Webサイト内のリンク切れやメールアドレスを検出する、高速なRust製非同期リンクチェッカー。 lycheeは、ローカルファイルやWebサイトをスキャンして、リンク切れや必要に応じてメールアドレスを検出するコマンドラインリンクチェッカーです。Markdown、HTML、CSS、XML、プレーンテキストに対応し、それ以外の形式では可能な範囲でURLを抽出します。PDFやDOCXなどの形式は、チェック前に前処理コマンドで変換できます。

lychee は無料で使えますか？ライセンスは？

lychee は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

lychee は今もメンテナンスされていますか？

活発にメンテナンス中。lychee の最終コミットは 2026年11月2日 です。

lychee は何に使えますか？

変更をマージする前に、ドキュメントリポジトリ内のリンク切れを検出する。 GitHub ActionまたはDockerイメージを使って、CIパイプラインでリンクチェックを実行する。 既存のWebサイトを監査し、リンク切れの外部リンクを見つける。 lychee-libクレートを使って、Rustアプリケーションにリンクチェックを組み込む。

lychee のインストール方法は？

Homebrewでlycheeをインストール（macOS）: brew install lychee Cargoでlycheeをインストール（Rustが使えるすべてのプラットフォーム）: cargo install lychee 公式Dockerイメージをプルする: docker pull lycheeverse/lychee

lychee はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/lycheeverse/lychee