Command

muffy

The static website validator

Usage: muffy [OPTIONS] [COMMAND]

Commands:
  check       Validates websites with a configuration file
  check-site  Validates a website
  cache       Manages the persistent cache
  help        Print this message or the help of the given subcommand(s)

Options:
      --format <FORMAT>
          Set an output format

          Possible values:
          - text: Human-readable text
          - json: JSON

          [default: text]

      --verbose
          Be verbose

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

muffy check

Validates websites with a configuration file

Usage: muffy check [OPTIONS] [CONFIG]

Arguments:
  [CONFIG]
          A configuration file

Options:
      --format <FORMAT>
          Set an output format

          Possible values:
          - text: Human-readable text
          - json: JSON

          [default: text]

      --verbose
          Be verbose

  -h, --help
          Print help (see a summary with '-h')

muffy check-site

Validates a website

Usage: muffy check-site [OPTIONS] <URL>...

Arguments:
  <URL>...
          Website URLs

Options:
      --cache
          Use a persistent cache

      --max-age <MAX_AGE>
          Set a maximum cache age

          [default: 0s]

      --accept-status <ACCEPT_STATUS>
          Set accepted status codes

          [default: 200]

      --accept-scheme <ACCEPT_SCHEME>
          Set accepted schemes

          [default: http https]

      --format <FORMAT>
          Set an output format

          Possible values:
          - text: Human-readable text
          - json: JSON

          [default: text]

      --header <HEADER>
          Set request headers

      --verbose
          Be verbose

      --max-redirects <MAX_REDIRECTS>
          Set a maximum number of redirects

          [default: 16]

      --timeout <TIMEOUT>
          Set an HTTP timeout

          [default: 30s]

      --concurrency <CONCURRENCY>
          Set concurrency

          [default: 32768]

      --ignore <IGNORE>
          Set URL patterns to ignore from validation

      --rate-limit-count <RATE_LIMIT_COUNT>
          Set a rate limit count

          [default: 18446744073709551615]

      --rate-limit-window <RATE_LIMIT_WINDOW>
          Set a rate limit window

          [default: 1s]

      --retry-count <RETRY_COUNT>
          Set a retry count

          [default: 0]

      --retry-factor <RETRY_FACTOR>
          Set a retry factor

          [default: 2]

      --initial-retry-interval <INITIAL_RETRY_INTERVAL>
          Set an initial retry interval

          [default: 1s]

      --retry-interval-cap <RETRY_INTERVAL_CAP>
          Set a retry interval cap

          [default: 10s]

      --retry-status <RETRY_STATUS>
          Set a list of status codes to retry on

      --experimental-validation
          Enable experimental HTML validation

  -h, --help
          Print help (see a summary with '-h')