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:

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

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

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/completion )"

The help command displays help for a given command:

help list

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

help --format=xml list

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

The list command lists all commands:

list

You can also display the commands for a specific namespace:

list test

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

list --format=xml

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

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_PROJECT_NAME="Automated Setup" \
TYPO3_SERVER_TYPE="apache" \
./setup --force

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_ADMIN=0 \
TYPO3_BE_USER_MAINTAINER=0 \
./backend:user:create --no-interaction

This command can be used to clear the caches, 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.

Traverse page tree and find and clean/update records with dirty FlexForm values. If you want to get more detailed information, use the --verbose option.

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.

Assumption: All actively used records on the website from TCA configured tables are located in the page tree exclusively.

All records managed by TYPO3 via the TCA array configuration has to belong to a page in the page tree, either directly or indirectly as a version of another record. VERY TIME, CPU and MEMORY intensive operation since the full page tree is looked up!

Automatic Repair of Errors: - Silently deleting the orphaned records. In theory they should not be used anywhere in the system, but there could be references. See below for more details on this matter.

Manual repair suggestions: - Possibly re-connect orphaned records to page tree by setting their "pid" field to a valid page id. A lookup in the sys_refindex table can reveal if there are references to an orphaned record. If there are such references (from records that are not themselves orphans) you might consider to re-connect the record to the page tree, otherwise it should be safe to delete it.

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

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.

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.

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

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

Update the language files of all activated extensions

Sends emails from the spool

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

php messenger:consume <receiver-name>

To receive from multiple transports, pass each name:

php messenger:consume receiver1 receiver2

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

php messenger:consume <receiver-name> --queues=fasttrack

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 Scheduler tasks.

List all Scheduler tasks.

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

Shows the list of sites available to the system

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.

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.