Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add openSUSE Tumbleweed to the installation instructions #1470

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 24 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ Available as a command-line utility, a library and a [GitHub Action](https://git
pacman -S lychee
```

### OpenSUSE Tumbleweed

```sh
zypper in lychee
```

### macOS

```sh
Expand Down Expand Up @@ -295,7 +301,7 @@ Arguments:
Options:
-c, --config <CONFIG_FILE>
Configuration file to use

[default: lychee.toml]

-v, --verbose...
Expand All @@ -313,7 +319,7 @@ Options:

--max-cache-age <MAX_CACHE_AGE>
Discard all cached requests older than this duration

[default: 1d]

--dump
Expand All @@ -324,33 +330,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 @@ -400,46 +406,46 @@ Options:
Test the specified file extensions for URIs when checking files locally.
Multiple extensions can be separated by commas. Extensions will be checked in
order of appearance.

Example: --fallback-extensions html,htm,php,asp,aspx,jsp,cgi

--header <HEADER>
Custom request header

-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 @@ -450,7 +456,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 @@ -467,13 +473,13 @@ Options:

--mode <MODE>
Set the output display mode. Determines how results are presented in the terminal

[default: color]
[possible values: plain, color, emoji]

-f, --format <FORMAT>
Output format of final status report

[default: compact]
[possible values: compact, detailed, json, markdown, raw]

Expand Down
Loading