diff --git a/README.md b/README.md index 5c2e3c057b..483167925b 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,31 @@ Available as a command-line utility, a library and a [GitHub Action](https://git ## Table of Contents +- [Table of Contents](#table-of-contents) - [Installation](#installation) + - [Arch Linux](#arch-linux) + - [macOS](#macos) + - [Docker](#docker) + - [NixOS](#nixos) + - [FreeBSD](#freebsd) + - [Scoop](#scoop) + - [Termux](#termux) + - [Alpine Linux](#alpine-linux) + - [Pre-built binaries](#pre-built-binaries) + - [Cargo](#cargo) + - [Build dependencies](#build-dependencies) + - [Compile and install lychee](#compile-and-install-lychee) + - [Feature flags](#feature-flags) - [Features](#features) - [Commandline usage](#commandline-usage) + - [Docker Usage](#docker-usage) + - [Linux/macOS shell command](#linuxmacos-shell-command) + - [Windows PowerShell command](#windows-powershell-command) + - [GitHub Token](#github-token) + - [Commandline Parameters](#commandline-parameters) + - [Exit codes](#exit-codes) + - [Ignoring links](#ignoring-links) + - [Caching](#caching) - [Library usage](#library-usage) - [GitHub Action Usage](#github-action-usage) - [Pre-commit Usage](#pre-commit-usage) @@ -288,7 +310,7 @@ Arguments: Options: -c, --config Configuration file to use - + [default: lychee.toml] -v, --verbose... @@ -306,7 +328,7 @@ Options: --max-cache-age Discard all cached requests older than this duration - + [default: 1d] --dump @@ -317,7 +339,7 @@ Options: --archive Specify the use of a specific web archive. Can be used in combination with `--suggest` - + [possible values: wayback] --suggest @@ -325,17 +347,17 @@ Options: -m, --max-redirects Maximum number of allowed redirects - + [default: 5] --max-retries Maximum number of retries per request - + [default: 3] --max-concurrency Maximum number of concurrent network requests - + [default: 128] -T, --threads @@ -343,7 +365,7 @@ Options: -u, --user-agent User agent - + [default: lychee/x.y.z] -i, --insecure @@ -394,20 +416,20 @@ Options: -a, --accept A List of accepted status codes for valid links - + The following accept range syntax is supported: [start]..[=]end|code. Some valid examples are: - + - 200..=204 - 200..204 - ..=204 - ..204 - 200 - + Use "lychee --accept '200..=204, 429, 500' ..." to provide a comma- separated list of accepted status codes. This example will accept 200, 201, 202, 203, 204, 429, and 500 as valid status codes. - + [default: 100..=103,200..=299] --include-fragments @@ -415,17 +437,17 @@ Options: -t, --timeout Website timeout in seconds from connect to response finished - + [default: 20] -r, --retry-wait-time Minimum wait time in seconds between retries of failed requests - + [default: 1] -X, --method Request method - + [default: get] -b, --base @@ -436,7 +458,7 @@ Options: --github-token GitHub API token to use when checking github.com links, to avoid rate limiting - + [env: GITHUB_TOKEN] --skip-missing @@ -453,7 +475,7 @@ Options: -f, --format Output format of final status report (compact, detailed, json, markdown) - + [default: compact] --require-https @@ -566,7 +588,7 @@ Lychee can also be used as a [pre-commit](https://pre-commit.com/) hook. # .pre-commit-config.yaml repos: - repo: https://github.com/lycheeverse/lychee.git - rev: 0.15.1 + rev: v0.15.1 hooks: - id: lychee # Optionally include additional CLI arguments