donghyeon.kang/llm-wiki
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
docs/ca-skeleton-frontend-runtime-adapter-features
llm-wiki/raw/official-docs/lychee-link-checker.md
T

8.0 KiB
Raw Permalink Blame History

title, source_type, url, archive_url, status, confidence, tags, related_projects, related_branches, created, last_reviewed
title source_type url archive_url status confidence tags related_projects related_branches created last_reviewed
lychee — Fast Async Link Checker (Project README) official-doc https://github.com/lycheeverse/lychee raw high
tooling
link-check
ci
markdown
runbook
feature-operational-runbook-contract
2026-05-27 2026-05-27

lychee — Fast Async Link Checker (Project README)

Layer: raw/official-docs/ — lycheeverse/lychee 프로젝트 README 원문 발췌. ca-tmpl operational runbook 의 link-check smoke validation 도구 선정 근거.

Parent / 활용 branch (필수)

Branch 이 자료가 정당화하는 결정
raw/branch-notes/feature-operational-runbook-contract D4 link-check smoke validation 도구로 lychee 채택 근거 — Markdown / HTML 링크 추출 + async / CI 통합 + GitHub Action 제공

컨텍스트

ca-tmpl feature-operational-runbook-contract 의 D4 는 runbook (docs/runbooks/*.md) 의 wikilink / 외부 링크 무결성을 CI 에서 검증한다는 결정. 본 source 는 그 검증 도구로 lychee 를 선택한 외부 근거 — Markdown / HTML / plaintext 지원, async, GitHub Action 제공, CI exit code 통신.

출처 / Source

왜 저장했는지 / Why archived

ca-tmpl runbook 의 link-check 도구 선택에서 lychee 가 (markdown / html 동시 지원 + async 성능 + GitHub Action 패키징 + 명확한 exit code) 4조건을 동시에 만족함을 공식 README 인용으로 보존. company tech blog 의 "lychee 가 좋다" 류 주장이 아닌 프로젝트 자체의 self-description (project README) 을 SSOT 로 보관.

핵심 인용 / Key quotes (verbatim)

[§Header/Tagline] "A fast, async, stream-based link checker written in Rust"

[§Header/Features] "Finds broken hyperlinks and mail addresses in websites and Markdown, HTML, and other file formats!"

[§Supported file formats] "lychee supports HTML and Markdown file formats. For any other file format, lychee falls back to a 'plain text' mode."

[§Features] "Available as command-line utility, library and GitHub Action"

[§Commandline usage] "lychee README.md test.html info.txt"

[§GitHub Action Usage] "A GitHub Action that uses lychee is available as a separate repository: lycheeverse/lychee-action"

[§Exit Codes] "0 Success. The operation was completed successfully as instructed. / 2 Link check failures. At least one non-excluded link failed the check."

Claims Extracted / 추출된 주장

Claim ID Claim (이 자료가 직접 말하는 것) Evidence quote Strength Applies to Does not prove
LYCHEE-C1 lychee 는 Rust 로 작성된 fast / async / stream-based link checker [§Header] "A fast, async, stream-based link checker written in Rust" official-vendor-doc lychee 의 모든 사용 컨텍스트 "fast" / "async" 의 정량적 성능 보장은 본 인용 범위 밖 (벤치마크 별도)
LYCHEE-C2 lychee 는 websites / Markdown / HTML 및 그 외 파일 포맷에서 broken hyperlink 와 mail address 를 검출 [§Features] "Finds broken hyperlinks and mail addresses in websites and Markdown, HTML, and other file formats!" official-vendor-doc Markdown / HTML / 기타 텍스트 자료의 링크 검증 "기타 파일 포맷" 의 정확한 목록은 본 인용에 없음 — C3 의 plain text fallback 이 보완
LYCHEE-C3 lychee 는 HTML / Markdown 을 1차 지원하고 그 외 포맷은 'plain text' 모드로 fallback [§Supported file formats] "lychee supports HTML and Markdown file formats. For any other file format, lychee falls back to a 'plain text' mode." official-vendor-doc 비표준 포맷 파일의 링크 추출 plain text 모드의 정확한 추출 알고리즘 (regex vs parser) 은 본 인용 범위 밖
LYCHEE-C4 lychee 는 command-line utility, library, GitHub Action 세 형태로 제공됨 [§Features] "Available as command-line utility, library and GitHub Action" official-vendor-doc CI 통합 + 로컬 사용 + 코드 임베딩 다른 CI 시스템 (GitLab CI, CircleCI) 의 first-class integration 은 본 인용 범위 밖 (CLI 로는 가능)
LYCHEE-C5 lychee CLI 는 여러 파일을 인자로 받아 일괄 검증 가능 (예: lychee README.md test.html info.txt) [§Commandline usage] "lychee README.md test.html info.txt" official-vendor-doc CLI 기본 사용 패턴 glob 패턴 / 디렉토리 재귀 동작은 본 인용 범위 밖 (다른 features 항목에서 별도)
LYCHEE-C6 GitHub Action 통합은 lycheeverse/lychee-action 별도 저장소로 제공 [§GitHub Action Usage] "A GitHub Action that uses lychee is available as a separate repository: lycheeverse/lychee-action" official-vendor-doc GitHub Actions 워크플로우에서 lychee 호출 lychee-action 의 input / output spec 은 별도 저장소 (lycheeverse/lychee-action) 의 README 로 확인 필요
LYCHEE-C7 lychee 의 exit code 는 명확히 정의됨 — 0 = success, 2 = link check failures (non-excluded 링크 중 1개 이상 실패) [§Exit Codes] "0 Success. The operation was completed successfully as instructed. / 2 Link check failures. At least one non-excluded link failed the check." official-vendor-doc CI 파이프라인의 fail/pass 판단 다른 exit code (1, 3, ...) 의 의미는 본 인용 범위 밖 (README 의 다른 항목 또는 lychee --help 참조)

Strength

모두 official-vendor-doc (lycheeverse project README — 프로젝트 self-description, 1st-party).

Usage Boundaries / 적용 경계

  • 이 자료가 직접 증명하는 것:
    • LYCHEE-C1 ~ C7: lychee 의 self-description (capability / 지원 포맷 / 배포 형태 / CLI usage / GitHub Action / exit code) 의 verbatim
  • 이 자료가 증명하지 않는 것:
    • lychee 가 "best" 또는 "공식 권장 도구" 라는 주장 — 본 README 는 self-description 일 뿐, 표준 / 비교 우위 주장 없음 (다른 link checker 와의 비교는 Features comparison table 별도)
    • 성능 수치 (req/sec, latency) — "fast" / "async" 는 정성 표현
    • lychee 가 wikilink (이중 대괄호(double-bracket)) 를 native 지원하는지 — 본 capture 에는 명시 없음 (Markdown 표준 링크만 명시) — 별도 확인 필요
    • 인증 (basic auth / token) 의 정확한 spec
  • 내 프로젝트 (ca-tmpl) 에 적용하려면 추가 확인이 필요한 것:
    • lychee 가 ca-tmpl 의 runbook 문서 형식 (Markdown + Obsidian wikilink) 을 어떻게 처리하는지 — wikilink 가 broken link 로 false-positive 처리될 가능성 (별도 PoC 또는 lychee --exclude 패턴 검토)
    • lycheeverse/lychee-action 의 정확한 step 작성법 — 본 source 는 "action 이 존재한다" 만 증명, "어떻게 쓰는지" 는 lychee-action 저장소 별도 fetch 필요

메모 / Notes

  • 본 fetch 는 GitHub web (1차) 와 raw README (2차) 두 번에 걸쳐 수행 — 1차는 features 목록이 일부만 노출, 2차는 exit code / 추가 features 까지 확보.
  • 다음 후보 fetch:
    • lycheeverse/lychee-action 의 README — GitHub Action input/output spec
    • lychee 의 --exclude / --config 옵션 spec — wikilink 처리 패턴 정의 시
  • 본 README 는 self-description 이므로 "공식 best practice" 주장 금지 — 도구 선택의 capability 근거로만 사용.

Related / 관련

Reference in New Issue View Git Blame Copy Permalink