Skip to content

Commit

Permalink
Fix typo in pre-commit config in README
Browse files Browse the repository at this point in the history
  • Loading branch information
f-hollow committed May 13, 2024
1 parent 0a54079 commit 43786b7
Showing 1 changed file with 39 additions and 17 deletions.
56 changes: 39 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,31 @@ Available as a command-line utility, a library and a [GitHub Action](https://git
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## 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)
Expand Down Expand Up @@ -288,7 +310,7 @@ Arguments:
Options:
-c, --config <CONFIG_FILE>
Configuration file to use
[default: lychee.toml]
-v, --verbose...
Expand All @@ -306,7 +328,7 @@ Options:
--max-cache-age <MAX_CACHE_AGE>
Discard all cached requests older than this duration
[default: 1d]
--dump
Expand All @@ -317,33 +339,33 @@ Options:
--archive <ARCHIVE>
Specify the use of a specific web archive. Can be used in combination with `--suggest`
[possible values: wayback]
--suggest
Suggest link replacements for broken links, using a web archive. The web archive can be specified with `--archive`
-m, --max-redirects <MAX_REDIRECTS>
Maximum number of allowed redirects
[default: 5]
--max-retries <MAX_RETRIES>
Maximum number of retries per request
[default: 3]
--max-concurrency <MAX_CONCURRENCY>
Maximum number of concurrent network requests
[default: 128]
-T, --threads <THREADS>
Number of threads to utilize. Defaults to number of cores available to the system
-u, --user-agent <USER_AGENT>
User agent
[default: lychee/x.y.z]
-i, --insecure
Expand Down Expand Up @@ -394,38 +416,38 @@ Options:
-a, --accept <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' <inputs>..." 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
Enable the checking of fragments in links
-t, --timeout <TIMEOUT>
Website timeout in seconds from connect to response finished
[default: 20]
-r, --retry-wait-time <RETRY_WAIT_TIME>
Minimum wait time in seconds between retries of failed requests
[default: 1]
-X, --method <METHOD>
Request method
[default: get]
-b, --base <BASE>
Expand All @@ -436,7 +458,7 @@ Options:
--github-token <GITHUB_TOKEN>
GitHub API token to use when checking github.com links, to avoid rate limiting
[env: GITHUB_TOKEN]
--skip-missing
Expand All @@ -453,7 +475,7 @@ Options:
-f, --format <FORMAT>
Output format of final status report (compact, detailed, json, markdown)
[default: compact]
--require-https
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 43786b7

Please sign in to comment.