joomlatools/joomla-console

This command-line script helps to ease the management of Joomla sites in your development environment.

, _(*1)

Joomlatools Console

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., _(*2)

Requirements

• PHP7.3 or newer
• Linux, MacOS, or Joomlatools Server
• Composer
• Joomla versions 3.5 and 4.x

Installation

1. Install using Composer:, _(*3)

   $ composer global require joomlatools/console, _(*4)

2. 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., _(*5)

   $ export PATH="$PATH:~/.composer/vendor/bin", _(*6)

   For Ubuntu 19+ you may find you should use:, _(*7)

export PATH="$PATH:$HOME/.config/composer/vendor/bin", _(*8)

1. Verify the installation, _(*9)

   $ joomla --version, _(*10)

2. To create a new site with the latest Joomla version, run:, _(*11)

    joomla site:create testsite
   

   The 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., _(*12)

   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:, _(*13)

    joomla site:create testsite --release=4.0 --sample-data=blog
   

3. For other available options, run:, _(*14)

   $ joomla --list, _(*15)

4. Read our documentation pages to learn more about using the tool., _(*16)

Development

To setup the tool for development:, _(*17)

1. Clone the repository:

git clone git@github.com:joomlatools/joomlatools-console.git

1. Fetch the dependencies:

composer install

1. Now you can execute the tool with:

bin/joomla list

1. Happy coding!

Contributing

Joomlatools Console is an open source, community-driven project. Contributions are welcome from everyone. We have contributing guidelines to help you get started., _(*18)

Contributors

See the list of contributors., _(*19)

License

Joomlatools Console is free and open-source software licensed under the MPLv2 license., _(*20)

Community

Keep track of development and community news., _(*21)

• Follow @joomlatoolsdev on Twitter
• Join joomlatools/dev on Gitter
• Read the Joomlatools Developer Blog
• Subscribe to the Joomlatools Developer Newsletter