Global commands 

Command Description 
bin/typo3 list
 List commands 
bin/typo3 setup
 Setup TYPO3 via CLI using environment variables, CLI options or interactive

bin/typo3 list

bin/typo3 list Back to list
List commands
Usage
bin/typo3 list [--raw] [--format FORMAT] [--short] [--] [<namespace>]
Copied!
Arguments

namespace

namespace
The namespace name
Options

--raw

--raw
To output raw command list
Value
None allowed
Default value
false

--format

--format
The output format (txt, xml, json, or md)
Value
Required
Default value
"txt"

--short

--short
To skip describing commands' arguments
Value
None allowed
Default value
false
Help

The list command lists all commands:

bin/typo3 list
Copied!

You can also display the commands for a specific namespace:

bin/typo3 list test
Copied!

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

bin/typo3 list --format=xml
Copied!

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

bin/typo3 list --raw
Copied!

bin/typo3 setup

bin/typo3 setup Back to list
Setup TYPO3 via CLI using environment variables, CLI options or interactive
Usage
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]] [--server-type [SERVER-TYPE]] [--force] [-n|--no-interaction]
Copied!
Options

--driver

--driver
Select which database driver to use
Value
Optional

--host

--host
Set the database host to use
Value
Required
Default value
"db"

--port

--port
Set the database port to use
Value
Optional
Default value
"3306"

--dbname

--dbname
Set the database name to use
Value
Required
Default value
"db"

--username

--username
Set the database username to use
Value
Required
Default value
"db"

--password

--password
Set the database password to use
Value
Required

--admin-username

--admin-username
Set a username
Value
Optional
Default value
"admin"

--admin-user-password

--admin-user-password
Set users password
Value
Required

--admin-email

--admin-email
Set users email
Value
Required
Default value
""

--project-name

--project-name
Set the TYPO3 project name
Value
Required
Default value
"New TYPO3 Project"

--create-site

--create-site
Create a basic site setup (root page and site configuration) with the given domain
Value
Optional
Default value
false

--server-type

--server-type
Define the web server the TYPO3 installation will be running on
Value
Optional
Default value
"other"

--force

--force
Force settings overwrite - use this if TYPO3 has been installed already
Value
None allowed
Default value
false
Help
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" \
./bin/typo3 setup --force
Copied!