Site

site:checkin

Checks in all of the database tables of a site

Syntax

joomla site:checkin [--www WWW] [--user-column USER-COLUMN] [--date-column DATE-COLUMN] [--] <site> [<tables>]...

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

tables

A list of tables to check in

Options

--www=<value>

Web server root

Default: /var/www

--user-column=<value>

The check in user column name

Default: checked_out

--date-column=<value>

The check in date column name

Default: checked_out_time

site:configure

Configure a Joomla site

Syntax

joomla site:configure [--www WWW] [-L|--mysql-login MYSQL-LOGIN] [-H|--mysql-host MYSQL-HOST] [-P|--mysql-port MYSQL-PORT] [--mysql_db_prefix MYSQL_DB_PREFIX] [-db|--mysql-database MYSQL-DATABASE] [--mysql-driver MYSQL-DRIVER] [--overwrite] [--interactive] [--options OPTIONS] [--] <site>

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

Options

--www=<value>

Web server root

Default: /var/www

--mysql-login=<value> , -L=<value>

MySQL credentials in the form of user:password

Default: root:root

--mysql-host=<value> , -H=<value>

MySQL host

Default: localhost

--mysql-port=<value> , -P=<value>

MySQL port

Default: 3306

--mysql_db_prefix=<value>

MySQL database prefix

Default: sites_

--mysql-database=<value> , -db=<value>

MySQL database name. If set, the --mysql_db_prefix option will be ignored.

--mysql-driver=<value>

MySQL driver

Default: mysqli

--overwrite

Overwrite configuration.php or .env file if it already exists

--interactive

Prompt for configuration details

--options=<value>

A YAML file consisting of serialized parameters to override JConfig

site:create

Create a new Joomla site from scratch

Syntax

joomla site:create [--www WWW] [-L|--mysql-login MYSQL-LOGIN] [-H|--mysql-host MYSQL-HOST] [-P|--mysql-port MYSQL-PORT] [--mysql_db_prefix MYSQL_DB_PREFIX] [-db|--mysql-database MYSQL-DATABASE] [--mysql-driver MYSQL-DRIVER] [--release RELEASE] [--sample-data SAMPLE-DATA] [--symlink SYMLINK] [--repo REPO] [--clear-cache] [--projects-dir PROJECTS-DIR] [--http-port HTTP-PORT] [--disable-ssl] [--ssl-crt SSL-CRT] [--ssl-key SSL-KEY] [--ssl-port SSL-PORT] [--interactive] [--options OPTIONS] [--clone [CLONE]] [--] <site>

To create a site with the latest Joomla version, run: joomla site:create foobar The newly installed site will be available at /var/www/foobar and foobar.test after that. You can login into your fresh Joomla installation using these credentials: admin/admin. By default, the web server root is set to /var/www. You can pass –www=/my/server/path to commands for custom values. The console can also install the Joomlatools Platform out of the box by adding the --repo=platform flag: joomla site:create joomlatools-platform --repo=platform You can choose the Joomla version or the sample data to be installed. A more elaborate example: joomla site:create testsite --release=2.5 --sample-data=blog

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

Options

--www=<value>

Web server root

Default: /var/www

--mysql-login=<value> , -L=<value>

MySQL credentials in the form of user:password

Default: root:root

--mysql-host=<value> , -H=<value>

MySQL host

Default: localhost

--mysql-port=<value> , -P=<value>

MySQL port

Default: 3306

--mysql_db_prefix=<value>

MySQL database prefix

Default: sites_

--mysql-database=<value> , -db=<value>

MySQL database name. If set, the --mysql_db_prefix option will be ignored.

--mysql-driver=<value>

MySQL driver

Default: mysqli

--release=<value>

Joomla version. Can be a release number (2, 3.2, ..) or branch name. Run joomla versions for a full list. Use "none" for an empty virtual host.

Default: latest

--sample-data=<value>

Sample data to install (default|blog|brochure|learn|testing)

--symlink=<value>

A comma separated list of directories to symlink from the projects directory. Use 'all' to symlink every folder.

--repo=<value>

Alternative Git repository to use. Also accepts a gzipped tar archive instead of a Git repository. To use joomlatools/platform, use --repo=platform. For Kodekit Platform, use --repo=kodekit-platform.

--clear-cache

Update the list of available tags and branches from the Joomla repository

--projects-dir=<value>

Directory where your custom projects reside

Default: /home/vagrant/Projects

--http-port=<value>

The HTTP port the virtual host should listen to

Default: 80

--disable-ssl

Disable SSL for this site

--ssl-crt=<value>

The full path to the signed cerfificate file

Default: /etc/apache2/ssl/server.crt

--ssl-key=<value>

The full path to the private cerfificate file

Default: /etc/apache2/ssl/server.key

--ssl-port=<value>

The port on which the server will listen for SSL requests

Default: 443

--interactive

Prompt for configuration details

--options=<value>

A YAML file consisting of serialized parameters to override JConfig.

--clone=<value>

Clone the Git repository instead of creating a copy in the target directory. Use --clone=shallow for a shallow clone or leave empty.

