Console commands

The extension provides the following console commands:

`warming:cachewarmup`

A command to trigger cache warmup of single pages and/or whole sites using their XML sitemaps.

Important

You must pass at least the --pages or --sites command option.

vendor/bin/typo3 warming:cachewarmup

typo3/sysext/core/bin/typo3 warming:cachewarmup

The following command options are available:

-p|--pages

Required: false
type: integer
Default: none
Multiple allowed: true

Use this option to provide IDs of pages whose Frontend caches should be warmed up. You can pass this option multiple times, either as single integer values or as a comma-separated list of integer values.

Example:

vendor/bin/typo3 warming:cachewarmup -p 1 -p 2 -p 3
vendor/bin/typo3 warming:cachewarmup -p 1,2,3

typo3/sysext/core/bin/typo3 warming:cachewarmup -p 1 -p 2 -p 3
typo3/sysext/core/bin/typo3 warming:cachewarmup -p 1,2,3

-s|--sites

Required: false
type: integer or string (site identifier)
Default: none
Multiple allowed: true

Use this option to provide a list of sites to be warmed up. You can either pass the appropriate site identifiers or the site's root page IDs.

Example:

vendor/bin/typo3 warming:cachewarmup -s my-cool-site
vendor/bin/typo3 warming:cachewarmup -s 1

typo3/sysext/core/bin/typo3 warming:cachewarmup -s my-cool-site
typo3/sysext/core/bin/typo3 warming:cachewarmup -s 1

-l|--languages

Required: false
type: integer
Default: -1 (all languages)
Multiple allowed: true

You can optionally limit the languages of sites to be warmed up to a given list of language IDs. If this option is omitted, all site languages will be included in the cache warmup.

Example:

vendor/bin/typo3 warming:cachewarmup -l 0 -l 1
vendor/bin/typo3 warming:cachewarmup -l 0,1

typo3/sysext/core/bin/typo3 warming:cachewarmup -l 0 -l 1
typo3/sysext/core/bin/typo3 warming:cachewarmup -l 0,1

--limit

Required: false
type: integer
Default: limit value from extension configuration
Multiple allowed: false

Maximum number of pages to be crawled. Set to 0 to disable the limit. If this option is omitted, the limit value from extension configuration is used.

-x|--strict

Required: false
type: boolean
Default: false
Multiple allowed: false

Exit with a non-zero status code in case cache warmup fails or errors occur during cache warmup.

`warming:showuseragent`

A command that shows the custom User-Agent header that is used for cache warmup requests by default crawlers.

Note

This command is not schedulable.

vendor/bin/typo3 warming:showuseragent

typo3/sysext/core/bin/typo3 warming:showuseragent