Schema registry

lychee

lychee link checker configuration file

lychee.toml.lychee.toml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your lychee.toml and it validates in your browser — nothing is uploaded.

Validate a lychee.toml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`files_from`	`string`	Read input filenames from the given file or stdin if the path is '-'.
`verbose`	`string`	Program log level. one of: `"error", "warn", "info", "debug", "trace"`
`no_progress`	`boolean`	Do not show the interactive progress bar.
`host_stats`	`boolean`	Show per-host statistics at the end of the run.
`extensions`	`array<string>`	—
`default_extension`	`string`	File extension used to parse input sources without a recognized file type.
`cache`	`boolean`	Enable link caching.
`max_cache_age`	`string`	Discard cached requests older than this duration, such as '2d' or '12h'.
`cache_exclude_status`	`oneOf`	—
`dump`	`boolean`	Extract links without checking them.
`dump_inputs`	`boolean`	Dump inputs instead of extracting or checking links.
`archive`	`string`	Web archive to use for suggestions. one of: `"wayback"`
`suggest`	`boolean`	Suggest link replacements for broken links.
`max_redirects`	`integer`	Maximum number of allowed redirects.
`max_retries`	`integer`	Maximum number of retries per request.
`min_tls`	`string`	Minimum accepted TLS version. one of: `"TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"`
`max_concurrency`	`integer`	Maximum number of concurrent network requests.
`host_concurrency`	`integer`	Default maximum concurrent requests per host.
`host_request_interval`	`string`	Default minimum interval between requests to the same host, such as '50ms' or '1s'.
`threads`	`integer`	Number of threads to utilize.
`user_agent`	`string`	User agent sent with each request.
`insecure`	`boolean`	Proceed for server connections considered insecure.
`scheme`	`array<string>`	—
`offline`	`boolean`	Only check local files and block network requests.
`include`	`array<string>`	—
`exclude`	`array<string>`	—
`exclude_path`	`array<string>`	—
`exclude_all_private`	`boolean`	Exclude all private, link-local, and loopback IP ranges.
`exclude_private`	`boolean`	Exclude private IP address ranges.
`exclude_link_local`	`boolean`	Exclude link-local IP address ranges.
`exclude_loopback`	`boolean`	Exclude loopback IP address ranges and localhost.
`include_mail`	`boolean`	Check email addresses.
`remap`	`array<string>`	—
`fallback_extensions`	`array<string>`	—
`index_files`	`array<string>`	—
`header`	`object`	—
`accept`	`oneOf`	—
`accept_timeouts`	`boolean`	Accept timed out requests.
`include_fragments`	`string`	Fragment checking mode. one of: `"none", "anchor-only", "text-only", "full"`
`timeout`	`integer`	Website timeout in seconds from connect to response finished.
`retry_wait_time`	`integer`	Minimum wait time in seconds between retries.
`method`	`oneOf`	—
`base_url`	`string`	Base URL or absolute path used to resolve relative URLs in local files.
`root_dir`	`string`	Root directory used when checking absolute local links.
`basic_auth`	`array<string>`	—
`github_token`	`string`	GitHub API token used to avoid rate limiting on github.com links.
`skip_missing`	`boolean`	Skip missing input files.
`no_ignore`	`boolean`	Do not skip files ignored by ignore files.
`hidden`	`boolean`	Do not skip hidden directories and files.
`include_verbatim`	`boolean`	Check links inside code and preformatted blocks.
`glob_ignore_case`	`boolean`	Ignore case when expanding filesystem path glob inputs.
`output`	`string`	Output file for the status report.
`mode`	`string`	Output display mode. one of: `"plain", "color", "emoji", "task"`
`format`	`string`	Output format for the final status report. one of: `"compact", "detailed", "json", "junit", "markdown"`
`generate`	`string`	Generate special output instead of checking links. one of: `"man", "complete-bash", "complete-elvish", "complete-fish", "complete-powershe…, "complete-zsh"`
`require_https`	`boolean`	Treat HTTP links as errors when HTTPS is available.
`cookie_jar`	`string`	File used to read and write cookies.
`include_wikilinks`	`boolean`	Check WikiLinks in Markdown files.
`preprocess`	`object`	Command used to preprocess input files.
`preprocess.command`required	`string`	—
`hosts`	`object`	Host-specific rate limiting and header overrides.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
64 properties, 98% carrying a description, max nesting depth 8.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`maximum`	JSON Schema Validation, draft 2020-12	§6.2.2 — "maximum"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas