CLI, Node.js API, CI 통합 기능을 통해 웹사이트, 문서, 로컬 파일의 링크를 크롤링하는 깨진 링크 검사기입니다.
lycheeverse/lychee
Markdown, HTML, 웹사이트 등에서 깨진 URL과 이메일 주소를 찾아내는 Rust 기반 고속 비동기 링크 검사기입니다.
- 스타
- 4,096
- 포크
- 245
- 열린 이슈
- 75
- 마지막 커밋
- 3일 전
어떤 프로젝트인가요?
lychee는 로컬 파일과 웹사이트를 검사해 깨진 하이퍼링크와, 선택적으로 이메일 주소를 찾아내는 명령줄 링크 검사기입니다. Markdown, HTML, CSS, XML, 일반 텍스트를 지원하며, 그 외 형식에서도 가능한 범위에서 URL을 추출합니다. PDF나 DOCX 같은 형식은 사전 처리 명령으로 변환한 뒤 검사할 수 있습니다.
검사는 비동기 스트리밍 방식으로 실행되며, 동시성 설정, 호스트별 요청 제한, 백오프를 적용한 재시도, 디스크 캐싱을 지원합니다. 정규식이나 .lycheeignore 파일로 링크를 제외하고, 상태 코드를 필터링하거나 사용자 지정 헤더 또는 GitHub 토큰을 전달할 수 있습니다. JSON, JUnit, Markdown 등 원하는 출력 형식도 선택할 수 있습니다.
CLI 외에도 lychee는 Rust 라이브러리(lychee-lib)와 GitHub Action으로 제공되며, 다양한 운영체제용 패키지와 Docker 이미지로도 배포됩니다.
핵심 기능
- 01Markdown, HTML, CSS, XML, 일반 텍스트 파일과 로컬 파일 및 웹사이트의 링크를 검사합니다.
- 02선택적으로 이메일 주소와 URL의 앵커 또는 텍스트 프래그먼트도 검사합니다.
- 03설정 가능한 동시성, 호스트별 요청 제한, 재시도를 지원하는 비동기 방식으로 실행됩니다.
- 04반복 실행을 빠르게 할 수 있도록 결과를 디스크에 캐싱합니다.
- 05정규식 패턴이나 .lycheeignore 파일을 사용해 링크를 제외합니다.
- 06간결한 형식, 상세 형식, JSON, JUnit, Markdown으로 보고서를 출력합니다.
활용 사례
- 변경 사항을 병합하기 전에 문서 저장소의 깨진 링크를 찾아냅니다.
- GitHub Action이나 Docker 이미지를 사용해 CI 파이프라인에서 링크 검사를 실행합니다.
- 기존 웹사이트의 외부 링크 중 더 이상 작동하지 않는 링크를 점검합니다.
- lychee-lib 크레이트를 통해 Rust 애플리케이션에 링크 검사를 통합합니다.
빠른 시작
- 1
Homebrew로 lychee 설치(macOS)
brew install lychee - 2
Cargo로 lychee 설치(Rust를 사용할 수 있는 모든 플랫폼)
cargo install lychee - 3
공식 Docker 이미지 가져오기
docker pull lycheeverse/lychee
포함된 컬렉션
토픽
자주 묻는 질문
- lychee은(는) 무엇인가요?
- Markdown, HTML, 웹사이트 등에서 깨진 URL과 이메일 주소를 찾아내는 Rust 기반 고속 비동기 링크 검사기입니다. lychee는 로컬 파일과 웹사이트를 검사해 깨진 하이퍼링크와, 선택적으로 이메일 주소를 찾아내는 명령줄 링크 검사기입니다. Markdown, HTML, CSS, XML, 일반 텍스트를 지원하며, 그 외 형식에서도 가능한 범위에서 URL을 추출합니다. PDF나 DOCX 같은 형식은 사전 처리 명령으로 변환한 뒤 검사할 수 있습니다.
- lychee은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
- lychee은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
- lychee은(는) 아직 유지보수되고 있나요?
- 활발히 유지보수 중. lychee의 마지막 커밋은 2026년 11월 2일입니다.
- lychee은(는) 어디에 사용할 수 있나요?
- 변경 사항을 병합하기 전에 문서 저장소의 깨진 링크를 찾아냅니다. GitHub Action이나 Docker 이미지를 사용해 CI 파이프라인에서 링크 검사를 실행합니다. 기존 웹사이트의 외부 링크 중 더 이상 작동하지 않는 링크를 점검합니다. 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
요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.
관련 프로젝트
GFM 스타일로 Markdown을 포맷하고, 명령어로 코드 스니펫을 자동 생성하며, 링크를 확인하고, Markdown에서 정적 문서 웹사이트를 빌드하는 Go CLI입니다.
오프라인에서 실행되며 편집기, CI, 코드에서 팀의 글쓰기 스타일 규칙을 적용하는 CLI 문장 검사 도구입니다.
Rust로 작성된 Python 도구로, 코드베이스의 모듈 의존성과 공개 인터페이스를 시각화하고 규칙을 적용합니다.