TYPO3 Console provides a clean way to register commands and
a sane way to call these commands through a command line tool called
It ships many commands to execute TYPO3 actions, which otherwise would only be accessible via the TYPO3 backend. This makes TYPO3 Console a perfect companion for development, deployment, Docker setups, continuous integration workflows or anything else where automation is required or beneficial.
Examples for such commands are:
typo3cms install:setupto completely set up TYPO3 from command line
typo3cms upgrade:allto execute upgrades from command line
typo3cms extension:setupactiveto set up all active extensions (database schema update, data import, …)
- TYPO3 installation and upgrades from command line
- Flexible bootstrap for commands (not every command needs a fully bootstrapped framework)
- Reliable cache flush commands
- Many commands useful for deployment
- Support for command controllers and Symfony commands registered within TYPO3 extensions and Composer packages
Installation using Composer
The recommended way to install TYPO3 Console is by using Composer:
composer require helhum/typo3-console
typo3cms binary will be installed by Composer in the specified
bin-dir (by default
TYPO3 Console is a perfect companion for Composer-based, enjoyable TYPO3 projects.
Installation as extension from TYPO3 Extension Repository (TER)
Download and install the extension with the Extensions module.
For the extension to work, it must be installed in the
typo3conf/ext directory not in any other extension location.
This directory must not be a symlink to another location!
typo3cms command line tool will be copied into the installation root directory during activation.
Submit bug reports or feature requests
Look at the Issues for what has been planned to be implemented in the (near) future.
Thanks to all contributors and everybody providing feedback.