---
title: "Console commands"
manual: "Warming"
version: "5.3"
permalink: "https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:console-commands@5.3"
source: "Usage/ConsoleCommands.rst"
rendered: "2026-11-05T08:37:00+00:00"
---

# Console commands {#console-commands}

The extension provides the following console commands:

## `warming:cachewarmup` {#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.

> [!TIP]
> If you use `warming:cachewarmup` in your deployment process and the sitemap is protected with HTTP authentication
> (basic auth) or the website does not have a valid SSL certificate, you can configure this in the extension
> configuration with [verboseCrawlerOptions](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-verbosecrawleroptions@5.3) and
> [parserOptions](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extconf-parseroptions@5.3).

**Composer-based installation**

```bash
vendor/bin/typo3 warming:cachewarmup
```

**Legacy installation**

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

The following command options are available:

-   **-p|--pages**

    -   *Type:* integer
    -   *Required:* false
    -   *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:

    **Composer-based installation**

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

    **Legacy installation**

    ```bash
    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**

    -   *Type:* integer or string (site identifier or `all`)
    -   *Required:* false
    -   *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.

    <!-- TODO: no Markdown rendering for "versionadded" -->

    Feature: #720 - Allow warming up all available sites at onceYou can also pass the special keyword all to warm up all
    available sites at once.Example:

    **Composer-based installation**

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

    **Legacy installation**

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

-   **-l|--languages**

    -   *Type:* integer
    -   *Required:* false
    -   *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:

    **Composer-based installation**

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

    **Legacy installation**

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

-   **-c|--config**

    -   *Type:* string
    -   *Required:* false
    -   *Default:* none
    -   *Multiple allowed:* false

    An external configuration file can be used to provide a more
    fine-grained configuration for cache warmup. The file path may
    contain references to extensions (see example below).

    > [!NOTE]
    > Config file options will be merged with command options,
    > whereas command options receive higher priority. It's even
    > possible to use environment variables for configuration. Read
    > more in the [official documentation](https://cache-warmup.dev/configuration.html).

    At the moment, the following file formats are supported:

    -   JSON
    -   PHP
    -   YAML

    Example:

    **Composer-based installation**

    ```bash
    vendor/bin/typo3 warming:cachewarmup --config cache-warmup.yaml
    vendor/bin/typo3 warming:cachewarmup --config EXT:sitepackage/Configuration/cache-warmup.yaml
    ```

    **Legacy installation**

    ```bash
    typo3/sysext/core/bin/typo3 warming:cachewarmup --config cache-warmup.yaml
    typo3/sysext/core/bin/typo3 warming:cachewarmup --config EXT:sitepackage/Configuration/cache-warmup.yaml
    ```

-   **--limit**

    -   *Type:* integer
    -   *Required:* false
    -   *Default:* `limit` value from [extension configuration](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extension-configuration@5.3)
    -   *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](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extension-configuration@5.3) is
    used.

    Example:

    **Composer-based installation**

    ```bash
    vendor/bin/typo3 warming:cachewarmup --limit 100
    ```

    **Legacy installation**

    ```bash
    typo3/sysext/core/bin/typo3 warming:cachewarmup --limit 100
    ```

-   **--strategy**

    -   *Type:* string
    -   *Required:* false
    -   *Default:* `strategy` value from [extension configuration](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extension-configuration@5.3)
    -   *Multiple allowed:* false

    Name of an available crawling strategy to use for cache warmup. If
    this option is omitted, the `strategy` value from
    [extension configuration](https://docs.typo3.org/permalink/eliashaeussler/typo3-warming:extension-configuration@5.3) is used.

    Example:

    **Composer-based installation**

    ```bash
    vendor/bin/typo3 warming:cachewarmup --strategy sort-by-priority
    ```

    **Legacy installation**

    ```bash
    typo3/sysext/core/bin/typo3 warming:cachewarmup --strategy sort-by-priority
    ```

-   **-x|--strict**

    -   *Type:* boolean
    -   *Required:* false
    -   *Default:* false
    -   *Multiple allowed:* false

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

    Example:

    **Composer-based installation**

    ```bash
    vendor/bin/typo3 warming:cachewarmup --strict
    ```

    **Legacy installation**

    ```bash
    typo3/sysext/core/bin/typo3 warming:cachewarmup --strict
    ```

## `warming:showuseragent` {#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](https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/CommandControllers/CustomCommands.html#schedulable).

**Composer-based installation**

```bash
vendor/bin/typo3 warming:showuseragent
```

**Legacy installation**

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