Options:
Arguments:
      --dump
  -h, --help
  [inputs]...
      --cache
      --hidden
      --suggest
      --offline
  -V, --version
  -q, --quiet...
  -i, --insecure
      --no-ignore
  -v, --verbose...
          and 501.
          Examples:
  -n, --no-progress
      --dump-inputs
      --base <BASE>
          base URL.
      --mode <MODE>
          User agent
      --include-mail
      --skip-missing
          [default: ]
      --remap <REMAP>
      --require-https
          File Format:
          [default: 5]
          [default: 3]
          [default: 1]
          [default: 1d]
          examples are:
  -s, --scheme <SCHEME>
      --exclude-private
  -a, --accept <ACCEPT>
          examples are:
          [default: 20]
  -X, --method <METHOD>
  -o, --output <OUTPUT>
  -f, --format <FORMAT>
          Print version
          [default: 128]
      --exclude-loopback
          Request method
          [default: get]
      --include-verbatim
      --glob-ignore-case
      --files-from <PATH>
      --archive <ARCHIVE>
      --min-tls <MIN_TLS>
  -T, --threads <THREADS>
      --include <INCLUDE>
      --exclude <EXCLUDE>
      --include-fragments
  -t, --timeout <TIMEOUT>
      --include-wikilinks
A fast, async link checker
      --exclude-link-local
          [default: color]
  -E, --exclude-all-private
  -b, --base-url <BASE_URL>
      --root-dir <ROOT_DIR>
  -c, --config <CONFIG_FILE>
                     a file.
          [default: compact]
  -H, --header <HEADER:VALUE>
          [env: GITHUB_TOKEN]
      --extensions <EXTENSIONS>
  -u, --user-agent <USER_AGENT>
      --basic-auth <BASIC_AUTH>
      --cookie-jar <COOKIE_JAR>
          [default: lychee.toml]
      --max-retries <MAX_RETRIES>
      --index-files <INDEX_FILES>
          [default: lychee/0.20.1]
