List of TYPO3 console commands
By default TYPO3 ships the listed console commands, depending on which system extensions are installed.
Third party extensions can define custom console commands.
The extension helhum/typo3-console ships many commands to execute TYPO3 actions, which otherwise would only be accessible via the TYPO3 backend.
This page assumes that the code is run on a Composer based installation with default binaries location. Here you can read how to run them in general and on Classic mode installations: Run a command from the command line.
List all TYPO3 console commands
| Command | Description |
|---|---|
global |
|
vendor/bin/typo3 completion |
Dump the shell completion script |
vendor/bin/typo3 help |
Display help for a command |
vendor/bin/typo3 list |
List commands |
vendor/bin/typo3 setup |
Setup TYPO3 via CLI using environment variables, CLI options or interactive |
asset |
|
vendor/bin/typo3 asset:publish |
Publish public assets. |
backend |
|
vendor/bin/typo3 backend:lock |
Lock the TYPO3 Backend |
vendor/bin/typo3 backend:resetpassword |
Trigger a password reset for a backend user. |
vendor/bin/typo3 backend:unlock |
Unlock the TYPO3 Backend |
vendor/bin/typo3 backend:user:create |
Create a backend user. |
cache |
|
vendor/bin/typo3 cache:flush |
Flush TYPO3 caches. |
vendor/bin/typo3 cache:flushtags |
Flush TYPO3 caches with tags. |
vendor/bin/typo3 cache:warmup |
Warmup TYPO3 caches. |
cleanup |
|
vendor/bin/typo3 cleanup:deletedrecords |
Permanently deletes all records marked as "deleted" in the database. |
vendor/bin/typo3 cleanup:flexforms |
Clean up database FlexForm fields that do not match the chosen data structure. |
vendor/bin/typo3 cleanup:localprocessedfiles |
Delete processed files and their database records. |
vendor/bin/typo3 cleanup:missingrelations |
Find all record references pointing to a non-existing record |
vendor/bin/typo3 cleanup:orphanrecords |
Find and delete records that have lost their connection with the page tree |
vendor/bin/typo3 cleanup:previewlinks |
Find all versioned records and possibly cleans up invalid records in the database. |
vendor/bin/typo3 cleanup:versions |
Find all versioned records and possibly cleans up invalid records in the database. |
configuration |
|
vendor/bin/typo3 configuration:remove |
Remove configuration value(s) from system/settings.php |
vendor/bin/typo3 configuration:set |
Set a configuration value in system/settings.php |
vendor/bin/typo3 configuration:show |
Show configuration value |
content-blocks |
|
vendor/bin/typo3 content-blocks:assets:publish |
Publish Content Blocks assets into Resources/Public folder of the host extension. |
vendor/bin/typo3 content-blocks:create |
Create a Content Block |
vendor/bin/typo3 content-blocks:language:generate |
Update labels.xlf for the given Content Block |
vendor/bin/typo3 content-blocks:lint |
Lint all Content Blocks against JSON Schema |
vendor/bin/typo3 content-blocks:list |
List available Content Blocks |
debug |
|
vendor/bin/typo3 debug:backend:modules |
Debugging: Show a list of the backend module tree (only for development purpose) |
vendor/bin/typo3 debug:backend:routes |
Debugging: List all registered backend routes (only for development purpose) |
extension |
|
vendor/bin/typo3 extension:list |
Shows the list of extensions available to the system. |
vendor/bin/typo3 extension:setup |
Set up extensions and perform database migrations. |
fluid |
|
vendor/bin/typo3 fluid:analyze |
Analyzes Fluid templates for syntax errors and deprecated functionality. |
vendor/bin/typo3 fluid:cache:warmup |
Performs a cache warmup for detected Fluid templates. |
vendor/bin/typo3 fluid:namespaces |
Lists all registered global Fluid ViewHelper namespaces. |
vendor/bin/typo3 fluid:schema:generate |
Generate XSD schema files for all available ViewHelpers in var/transient/. |
form |
|
vendor/bin/typo3 form:cleanup:uploads |
Remove old form file upload folders based on retention period. |
vendor/bin/typo3 form:definition:transfer |
Transfer form definitions between storage backends |
impexp |
|
vendor/bin/typo3 impexp:export |
Exports a T3D / XML file with content of a page tree |
vendor/bin/typo3 impexp:import |
Imports a T3D / XML file with content into a page tree |
install |
|
vendor/bin/typo3 install:password:set |
|
language |
|
vendor/bin/typo3 language:domain:list |
Lists all translation domains and their label resource file locations. |
vendor/bin/typo3 language:domain:search |
Search for translation domain labels and their references (only for development purpose) |
vendor/bin/typo3 language:update |
Update the language files of all activated extensions |
lint |
|
vendor/bin/typo3 lint:yaml |
Lint a YAML file and outputs encountered errors |
mailer |
|
vendor/bin/typo3 mailer:spool:send |
Sends emails from the spool. |
messenger |
|
vendor/bin/typo3 messenger:consume |
Consume messages |
redirects |
|
vendor/bin/typo3 redirects:checkintegrity |
Check integrity of redirects |
vendor/bin/typo3 redirects:cleanup |
Cleanup old redirects periodically for given constraints like days, hit count or domains. |
referenceindex |
|
vendor/bin/typo3 referenceindex:update |
Update the reference index of TYPO3 |
scheduler |
|
vendor/bin/typo3 scheduler:execute |
Execute given TYPO3 Scheduler tasks. |
vendor/bin/typo3 scheduler:list |
List all TYPO3 Scheduler tasks. |
vendor/bin/typo3 scheduler:run |
Start the TYPO3 Scheduler from the command line. |
setup |
|
vendor/bin/typo3 setup:begroups:default |
Setup default backend user groups |
site |
|
vendor/bin/typo3 site:list |
Shows the list of sites available to the system. |
vendor/bin/typo3 site:sets:list |
Shows the list of available site sets. |
vendor/bin/typo3 site:show |
Shows the configuration of the specified site. |
syslog |
|
vendor/bin/typo3 syslog:list |
Show entries from the sys_log database table of the last 24 hours. |
upgrade |
|
vendor/bin/typo3 upgrade:list |
List available upgrade wizards. |
vendor/bin/typo3 upgrade:mark:undone |
Mark upgrade wizard as undone. |
vendor/bin/typo3 upgrade:run |
Run upgrade wizard. Without arguments all available wizards will be run. |
workspace |
|
vendor/bin/typo3 workspace:autopublish |
Publish a workspace with a publication date. |
vendor/bin/typo3 completion
-
vendor/bin/typo3 completion -
Dump the shell completion scriptUsage
vendor/bin/typo3 completion [--debug] [--] [<shell>]Copied!Arguments-
shell -
The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given
HelpThe
completioncommand dumps the shell completion script required to use shell autocompletion (currently, bash, fish, zsh completion are supported).Static installationDump the script to a global completion file and restart your shell:
vendor/vendor/bin/typo3 completion | sudo tee /etc/bash_completion.d/typo3Copied!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.shCopied!Dynamic installationAdd this to the end of your shell configuration file (e.g.
"~/.):bashrc" eval "$(/var/www/html/vendor/vendor/bin/typo3 completion )"Copied! -
vendor/bin/typo3 help
-
vendor/bin/typo3 help -
Display help for a commandUsage
vendor/bin/typo3 help [--format FORMAT] [--raw] [--] [<command_name>]Copied!Arguments-
command_name -
The command name
HelpThe
helpcommand displays help for a given command:vendor/vendor/bin/typo3 help listCopied!You can also output the help in other formats by using the
--option:format vendor/vendor/bin/typo3 help --format=xml listCopied!To display the list of available commands, please use the
listcommand. -
vendor/bin/typo3 list
-
vendor/bin/typo3 list -
List commandsUsage
vendor/bin/typo3 list [--raw] [--format FORMAT] [--short] [--] [<namespace>]Copied!Arguments-
namespace -
The namespace name
HelpThe
listcommand lists all commands:vendor/vendor/bin/typo3 listCopied!You can also display the commands for a specific namespace:
vendor/vendor/bin/typo3 list testCopied!You can also output the information in other formats by using the
--option:format vendor/vendor/bin/typo3 list --format=xmlCopied!It's also possible to get raw list of commands (useful for embedding command runner):
vendor/vendor/bin/typo3 list --rawCopied! -
vendor/bin/typo3 setup
-
vendor/bin/typo3 setup -
Setup TYPO3 via CLI using environment variables, CLI options or interactiveUsage
vendor/bin/typo3 setup [--driver [DRIVER]] [--host HOST] [--port [PORT]] [--dbname DBNAME] [--username USERNAME] [--password PASSWORD] [--admin-username [ADMIN-USERNAME]] [--admin-user-password ADMIN-USER-PASSWORD] [--admin-email ADMIN-EMAIL] [--project-name PROJECT-NAME] [--create-site CREATE-SITE] [--distribution [DISTRIBUTION]] [--server-type [SERVER-TYPE]] [--force] [-n|--no-interaction]Copied!Help- The command offers 3 ways to setup TYPO3:
-
- environment variables
- commandline options
- 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 --forceCopied!Warning
Variable
TYPO3_(optionDB_ PASSWORD --) can be used to provide a password for the database andpassword TYPO3_(optionSETUP_ ADMIN_ PASSWORD --) for the admin user password. Using this can be a security risk since the password may end up in shell history files. Prefer the interactive mode. Additionally, writing a command to shell history can be suppressed by prefixing the command with a space when usingadmin- user- password bashorzsh.
vendor/bin/typo3 asset:publish
vendor/bin/typo3 backend:lock
-
vendor/bin/typo3 backend:lock -
Lock the TYPO3 BackendUsage
vendor/bin/typo3 backend:lock [<redirect>]Copied!Arguments-
redirect -
If set, a locked TYPO3 Backend will redirect to URI specified with this argument. The URI is saved as a string in the lockfile that is specified in the system configuration.
HelpLock the TYPO3 Backend
-
vendor/bin/typo3 backend:resetpassword
-
vendor/bin/typo3 backend:resetpassword -
Trigger a password reset for a backend user.Usage
vendor/bin/typo3 backend:resetpassword <backendurl> <email>Copied!Arguments-
backendurl -
The URL of the TYPO3 Backend, e.g. https://www.example.com/typo3/
-
email -
The email address of a valid backend user
HelpTrigger a password reset for a backend user.
-
vendor/bin/typo3 backend:unlock
vendor/bin/typo3 backend:user:create
-
vendor/bin/typo3 backend:user:create -
Create a backend user.Usage
vendor/bin/typo3 backend:user:create [-u|--username USERNAME] [-p|--password PASSWORD] [-e|--email EMAIL] [-g|--groups GROUPS] [-l|--language LANGUAGE] [-a|--admin] [-m|--maintainer]Copied!HelpCreate 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-interactionCopied!Warning
Variable "TYPO3_BE_USER_PASSWORD" and options "-p" or "--password" can be used to provide a password. Using this can be a security risk since the password may end up in shell history files. Prefer the interactive mode. Additionally, writing a command to shell history can be suppressed by prefixing the command with a space when using
bashorzsh.
vendor/bin/typo3 cache:flush
vendor/bin/typo3 cache:flushtags
-
Flush TYPO3 caches with tags.Usage
vendor/bin/typo3 cache:flushtags [-g|--groups GROUPS] [--] <tags>Copied!Arguments-
Array of tags (specified as comma separated values) to flush.
HelpThis command can be used to clear the caches with specific tags, for example after code updates in local development and after deployments.
-
vendor/bin/typo3 cache:warmup
-
vendor/bin/typo3 cache:warmup -
Warmup TYPO3 caches.Usage
vendor/bin/typo3 cache:warmup [-g|--group [GROUP]]Copied!HelpThis command is useful for deployments to warmup caches during release preparation.
Warning
Cache warming does not work if the PHP version used to execute the command differs from the PHP version used in the web context.
See: Important: #107649 - Dependency Injection cache is now PHP version dependant
vendor/bin/typo3 cleanup:deletedrecords
-
vendor/bin/typo3 cleanup:deletedrecords -
Permanently deletes all records marked as "deleted" in the database.Usage
vendor/bin/typo3 cleanup:deletedrecords [-p|--pid PID] [-d|--depth DEPTH] [--dry-run] [-m|--min-age MIN-AGE]Copied!HelpTraverse page tree and find and flush deleted records. If you want to get more detailed information, use the --verbose option.
vendor/bin/typo3 cleanup:flexforms
vendor/bin/typo3 cleanup:localprocessedfiles
vendor/bin/typo3 cleanup:missingrelations
-
vendor/bin/typo3 cleanup:missingrelations -
Find all record references pointing to a non-existing recordUsage
vendor/bin/typo3 cleanup:missingrelations [--dry-run] [--update-refindex]Copied!HelpAssumptions: - 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.
vendor/bin/typo3 cleanup:orphanrecords
-
vendor/bin/typo3 cleanup:orphanrecords -
Find and delete records that have lost their connection with the page treeUsage
vendor/bin/typo3 cleanup:orphanrecords [--dry-run]Copied!HelpTYPO3 "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.
vendor/bin/typo3 cleanup:previewlinks
-
vendor/bin/typo3 cleanup:previewlinks -
Find all versioned records and possibly cleans up invalid records in the database.Usage
vendor/bin/typo3 cleanup:previewlinksCopied!HelpLook 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.
vendor/bin/typo3 cleanup:versions
-
vendor/bin/typo3 cleanup:versions -
Find all versioned records and possibly cleans up invalid records in the database.Usage
vendor/bin/typo3 cleanup:versions [-p|--pid PID] [-d|--depth DEPTH] [--dry-run] [--action [ACTION]]Copied!HelpTraverse 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.
vendor/bin/typo3 configuration:remove
-
vendor/bin/typo3 configuration:remove -
Remove configuration value(s) from system/settings.phpUsage
vendor/bin/typo3 configuration:remove [-f|--force] [--] <paths>Copied!Arguments-
paths -
Path(s) to remove, multiple paths can be separated by comma
HelpRemove 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
-
vendor/bin/typo3 configuration:set
-
vendor/bin/typo3 configuration:set -
Set a configuration value in system/settings.phpUsage
vendor/bin/typo3 configuration:set [--json] [--] <path> <value>Copied!Arguments-
path -
Path to the configuration value (e.g., SYS/sitename or BE/debug)
-
value -
Value to set
HelpSet 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/ my Feature true -- json
-
vendor/bin/typo3 configuration:show
-
vendor/bin/typo3 configuration:show -
Show configuration valueUsage
vendor/bin/typo3 configuration:show [-t|--type TYPE] [--json] [--] <path>Copied!Arguments-
path -
Path to the configuration value (e.g., SYS/sitename)
HelpShow 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
-
vendor/bin/typo3 content-blocks:assets:publish
vendor/bin/typo3 content-blocks:create
-
vendor/bin/typo3 content-blocks:create -
Create a Content BlockUsage
vendor/bin/typo3 content-blocks:create [--content-type [CONTENT-TYPE]] [--vendor [VENDOR]] [--name [NAME]] [--title [TITLE]] [--type-name [TYPE-NAME]] [--extension [EXTENSION]] [--skeleton-path [SKELETON-PATH]] [--config-path [CONFIG-PATH]]Copied!vendor/bin/typo3 make:content-blockCopied!HelpCreate a Content Block
vendor/bin/typo3 content-blocks:language:generate
-
vendor/bin/typo3 content-blocks:language:generate -
Update labels.xlf for the given Content BlockUsage
vendor/bin/typo3 content-blocks:language:generate [-p|--print] [-e|--extension EXTENSION] [--] [<content-block>]Copied!Arguments-
content-block -
The Content Block name to generate the language file for.
HelpUpdate labels.xlf for the given Content Block
-
vendor/bin/typo3 content-blocks:lint
vendor/bin/typo3 content-blocks:list
vendor/bin/typo3 debug:backend:modules
vendor/bin/typo3 debug:backend:routes
vendor/bin/typo3 extension:list
vendor/bin/typo3 extension:setup
-
vendor/bin/typo3 extension:setup -
Set up extensions and perform database migrations.Usage
vendor/bin/typo3 extension:setup [-e|--extension EXTENSION]Copied!HelpSetup 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.
vendor/bin/typo3 fluid:analyze
-
vendor/bin/typo3 fluid:analyze -
Analyzes Fluid templates for syntax errors and deprecated functionality.Usage
vendor/bin/typo3 fluid:analyze [--include-system-extensions] [--stdin] [--json]Copied!vendor/bin/typo3 fluid:analyseCopied!HelpAnalyzes Fluid templates for syntax errors and deprecated functionality.
vendor/bin/typo3 fluid:cache:warmup
vendor/bin/typo3 fluid:namespaces
vendor/bin/typo3 fluid:schema:generate
vendor/bin/typo3 form:cleanup:uploads
-
vendor/bin/typo3 form:cleanup:uploads -
Remove old form file upload folders based on retention period.Usage
vendor/bin/typo3 form:cleanup:uploads [-r|--retention-period RETENTION-PERIOD] [--dry-run] [-f|--force] [--] <upload-folder>...Copied!Arguments-
upload-folder -
Combined folder identifier(s) to scan (e.g. "1:/user_upload/").
HelpRemoves 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.
-
vendor/bin/typo3 form:definition:transfer
-
vendor/bin/typo3 form:definition:transfer -
Transfer form definitions between storage backendsUsage
vendor/bin/typo3 form:definition:transfer [--source SOURCE] [--target TARGET] [-l|--target-location TARGET-LOCATION] [-f|--form-identifier FORM-IDENTIFIER] [-m|--move] [--dry-run]Copied!HelpTransfers 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.
vendor/bin/typo3 impexp:export
-
vendor/bin/typo3 impexp:export -
Exports a T3D / XML file with content of a page treeUsage
vendor/bin/typo3 impexp:export [--type [TYPE]] [--pid [PID]] [--levels [LEVELS]] [--table [TABLE]] [--record [RECORD]] [--list [LIST]] [--include-related [INCLUDE-RELATED]] [--include-static [INCLUDE-STATIC]] [--exclude [EXCLUDE]] [--exclude-disabled-records] [--title [TITLE]] [--description [DESCRIPTION]] [--notes [NOTES]] [--dependency [DEPENDENCY]] [--save-files-outside-export-file] [--include-site-configurations] [--] [<filename>]Copied!Arguments-
filename -
The filename to export to (without file extension).
HelpExports a T3D / XML file with content of a page tree
-
vendor/bin/typo3 impexp:import
-
vendor/bin/typo3 impexp:import -
Imports a T3D / XML file with content into a page treeUsage
vendor/bin/typo3 impexp:import [--update-records] [--ignore-pid] [--force-uid] [--import-mode [IMPORT-MODE]] [--enable-log] [--] <file> [<pid>]Copied!Arguments-
file -
The file path to import from (.t3d or .xml).
-
pid -
The page to import to.
HelpImports a T3D / XML file with content into a page tree
-
vendor/bin/typo3 install:password:set
vendor/bin/typo3 language:domain:list
vendor/bin/typo3 language:domain:search
-
vendor/bin/typo3 language:domain:search -
Search for translation domain labels and their references (only for development purpose)Usage
vendor/bin/typo3 language:domain:search [-e|--extension [EXTENSION]] [-l|--locale [LOCALE]] [-s|--search [SEARCH]] [-r|--regex [REGEX]] [--idonly] [--limit [LIMIT]] [--crop [CROP]] [--flat] [--json]Copied!HelpThe 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
coreextension using a regular expression:vendor/vendor/bin/typo3 language:domain:search --extension core --regex "/cache|clear/i"
vendor/bin/typo3 language:update
-
vendor/bin/typo3 language:update -
Update the language files of all activated extensionsUsage
vendor/bin/typo3 language:update [--no-progress] [--fail-on-warnings] [--skip-extension SKIP-EXTENSION] [--] [<locales>...]Copied!Arguments-
locales -
Provide iso codes separated by space to update only selected language packs. Example `bin/typo3 language:update de ja`.
HelpUpdate the language files of all activated extensions
-
vendor/bin/typo3 lint:yaml
-
vendor/bin/typo3 lint:yaml -
Lint a YAML file and outputs encountered errorsUsage
vendor/bin/typo3 lint:yaml [--format FORMAT] [--exclude EXCLUDE] [--parse-tags|--no-parse-tags] [--] [<filename>...]Copied!Arguments-
filename -
A file, a directory or "-" for reading from STDIN
HelpThe
lint:command lints a YAML file and outputs to STDOUT the first encountered syntax error.yaml You can validates YAML contents passed from STDIN:
cat filename | php vendor/vendor/bin/typo3 lint:yaml -Copied!You can also validate the syntax of a file:
php vendor/vendor/bin/typo3 lint:yaml filenameCopied!Or of a whole directory:
php vendor/vendor/bin/typo3 lint:yaml dirnameCopied!The
--option specifies the format of the command output:format php vendor/vendor/bin/typo3 lint:yaml dirname --format=jsonCopied!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"Copied! -
vendor/bin/typo3 mailer:spool:send
vendor/bin/typo3 messenger:consume
-
vendor/bin/typo3 messenger:consume -
Consume messagesUsage
vendor/bin/typo3 messenger:consume [-l|--limit LIMIT] [-f|--failure-limit FAILURE-LIMIT] [-m|--memory-limit MEMORY-LIMIT] [-t|--time-limit TIME-LIMIT] [--sleep SLEEP] [-b|--bus BUS] [--queues QUEUES] [--all] [--keepalive [KEEPALIVE]] [--] [<receivers>...]Copied!Arguments-
receivers -
Names of the receivers/transports to consume in order of priority
HelpThe
messenger:command consumes messages and dispatches them to the message bus.consume 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 receiver2Copied!Use the --limit option to limit the number of messages received:
php vendor/vendor/bin/typo3 messenger:consume <receiver-name> --limit=10Copied!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=2Copied!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=128MCopied!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=3600Copied!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_busCopied!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=fasttrackCopied!Use the --all option to consume from all receivers:
php vendor/vendor/bin/typo3 messenger:consume --allCopied! -
vendor/bin/typo3 redirects:checkintegrity
vendor/bin/typo3 redirects:cleanup
-
vendor/bin/typo3 redirects:cleanup -
Cleanup old redirects periodically for given constraints like days, hit count or domains.Usage
vendor/bin/typo3 redirects:cleanup [-d|--domain [DOMAIN]] [-s|--statusCode [STATUSCODE]] [-a|--days [DAYS]] [-c|--hitCount [HITCOUNT]] [-p|--path [PATH]] [-t|--creationType [CREATIONTYPE]] [-i|--integrityStatus [INTEGRITYSTATUS]] [--redirectType [REDIRECTTYPE]]Copied!HelpCleanup old redirects periodically for given constraints like days, hit count or domains.
vendor/bin/typo3 referenceindex:update
vendor/bin/typo3 scheduler:execute
vendor/bin/typo3 scheduler:list
vendor/bin/typo3 scheduler:run
-
vendor/bin/typo3 scheduler:run -
Start the TYPO3 Scheduler from the command line.Usage
vendor/bin/typo3 scheduler:run [-i|--task [TASK]] [-f|--force] [-s|--stop]Copied!HelpIf 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
vendor/bin/typo3 setup:begroups:default
-
vendor/bin/typo3 setup:begroups:default -
Setup default backend user groupsUsage
vendor/bin/typo3 setup:begroups:default [-n|--no-interaction] [-g|--groups [GROUPS]] [-f|--force]Copied!HelpThe 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
vendor/bin/typo3 site:list
vendor/bin/typo3 site:sets:list
vendor/bin/typo3 site:show
vendor/bin/typo3 syslog:list
vendor/bin/typo3 upgrade:list
vendor/bin/typo3 upgrade:mark:undone
vendor/bin/typo3 upgrade:run
-
vendor/bin/typo3 upgrade:run -
Run upgrade wizard. Without arguments all available wizards will be run.Usage
vendor/bin/typo3 upgrade:run [<wizardName>]Copied!Arguments-
wizardName -
HelpThis 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.
-