Default: 1

site:delete

Delete a site

Syntax

joomla site:delete [--www WWW] [-L|--mysql-login MYSQL-LOGIN] [-H|--mysql-host MYSQL-HOST] [-P|--mysql-port MYSQL-PORT] [--mysql_db_prefix MYSQL_DB_PREFIX] [-db|--mysql-database MYSQL-DATABASE] [--mysql-driver MYSQL-DRIVER] [--skip-database] [--skip-vhost] [--] <site>

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

Options

--www=<value>

Web server root

Default: /var/www

--mysql-login=<value> , -L=<value>

MySQL credentials in the form of user:password

Default: root:root

--mysql-host=<value> , -H=<value>

MySQL host

Default: localhost

--mysql-port=<value> , -P=<value>

MySQL port

Default: 3306

--mysql_db_prefix=<value>

MySQL database prefix

Default: sites_

--mysql-database=<value> , -db=<value>

MySQL database name. If set, the --mysql_db_prefix option will be ignored.

--mysql-driver=<value>

MySQL driver

Default: mysqli

--skip-database

Leave the database intact

--skip-vhost

Leave the virtual host intact

site:deploy

Deploy your website with git-ftp

Syntax

joomla site:deploy [--www WWW] [-U|--user USER] [-P|--password [PASSWORD]] [--] <site> <server>

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

server

FTP server to deploy to. You can add a different port or subdirectory. Example: ftp://ftp.domain.com:21/httpdocs

Options

--www=<value>

Web server root

Default: /var/www

--user=<value> , -U=<value>

FTP user

Default: vagrant

--password=<value> , -P=<value>

FTP password. Omit for interactive password prompt.

site:download

Download and extract the given Joomla version

Syntax

joomla site:download [--www WWW] [--release RELEASE] [--refresh] [--clear-cache] [--repo REPO] [--clone [CLONE]] [--] <site>

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

Options

--www=<value>

Web server root

Default: /var/www

--release=<value>

Joomla version. Can be a release number (2, 3.2, ..) or branch name. Run joomla versions for a full list. Use "none" for an empty virtual host.

Default: latest

--refresh

Update the list of available tags and branches from the Joomla repository

--clear-cache

Clear the downloaded files cache

--repo=<value>

Alternative Git repository to clone. Also accepts a gzipped tar archive instead of a Git repository. To use joomlatools/platform, use --repo=platform. For Kodekit Platform, use --repo=kodekit-platform.

--clone=<value>

Clone the Git repository instead of creating a copy in the target directory. Use --clone=shallow for a shallow clone or leave empty.

Default: 1

site:install

Install an existing Joomla codebase. Sets up configuration and installs the database.

Syntax

joomla site:install [--www WWW] [-L|--mysql-login MYSQL-LOGIN] [-H|--mysql-host MYSQL-HOST] [-P|--mysql-port MYSQL-PORT] [--mysql_db_prefix MYSQL_DB_PREFIX] [-db|--mysql-database MYSQL-DATABASE] [--mysql-driver MYSQL-DRIVER] [--sample-data SAMPLE-DATA] [--overwrite] [-d|--drop] [--symlink SYMLINK] [--projects-dir PROJECTS-DIR] [--interactive] [-e|--skip-exists-check] [--options OPTIONS] [--] <site>

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

Options

--www=<value>

Web server root

Default: /var/www

--mysql-login=<value> , -L=<value>

MySQL credentials in the form of user:password

Default: root:root

--mysql-host=<value> , -H=<value>

MySQL host

Default: localhost

--mysql-port=<value> , -P=<value>

MySQL port

Default: 3306

--mysql_db_prefix=<value>

MySQL database prefix

Default: sites_

--mysql-database=<value> , -db=<value>

MySQL database name. If set, the --mysql_db_prefix option will be ignored.

--mysql-driver=<value>

MySQL driver

Default: mysqli

--sample-data=<value>

Sample data to install (default|blog|brochure|learn|testing)

--overwrite

Overwrite configuration.php if it already exists

--drop , -d

Drop database if it already exists

--symlink=<value>

A comma separated list of directories to symlink from the projects directory. Use 'all' to symlink every folder.

--projects-dir=<value>

Directory where your custom projects reside

Default: /home/vagrant/Projects

--interactive

Prompt for configuration details

--skip-exists-check , -e

Do not check if database already exists or not.

--options=<value>

A YAML file consisting of serialized parameters to override JConfig.

site:list

List Joomla sites

Syntax

joomla site:list [--format [FORMAT]] [--www WWW]

List Joomla sites running on this box

Options

--format=<value>

The output format (txt or json)

Default: txt

--www=<value>

Web server root

Default: /var/www

site:token

Generate a login token for a user name to be used for JWT authentication

Syntax

joomla site:token [--www WWW] [--] <site> <username>

Add the token to your query string such as ?auth_token=TOKEN and the given user will be automatically logged in

Arguments

site

Alphanumeric site name. Also used in the site URL with .test domain

username

User name to generate the token for

Options

--www=<value>

Web server root

Default: /var/www