Usage: lychee [OPTIONS] [inputs]...
          Configuration file to use
          Do not show progress bar.
      --exclude-file <EXCLUDE_FILE>
      --exclude-path <EXCLUDE_PATH>
      --github-token <GITHUB_TOKEN>
          [possible values: wayback]
          Also check email addresses
      --max-cache-age <MAX_CACHE_AGE>
  -m, --max-redirects <MAX_REDIRECTS>
                --index-files logic).
          Minimum accepted TLS Version
          Output file of status report
            lychee --files-from list.txt
          Set custom header for requests
          [default: 100..=103,200..=299]
          at the given base URL address.
            Empty lines are also ignored.
      --max-concurrency <MAX_CONCURRENCY>
  -r, --retry-wait-time <RETRY_WAIT_TIME>
          Check WikiLinks in Markdown files
          specify both extensions explicitly.
          Maximum number of allowed redirects
          Deprecated; use `--base-url` instead
          Output format of final status report
          Print help (see a summary with '-h')
          Maximum number of retries per request
          Exclude all private IPs from checking.
      --fallback-extensions <FALLBACK_EXTENSIONS>
          will be checked in order of appearance.
          - ..204 (accepts any status code < 204)
          - ..100 (excludes any status code < 100)
          Deprecated; use `--exclude-path` instead
          - 200 (accepts the 200 status code only)
          path of the file containing these links.
          Do not skip hidden directories and files
      --cache-exclude-status <CACHE_EXCLUDE_STATUS>
          - 429 (excludes the 429 status code only)
          - 500.. (excludes any status code >= 500)
          - ..=204 (accepts any status code <= 204)
          Enable the checking of fragments in links
          followed by the absolute link's own path.
            echo 'README.md' | lychee --files-from -
          Remap URI matching pattern to different URI
          [possible values: plain, color, emoji, task]
            find . -name '*.md' | lychee --files-from -
          Maximum number of concurrent network requests
          Less output per occurrence (e.g. `-q` or `-qq`)
          Exclude private IP address ranges from checking
          A List of accepted status codes for valid links
          Only check local files and block network requests
          Exclude link-local IP address range from checking
                     and requires that at least one exists.
          Use request cache stored on disk at `.lycheecache`
          202, 203, 204, 429, and 500 as valid status codes.
          cumbersome to specify on the command line directly.
          When HTTPS is available, treat HTTP links as errors
          Discard all cached requests older than this duration
          [possible values: TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3]
                     still accept the directory link regardless.
          Ignore case when expanding filesystem path glob inputs
          [possible values: compact, detailed, json, markdown, raw]
          A list of status codes that will be ignored from the cache
          Example: --fallback-extensions html,htm,php,asp,aspx,jsp,cgi
          Website timeout in seconds from connect to response finished
          Exclude loopback IP address range and localhost from checking
          Find links in verbatim sections like `pre`- and `code` blocks
            Lines starting with '#' are treated as comments and ignored.
          This is the same format that other tools like curl or wget use.
          - 200..=204 (accepts any status code from 200 to 204 inclusive)
          Minimum wait time in seconds between retries of failed requests
          - 500..=599 (excludes any status code from 500 to 599 inclusive)
          Proceed for server connections considered insecure (invalid TLS)
          URLs to check (supports regex). Has preference over all excludes
          a link of `a` would resolve to `https://example.com/dir/page/a`.
          [default: md,mkd,mdx,mdown,mdwn,mkdn,mkdown,markdown,html,htm,txt]
          name `.` can be used in the list to refer to the directory itself.
          Skip missing input files (default is to error if they don't exist)
          Read input filenames from the given file or stdin (if path is '-').
          This is useful when you have a large number of inputs that would be
          links are considered valid as long as the directory exists on disk.
          Multiple headers can be specified by using the flag multiple times.
          Set verbosity level; more output per occurrence (e.g. `-v` or `-vv`)
            Each line should contain one input (file path, URL, or glob pattern).
          Test the specified file extensions for URIs when checking files locally.
          Equivalent to `--exclude-private --exclude-link-local --exclude-loopback`
          When checking locally, resolves directory links to a separate index file.
          Basic authentication support. E.g. `http://example.com username:password`
          Note: This option takes effect on `file://` URIs which do not exist and on
          Base URL to use when resolving relative URLs in local files. If specified,
          This option can be specified alongside `--base-url`. If both are given, an
          When checking locally, attempts to locate missing files by trying the given
          If `--index-files` is specified, then at least one index file must exist in
          Use "lychee --accept '200..=204, 429, 500' <inputs>..." to provide a comma-
          separated list of accepted status codes. This example will accept 200, 201,
          to `https://example.com/b`. This behavior is not affected by the filesystem
          Note that relative URLs without a leading slash become siblings of the base
          names are relative to the link's directory and attempted in the order given.
          order for a directory link to be considered valid. Additionally, the special
          relative links in local files are interpreted as being relative to the given
          would resolve to `https://example.com/dir/a` and the link `/b` would resolve
          absolute link is resolved by constructing a URL from three parts: the domain
          name specified in `--base-url`, followed by the `--root-dir` directory path,
          If unspecified (the default behavior), index files are disabled and directory
          Example 2: `--index-files index.html,.` will use index.html if it exists, but
          For example, given a base URL of `https://example.com/dir/page`, the link `a`
                `file://` URIs pointing to directories which resolve to themself (by the
          URL. If, instead, the base URL ended in a slash, the link would become a child
          root directory to the requested absolute link. For example, with a root-dir of
          GitHub API token to use when checking github.com links, to avoid rate limiting
          fallback extensions. Multiple extensions can be separated by commas. Extensions
          The argument is a comma-separated list of index file names to search for. Index
          Example 3: `--index-files ''` will reject all directory links because there are
          of the base URL. For example, a base URL of `https://example.com/dir/page/` and
          Basically, the base URL option resolves links as if the local files were hosted
          required if absolute links appear in local files, otherwise those links will be
          If specified, absolute links in local files are resolved by prefixing the given
          `/root/dir`, a link to `/page.html` would be resolved to `/root/dir/page.html`.
          This is recommended for non-interactive shells (e.g. for continuous integration)
                     no valid index files. This will require every link to explicitly name
          flagged as errors. This must be an absolute path (i.e., one beginning with `/`).
          Number of threads to utilize. Defaults to number of cores available to the system
          Exclude paths from getting checked. The values are treated as regular expressions
          Example 1: `--index-files index.html,readme.md` looks for index.html or readme.md
          Root directory to use when checking absolute links in local files. This option is
          Set the output display mode. Determines how results are presented in the terminal
          The following accept range syntax is supported: [start]..[[=]end]|code. Some valid
          The following exclude range syntax is supported: [start]..[[=]end]|code. Some valid
          Some websites require custom headers to be passed in order to return valid responses.
          - 200..205 (accepts any status code from 200 to 205 excluding 205, same as 200..=204)
          - 500..600 (excludes any status code from 500 to 600 excluding 600, same as 500..=599)
          Specify the use of a specific web archive. Can be used in combination with `--suggest`
Finds broken URLs and mail addresses inside Markdown, HTML, `reStructuredText`, websites and more!
          Multiple extensions can be separated by commas. Note that if you want to check filetypes,
          Note: This option only takes effect on `file://` URIs which exist and point to a directory.
          Exclude URLs and mail addresses from checking. The values are treated as regular expressions
          Use "lychee --cache-exclude-status '429, 500..502' <inputs>..." to provide a comma- separated
          You can specify custom headers in the format 'Name: Value'. For example, 'Accept: text/html'.
          which have multiple extensions, e.g. HTML files with both .html and .htm extensions, you need to
          list of excluded status codes. This example will not cache results with a status code of 429, 500
          Do not skip files that would otherwise be ignored by '.gitignore', '.ignore', or the global ignore file
          Don't perform any link checking. Instead, dump all the links extracted from inputs that would be checked
          Suggest link replacements for broken links, using a web archive. The web archive can be specified with `--archive`
          Don't perform any link extraction and checking. Instead, dump all input sources from which links would be collected
          Only test links with the given schemes (e.g. https). Omit to check links with any other scheme. At the moment, we support http, https, file, and mailto
          Tell lychee to read cookies from the given file. Cookies will be stored in the cookie jar and sent with requests. New cookies will be stored in the cookie jar and existing cookies will be updated
          The inputs (where to get links to check from). These can be: files (e.g. `README.md`), file globs (e.g. `"~/git/*/README.md"`), remote URLs (e.g. `https://example.com/README.md`) or standard input (`-`). Alternatively, use `--files-from` to read inputs from a file. NOTE: Use `--` to separate inputs from options that allow multiple arguments