Command

bengal.health.linkcheck

Check internal and external links in the site.

Validates that all links in your site work correctly:

  • Internal links point to existing pages and anchors
  • External links return successful HTTP status codes

The site must be built before checking internal links. Use --format json with --output to generate a report file for CI/CD integration.

13Options1Argument

Usage

bengal.health.linkcheck [OPTIONS]

Options

Option Type Description
--exclude TEXT

URL pattern to exclude (repeatable, regex supported)
--exclude-domain TEXT

Domain to exclude (repeatable, e.g., 'localhost')
--external-only flag BOOLEAN

Only check external links (skip internal validation)
--ignore-status TEXT

Status code or range to ignore (repeatable, e.g., '500-599', '403')
--internal-only flag BOOLEAN

Only check internal links (skip external validation)
--max-concurrency INTEGER

Maximum concurrent HTTP requests (default: 20)
--output PATH

Output file (for JSON format)
--format CHOICE

Output format

Default:console
--per-host-limit INTEGER

Maximum concurrent requests per host (default: 4)
--retries INTEGER

Number of retry attempts (default: 2)
--retry-backoff FLOAT

Base backoff time for exponential backoff in seconds (default: 0.5)
--timeout FLOAT

Request timeout in seconds (default: 10.0)
--traceback CHOICE

Traceback verbosity: full | compact | minimal | off

Arguments

Argument Type Description
source PATH Default:.

Examples

    bengal health linkcheck
    bengal health linkcheck --external-only
    bengal health linkcheck --format json --output report.json
    bengal health linkcheck --exclude "^/api/preview/" --ignore-status "500-599"