@@ -23,7 +23,7 @@ Arguments:
2323Options:
2424 -c, --config < CONFIG_FILE>
2525 Configuration file to use
26-
26+
2727 [default: lychee.toml]
2828
2929 -v, --verbose...
@@ -41,9 +41,25 @@ Options:
4141
4242 --max-cache-age < MAX_CACHE_AGE>
4343 Discard all cached requests older than this duration
44-
44+
4545 [default: 1d]
4646
47+ --cache-exclude-status < CACHE_EXCLUDE_STATUS>
48+ A list of status codes that will be ignored from the cache
49+
50+ The following accept range syntax is supported: [start]..[= ]end| code. Some valid
51+ examples are:
52+
53+ - 429
54+ - 500..=599
55+ - 500..
56+
57+ Use " lychee --cache-exclude-status '429, 500..502' <inputs>..." to provide a comma- separated
58+ list of excluded status codes. This example will not cache results with a status code of 429, 500,
59+ 501 and 502.
60+
61+ [default: ]
62+
4763 --dump
4864 Don' t perform any link checking. Instead, dump all the links extracted from inputs that would be checked
4965
@@ -52,34 +68,34 @@ Options:
5268
5369 --archive < ARCHIVE>
5470 Specify the use of a specific web archive. Can be used in combination with ` --suggest`
55-
71+
5672 [possible values: wayback]
5773
5874 --suggest
5975 Suggest link replacements for broken links, using a web archive. The web archive can be specified with ` --archive`
6076
6177 -m, --max-redirects < MAX_REDIRECTS>
6278 Maximum number of allowed redirects
63-
79+
6480 [default: 5]
6581
6682 --max-retries < MAX_RETRIES>
6783 Maximum number of retries per request
68-
84+
6985 [default: 3]
7086
7187 --max-concurrency < MAX_CONCURRENCY>
7288 Maximum number of concurrent network requests
73-
89+
7490 [default: 128]
7591
7692 -T, --threads < THREADS>
7793 Number of threads to utilize. Defaults to number of cores available to the system
7894
7995 -u, --user-agent < USER_AGENT>
8096 User agent
81-
82- [default: lychee/0.14.2 ]
97+
98+ [default: lychee/0.18.0 ]
8399
84100 -i, --insecure
85101 Proceed for server connections considered insecure (invalid TLS)
@@ -128,62 +144,71 @@ Options:
128144 Test the specified file extensions for URIs when checking files locally.
129145 Multiple extensions can be separated by commas. Extensions will be checked in
130146 order of appearance.
131-
147+
132148 Example: --fallback-extensions html,htm,php,asp,aspx,jsp,cgi
133149
134150 --header < HEADER>
135151 Custom request header
136152
137153 -a, --accept < ACCEPT>
138154 A List of accepted status codes for valid links
139-
155+
140156 The following accept range syntax is supported: [start]..[= ]end| code. Some valid
141157 examples are:
142-
158+
143159 - 200..=204
144160 - 200..204
145161 - ..=204
146162 - ..204
147163 - 200
148-
164+
149165 Use " lychee --accept '200..=204, 429, 500' <inputs>..." to provide a comma-
150166 separated list of accepted status codes. This example will accept 200, 201,
151167 202, 203, 204, 429, and 500 as valid status codes.
152-
168+
153169 [default: 100..= 103,200..= 299]
154170
155171 --include-fragments
156172 Enable the checking of fragments in links
157173
158174 -t, --timeout < TIMEOUT>
159175 Website timeout in seconds from connect to response finished
160-
176+
161177 [default: 20]
162178
163179 -r, --retry-wait-time < RETRY_WAIT_TIME>
164180 Minimum wait time in seconds between retries of failed requests
165-
181+
166182 [default: 1]
167183
168184 -X, --method < METHOD>
169185 Request method
170-
186+
171187 [default: get]
172188
173189 -b, --base < BASE>
174- Base URL or website root directory to check relative URLs e.g. https://example.com or ` /path/to/public`
190+ Base URL or website root directory to check relative URLs e.g. < https://example.com> or ` /path/to/public`
191+
192+ --root-dir < ROOT_DIR>
193+ Root path to use when checking absolute local links, must be an absolute path
175194
176195 --basic-auth < BASIC_AUTH>
177196 Basic authentication support. E.g. ` http://example.com username:password`
178197
179198 --github-token < GITHUB_TOKEN>
180199 GitHub API token to use when checking github.com links, to avoid rate limiting
181-
200+
182201 [env: GITHUB_TOKEN]
183202
184203 --skip-missing
185204 Skip missing input files (default is to error if they don' t exist)
186205
206+ --no-ignore
207+ Do not skip files that would otherwise be ignored by ' .gitignore' , ' .ignore' , or the global ignore file
208+
209+ --hidden
210+ Do not skip hidden directories and files
211+
187212 --include-verbatim
188213 Find links in verbatim sections like `pre`- and `code` blocks
189214
@@ -193,10 +218,17 @@ Options:
193218 -o, --output <OUTPUT>
194219 Output file of status report
195220
196- -f, --format <FORMAT>
197- Output format of final status report (compact, detailed, json, markdown)
221+ --mode <MODE>
222+ Set the output display mode. Determines how results are presented in the terminal
223+
224+ [default: color]
225+ [possible values: plain, color, emoji]
198226
227+ -f, --format <FORMAT>
228+ Output format of final status report
229+
199230 [default: compact]
231+ [possible values: compact, detailed, json, markdown, raw]
200232
201233 --require-https
202234 When HTTPS is available, treat HTTP links as errors
@@ -209,7 +241,6 @@ Options:
209241
210242 -V, --version
211243 Print version
212-
213244```
214245
215246:::note
0 commit comments