List of TYPO3 console commands 

The completion command dumps the shell completion script required to use shell autocompletion (currently, bash, fish, zsh completion are supported).

Dump the script to a global completion file and restart your shell:

vendor/vendor/bin/typo3 completion  | sudo tee /etc/bash_completion.d/typo3

Or dump the script to a local file and source it:

vendor/vendor/bin/typo3 completion  > completion.sh

# source the file whenever you use the project
source completion.sh

# or add this line at the end of your "~/.bashrc" file:
source /path/to/completion.sh

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

eval "$(/var/www/html/vendor/vendor/bin/typo3 completion )"

The help command displays help for a given command:

vendor/vendor/bin/typo3 help list

You can also output the help in other formats by using the --format option:

vendor/vendor/bin/typo3 help --format=xml list

To display the list of available commands, please use the list command.

The list command lists all commands:

vendor/vendor/bin/typo3 list

You can also display the commands for a specific namespace:

vendor/vendor/bin/typo3 list test

You can also output the information in other formats by using the --format option:

vendor/vendor/bin/typo3 list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

vendor/vendor/bin/typo3 list --raw

The command offers 3 ways to setup TYPO3:

1. environment variables
2. commandline options
3. interactive guided walk-through

All values are validated no matter where it was set. If a value is missing, the user will be asked for it.

Setup using environment variables

TYPO3_DB_DRIVER=mysqli \
TYPO3_DB_USERNAME=db \
TYPO3_DB_PORT=3306 \
TYPO3_DB_HOST=db \
TYPO3_DB_DBNAME=db \
TYPO3_SETUP_ADMIN_EMAIL=admin@example.com \
TYPO3_SETUP_ADMIN_USERNAME=admin \
TYPO3_SETUP_CREATE_SITE="https://your-typo3-site.com/" \
TYPO3_SETUP_DISTRIBUTION="theme_camino" \
TYPO3_PROJECT_NAME="Automated Setup" \
TYPO3_SERVER_TYPE="apache" \
./vendor/bin/typo3 setup --force

Publishes public assets. Needs to be run after composer install.

Lock the TYPO3 Backend

Trigger a password reset for a backend user.

Unlock the TYPO3 Backend

Create a backend user using environment variables

Example:

TYPO3_BE_USER_NAME=username \
TYPO3_BE_USER_EMAIL=admin@example.com \
TYPO3_BE_USER_GROUPS=<comma-separated-list-of-group-ids> \
TYPO3_BE_USER_LANGUAGE=de \
TYPO3_BE_USER_ADMIN=0 \
TYPO3_BE_USER_MAINTAINER=0 \
./vendor/bin/typo3 backend:user:create --no-interaction

Clears TYPO3 caches. Useful after code changes during development or after deployments. You can flush a specific cache group (system, pages, di) or all caches.

This command can be used to clear the caches with specific tags, for example after code updates in local development and after deployments.

This command is useful for deployments to warmup caches during release preparation.

Traverse page tree and find and flush deleted records. If you want to get more detailed information, use the --verbose option.

Clean up records with dirty FlexForm values not reflected in current data structure.

If you want to get more detailed information, use the --verbose option.

Assumptions: - a perfect integrity of the reference index table (always update the reference index table before using this tool!) - all database references to check are integers greater than zero - does not check if a referenced record is inside an offline branch, another workspace etc. which could make the reference useless in reality or otherwise question integrity Records may be missing for these reasons (except software bugs): - someone deleted the record which is technically not an error although it might be a mistake that someone did so. - after flushing published versions and/or deleted-flagged records a number of new missing references might appear; those were pointing to records just flushed.

An automatic repair is only possible for managed references are (not for soft references), for offline versions records and non-existing records. If you just want to list them, use the --dry-run option. The references in this case are removed.

If the option "--dry-run" is not set, all managed files (TCA/FlexForm attachments) will silently remove the references to non-existing and offline version records. All soft references with relations to non-existing records, offline versions and deleted records require manual fix if you consider it an error.

