Repolode
Enviar
lycheeverse

lycheeverse/lychee

Verificador de links rápido e assíncrono, escrito em Rust, que encontra URLs e endereços de e-mail inválidos em Markdown, HTML e sites.

Ver no GitHubSite
Estrelas
4,096
Forks
245
Issues abertas
75
Último commit
há 4 dias

O que é?

lychee é um verificador de links de linha de comando que analisa arquivos locais e sites em busca de hyperlinks inválidos e, opcionalmente, endereços de e-mail. Dá suporte a Markdown, HTML, CSS, XML e texto simples, e tenta extrair URLs da melhor forma possível em outros formatos. Comandos de pré-processamento podem converter formatos como PDF ou DOCX antes da verificação.

As verificações são executadas de forma assíncrona e em fluxo, com concorrência configurável, limitação de requisições por host, novas tentativas com espera progressiva e cache de requisições em disco. É possível excluir links usando regex ou um arquivo .lycheeignore, filtrar códigos de status, informar cabeçalhos personalizados ou um token do GitHub e escolher formatos de saída como JSON, JUnit e Markdown.

Além da CLI, lychee está disponível como biblioteca Rust (lychee-lib) e como GitHub Action, além de ser empacotado para diversos sistemas operacionais e distribuído como imagem Docker.

Recursos principais

  • 01Verifica links em arquivos Markdown, HTML, CSS, XML e texto simples, além de arquivos locais e sites.
  • 02Verifica, opcionalmente, endereços de e-mail e fragmentos de âncora ou texto em URLs.
  • 03Executa as verificações de forma assíncrona, com concorrência configurável, limitação de requisições por host e novas tentativas.
  • 04Armazena os resultados em cache no disco para acelerar execuções repetidas.
  • 05Exclui links com padrões regex ou usando um arquivo .lycheeignore.
  • 06Gera relatórios em formato compacto, detalhado, JSON, JUnit ou Markdown.

Casos de uso

  • Encontrar links inválidos em repositórios de documentação antes de mesclar alterações.
  • Executar verificações de links em pipelines de CI usando a GitHub Action ou a imagem Docker.
  • Auditar um site existente em busca de links externos indisponíveis.
  • Incorporar a verificação de links em um aplicativo Rust usando o crate lychee-lib.

Início rápido

  1. 1

    Instale o lychee com Homebrew (macOS)

    brew install lychee
  2. 2

    Instale o lychee com Cargo (qualquer plataforma com Rust)

    cargo install lychee
  3. 3

    Baixe a imagem oficial do Docker

    docker pull lycheeverse/lychee

Em coleções

Ferramentas de CLI e terminalGeradores de sites estáticos e ferramentas de documentação

Tópicos

#link-checker#rust#broken-links#markdown#html#cli#ci#check#link#link-checkers

Perguntas frequentes

O que é lychee?
Verificador de links rápido e assíncrono, escrito em Rust, que encontra URLs e endereços de e-mail inválidos em Markdown, HTML e sites. lychee é um verificador de links de linha de comando que analisa arquivos locais e sites em busca de hyperlinks inválidos e, opcionalmente, endereços de e-mail. Dá suporte a Markdown, HTML, CSS, XML e texto simples, e tenta extrair URLs da melhor forma possível em outros formatos. Comandos de pré-processamento podem converter formatos como PDF ou DOCX antes da verificação.
lychee é gratuito? Qual é a licença?
lychee é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
lychee ainda é mantido?
Manutenção ativa. O último commit de lychee foi em 2 de nov. de 2026.
Para que posso usar lychee?
Encontrar links inválidos em repositórios de documentação antes de mesclar alterações. Executar verificações de links em pipelines de CI usando a GitHub Action ou a imagem Docker. Auditar um site existente em busca de links externos indisponíveis. Incorporar a verificação de links em um aplicativo Rust usando o crate lychee-lib.
Como instalar lychee?
Instale o lychee com Homebrew (macOS): brew install lychee Instale o lychee com Cargo (qualquer plataforma com Rust): cargo install lychee Baixe a imagem oficial do Docker: docker pull lycheeverse/lychee
Onde consigo lychee?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/lycheeverse/lychee

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados