Joomlatools Console simplifies the management of Joomla sites. It is designed to work on Linux and MacOS. Windows users can use it in Joomlatools Server.
- PHP7.3 or newer
- Linux, MacOS, or Joomlatools Server
- Composer
- Joomla 3.1 or newer
- Install using Composer:
$ composer global require joomlatools/console
- Tell your system where to find the executable by adding the composer directory to your PATH. Add the following line to your shell configuration file called either .profile, .bash_profile, .bash_aliases, or .bashrc. This file is located in your home folder.
$ export PATH="$PATH:~/.composer/vendor/bin"
For Ubuntu 19+ you may find you should use:
export PATH="$PATH:$HOME/.config/composer/vendor/bin"
- Verify the installation
$ joomla --version
- To create a new site with the latest Joomla version, run:
joomla site:create testsiteThe newly installed site will be available at /var/www/testsite and testsite.test after that. The default Super User's name and password is set to: 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. You can choose the Joomla version or the sample data to be installed:
joomla site:create testsite --release=4.0 --sample-data=blog- For other available options, run:
$ joomla --list
- Read our documentation pages to learn more about using the tool.
Every command accepts two hooks: --preflight, run before the command, and
--postflight, run after it succeeds. Placeholders written as %name% are
replaced with the arguments and options the command was called with, and the
substituted values are shell escaped.
joomla site:create legacysite --release=3.10.12 --postflight="my-script %site%"Like any other option they can be set per command in config.yaml, so they do
not have to be typed every time:
site:create:
postflight: my-script %site% %www%Useful placeholders: %site% (the site name), %www% (the web server root) and
%root% (the site's document root). Chaining with && works, since only the
substituted values are escaped, not the surrounding string.
The two hooks treat failure differently, on purpose:
- preflight is a gate. A non-zero exit aborts the command before it runs and
becomes the command's exit status — the same way a
preflight()in a Joomla installer script aborts an install. Being able to say no is the point. - postflight is a follow-up. A non-zero exit is reported but does not change the command's exit status, because the command itself succeeded.
postflight runs once the command has completely finished, not partway through.
For site:create that matters: the virtual host is written well before the CMS
is installed, so a hook attached any earlier would see a half-populated site.
Note that %root% is only available to postflight. The site directory is
resolved while the command runs, so it is not yet known at preflight time.
To setup the tool for development:
- Clone the repository:
git clone git@github.com:joomlatools/joomlatools-console.git
- Fetch the dependencies:
composer install
- Now you can execute the tool with:
bin/joomla list
- Happy coding!
Joomlatools Console is an open source, community-driven project. Contributions are welcome from everyone. We have contributing guidelines to help you get started.
See the list of contributors.
Joomlatools Console is free and open-source software licensed under the MPLv2 license.
Keep track of development and community news.
- Follow @joomlatoolsdev on Twitter
- Join joomlatools/dev on Gitter
- Read the Joomlatools Developer Blog
- Subscribe to the Joomlatools Developer Newsletter