Manual repair suggestions: - For soft references you should investigate each case and edit the content accordingly. - References to deleted records can theoretically be removed since a deleted record cannot be selected and hence your website should not be affected by removal of the reference. On the other hand it does not hurt to ignore it for now. To have this automatically fixed you must first flush the deleted records after which remaining references will appear as pointing to Non Existing Records and can now be removed with the automatic fix.

If you want to get more detailed information, use the --verbose option.

TYPO3 "pages" database table is a tree that represents a hierarchical structure with a set of connected nodes by their "uid" und "pid" values. All TCA records must be connected to a valid "pid".

This command finds and deletes all "pages" rows that do not have a proper tree connection to "pid" "0". It also finds and deletes TCA record rows having a "pid" set to invalid "pages" "uid"s.

The command can be called using "typo3 cleanup:orphanrecords -v --dry-run" to find affected records allowing manual inspection.

Look for preview links within the database table "sys_preview" that have been expired and and remove them. This command should be called regularly when working with workspaces.

Traverse page tree and find versioned records. Also list all versioned records, additionally with some inconsistencies in the database, which can cleaned up with the "action" option. If you want to get more detailed information, use the --verbose option.

Remove system configuration option(s) from system/settings.php.

Multiple paths can be specified separated by comma.

Examples:

vendor/bin/typo3 configuration:remove EXTCONF/myext/setting vendor/bin/typo3 configuration:remove "EXTCONF/ext1,EXTCONF/ext2" --force

Set a system configuration option in system/settings.php.

Examples:

vendor/bin/typo3 configuration:set SYS/sitename "My Site" vendor/bin/typo3 configuration:set BE/debug true --json vendor/bin/typo3 configuration:set SYS/features/myFeature true --json

Show a system configuration value.

By default, if the active value differs from the local value, both values are shown with the difference highlighted.

Use --type to show a specific configuration source:

active - effective runtime value from $GLOBALS['TYPO3_CONF_VARS'] local - value from system/settings.php only

Examples:

vendor/bin/typo3 configuration:show SYS/sitename vendor/bin/typo3 configuration:show SYS/sitename --type=active vendor/bin/typo3 configuration:show DB/Connections/Default --type=local --json

Publish Content Blocks assets into Resources/Public folder of the host extension.

Create a Content Block

Update labels.xlf for the given Content Block

Lint all Content Blocks against JSON Schema

List available Content Blocks

Debugging: Show a list of the backend module tree (only for development purpose)

Debugging: List all registered backend routes (only for development purpose)

Shows the list of extensions available to the system.

Setup all extensions or the given extension by extension key. This must be performed after new extensions are required via Composer.

The command performs all necessary setup operations, such as database schema changes, static data import, distribution files import etc.

The given extension keys must be recognized by TYPO3 or will be ignored.

Analyzes Fluid templates for syntax errors and deprecated functionality.

Performs a cache warmup for detected Fluid templates.

Lists all registered global Fluid ViewHelper namespaces.

Generate XSD schema files for all available ViewHelpers in var/transient/.

Removes old form upload folders (form_<hash>) that were created by file uploads in ext:form.

Since uploaded files are not moved when a form is submitted, the command cannot distinguish between folders from completed and abandoned submissions. It uses the folder modification time and a configurable retention period to decide which folders to remove.

You must specify at least one upload folder to scan. Each form element can configure a different saveToFileMount; pass all relevant folders as arguments.

Use --verbose for detailed output about each folder found.

Transfers form definitions from one storage backend to another.

Available storage types depend on the installed adapters. Core provides:

• database: Database storage (default target)
• extension: Extension paths (EXT:...)
• filemount: File mount storage (deprecated since v14.2)

Target location (--target-location / -l) per storage type:

• database: Always "0" (fixed; forms are stored at the root level).

• extension: An EXT: path configured in "persistenceManager.allowedExtensionPaths",

  with "persistenceManager.allowSaveToExtensionPaths: true" set. e.g. --target-location="EXT:my_extension/Resources/Private/Forms/"

