lychee

Identify and report broken links in Markdown, HTML, YAML, and text files.

1|Updated Apr 3, 2026
One-click install
npx skills add https://github.com/nq-rdl/agent-extensions --skill lychee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lychee
Source: https://github.com/nq-rdl/agent-extensions/tree/main/skills/lychee
Command: npx skills add https://github.com/nq-rdl/agent-extensions --skill lychee

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Identify and report broken or dead links across documentation, READMEs, and text files to improve content reliability and user trust.

Core Features & Use Cases

  • Async, fast link checking across Markdown, HTML, YAML, and other text formats
  • Configurable exclusions, fragment checks, and reporting formats for CI and audits
  • Use Case: run checks before publishing docs or during code reviews to catch dead links early

Quick Start

Run the wrapper to check links in your project and report broken URLs.

Frequently Asked Questions about lychee

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check for broken links in Markdown and HTML documentation?

To check for broken links in Markdown and HTML documentation, this Skill validates link health across text assets using async checking, configurable exclusions, and fragment checks. It reports dead URLs to improve content reliability.

Can I run link checks in CI to catch dead links before publishing docs?

Yes, you can run link checks in CI to catch dead links before publishing docs. This Skill validates link health during code reviews and documentation audits, reporting broken URLs across Markdown, HTML, and YAML formats.

What file formats are supported for documentation link validation?

Documentation link validation supports Markdown, HTML, YAML, and other text file formats. The Skill identifies and reports broken or dead links across these assets to help maintain content quality and user trust.

Do I need to install the Lychee binary to validate links in READMEs?

Yes, you need the Lychee binary on PATH to validate links in READMEs. The Skill uses a wrapper script plus a bundled configuration file to enforce defaults like caching, fragment checks, exclusions, and concurrency.

Why are my documentation links failing quality checks during audits?

Documentation links fail quality checks during audits when they point to broken or dead URLs. This Skill identifies these invalid references across your text files and reports them so you can fix issues before publishing.

What's the best way to configure exclusions and fragment checks for link checking?

The best way to configure exclusions and fragment checks for link checking is through the bundled configuration file. This Skill enforces default settings for caching, concurrency, and reporting formats to validate link health effectively.