• filemount: A FAL folder path configured in "persistenceManager.allowedFileMounts",

  e.g. --target-location="1:/forms/"

Use --dry-run to preview which forms would be transferred. Use --move to delete the source form after successful transfer.

After a successful transfer, content element references in "tt_content" are automatically updated to point to the new storage location. No other tables are updated.

Exports a T3D / XML file with content of a page tree

Imports a T3D / XML file with content into a page tree

Lists all translation domains and their label resource file locations.

The command scans all language resource files (XLIFF) within active or specific extensions and lists matching labels by domain, based on a given search string or regular expression.

This tool is especially useful during the ongoing consolidation and relocation of language labels in Core and extension development, allowing developers to easily find labels and identify replacements when refactoring or cleaning up translations.

Examples ========

Search all active extensions for labels containing the word "cache":

vendor/vendor/bin/typo3 language:domain:search --search cache

Search only in the core extension using a regular expression:

vendor/vendor/bin/typo3 language:domain:search --extension core --regex "/cache|clear/i"

Update the language files of all activated extensions

The lint:yaml command lints a YAML file and outputs to STDOUT the first encountered syntax error.

You can validates YAML contents passed from STDIN:

cat filename | php vendor/vendor/bin/typo3 lint:yaml -

You can also validate the syntax of a file:

php vendor/vendor/bin/typo3 lint:yaml filename

Or of a whole directory:

php vendor/vendor/bin/typo3 lint:yaml dirname

The --format option specifies the format of the command output:

php vendor/vendor/bin/typo3 lint:yaml dirname --format=json

You can also exclude one or more specific files:

php vendor/vendor/bin/typo3 lint:yaml dirname --exclude="dirname/foo.yaml" --exclude="dirname/bar.yaml"

Sends emails from the spool.

The messenger:consume command consumes messages and dispatches them to the message bus.

php vendor/vendor/bin/typo3 messenger:consume <receiver-name>

To receive from multiple transports, pass each name:

php vendor/vendor/bin/typo3 messenger:consume receiver1 receiver2

Use the --limit option to limit the number of messages received:

php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --limit=10

Use the --failure-limit option to stop the worker when the given number of failed messages is reached:

php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --failure-limit=2

Use the --memory-limit option to stop the worker if it exceeds a given memory usage limit. You can use shorthand byte values [K, M or G]:

php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --memory-limit=128M

Use the --time-limit option to stop the worker when the given time limit (in seconds) is reached. If a message is being handled, the worker will stop after the processing is finished:

php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --time-limit=3600

Use the --bus option to specify the message bus to dispatch received messages to instead of trying to determine it automatically. This is required if the messages didn't originate from Messenger:

php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --bus=event_bus

Use the --queues option to limit a receiver to only certain queues (only supported by some receivers):

php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --queues=fasttrack

Use the --all option to consume from all receivers:

php vendor/vendor/bin/typo3 messenger:consume --all

Check integrity of redirects

Cleanup old redirects periodically for given constraints like days, hit count or domains.

Update the reference index of TYPO3

Execute given TYPO3 Scheduler tasks.

List all TYPO3 Scheduler tasks.

If no parameter is given, the scheduler executes any tasks that are overdue to run. Call it like this: typo3/sysext/core/vendor/bin/typo3 scheduler:run --task=13 -f

The command will allow you to create base backend user groups for your TYPO3 installation.

You can create either both or one of the following groups:

• Editor
• Advanced Editor

Shows the list of sites available to the system.

Shows the list of available site sets.

Shows the configuration of the specified site.

Prints a list of recent sys_log entries. If you want to get more detailed information, use the --verbose option.

List available upgrade wizards.

Mark upgrade wizard as undone.

This command allows running upgrade wizards on CLI. To run a single wizard add the identifier of the wizard as argument. The identifier of the wizard is the name it is registered with in ext_localconf.

Some workspaces can have an auto-publish publication date to put all "ready to publish" content online on a certain date.