Joomla! Documentation - User contributions [en]

J4.x:CLI Update

2018-09-12T10:04:28Z

Bosunski:

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
<translate> CLI Update Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It is a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.</translate>

<translate>
===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Updates Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate> 
<tt>php cli/joomla.php check-updates</tt>
 
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:Check updates.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate> 
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate> 
<tt>php cli/joomla.php core:update</tt> 
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate> 
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate> 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate> 
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>
====Configuration based commands==== 
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate> 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate> 
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla! sitename="Joomla Site"</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate> 
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate> 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>
==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
*Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-08-04T21:28:13Z

Bosunski:

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
<translate> CLI Update Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.</translate>

<translate>
===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Updates Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate> 
<tt>php cli/joomla.php check-updates</tt>
 
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:Check updates.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate> 
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate> 
<tt>php cli/joomla.php core:update</tt> 
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate> 
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate> 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate> 
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>==== 
Configuration based commands====
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate> 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate> 
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate> 
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate> 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>
==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
*Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Check updates.png

2018-08-04T21:26:52Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-08-04T21:16:07Z

Bosunski:

<noinclude><languages /></noinclude>
{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
<translate> CLI Update Documentation</translate>}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

<translate>
== Introduction == 
</translate>
<translate> Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.</translate>

<translate> This documentation shows how the CLI Update can be used and how you can extend its functionality as a developer.</translate>

<translate>
===Requirements=== 
</translate>
<translate>
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.</translate>

<translate>
===Terms and definitions=== 
</translate>
*CLI - Command Line Interface
*SSH - Secure SHell

<translate>
==Using the CLI Update== 
</translate>
<translate> In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.</translate>
[[File:All commands.png|center|800px]]

<translate>
==General Command Usage== 
</translate>
<translate> In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.</translate>

<translate>
===Available commands=== 
</translate>
<translate> There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.</translate>

<translate>
====Checking for Updates Updates==== 
</translate>
<translate> The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory:</translate> 
<tt>php cli/joomla.php check-updates</tt>
 
<translate> The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.</translate>
[[File:CheckCheck.png|center|800px]]

<translate>
====Extension commands==== 
</translate>
<translate> The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.</translate>

<translate>
======Listing installed extensions====== 
</translate>
<translate> This command allows us to list all installed extensions. This command can run in two different ways which are:</translate>
*<translate> ''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:</translate>{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*<translate> ''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done:</translate> {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
<translate> This will list out only language based extensions, you can specify type as module, plugin and component as well.</translate>

<translate>
======Installing an Extension====== 
</translate>
<translate> Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.</translate>
*<translate> ''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.</translate>
{{-}}[[File:Extension install url.png|center|800px]]
*<translate> ''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:</translate>{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt> {{-}}[[File:Extension install path.png|center|800px]]
<translate> This loads the extension and performs the installation as expected.</translate>

<translate>
======Removing an extension====== 
</translate>
<translate> The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt></translate> 
<tt>php cli/joomla.php extension:remove 803</tt>
[[File:Extension Remove.png|center|800px]]

<translate>
====Updating the Joomla Core==== 
</translate>
<translate> As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this:</translate> 
<tt>php cli/joomla.php core:update</tt> 
<translate> This command updates the Joomla core updating it to the latest version available.</translate>

[[File:Core update.png|center|800px]]

<translate>
====Installing Joomla! via the CLI==== 
</translate>
<translate> The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.</translate>

<translate>
=====Interactive installation===== 
</translate>
<translate> To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so:</translate> 
<tt>php cli/joomla.php extension:install</tt>

<translate> The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.</translate>

[[File:Core install interactive.png|center|800px]]

<translate>
=====Non-interactive Installation===== 
</translate>
<translate> The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this:</translate> 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

<translate> An example of the contents of <tt>config.json</tt> can be:</translate> 
<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

<translate> OR as sample</translate> <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

<translate> The options defined are loaded and validated after which the installation will run.</translate>

<translate>==== 
Configuration based commands====
</translate>
<translate> The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:</translate>

<translate>
=====Setting configurations===== 
</translate>
<translate> The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command:</translate> 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

<translate> You can even add multiple option-value pairs like this:</translate> 
<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>
<translate>

This will set multiple options at once.</translate>

[[File:Config set multiple.png|center|800px]]

<translate>
=====Getting configurations===== 
</translate>
<translate> The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command:</translate> 
<tt>php cli/joomla.php config:get sitename</tt>

<translate> This will return the value for the option <tt>sitename</tt>.</translate>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

<translate> This will return all the values for the available options.</translate>

[[File:Config get all.png|center|800px]]

<translate>
=====Getting grouped configurations===== 
</translate>
<translate> The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:</translate>

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

<translate> The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.</translate>

<translate>
====Site down and Site up commands==== 
</translate>
<translate> As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands:</translate> 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

<translate> The second command puts the website in offline mode while the first command brings the website to online mode.</translate>

<translate>
==Contributing to CLI Update as a developer== 
</translate>

<translate>
===Adding more commands=== 
</translate>
<translate> The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.</translate>

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

<translate>
===Calling other commands within command classes=== 
</translate>
<translate> Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:</translate>

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<translate> Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.</translate>

<translate>
===Some important things to checkout=== 
</translate>
*Symfony Style Documentation: [https://symfony.com/doc/current/console/style.html How to Style a Console Command]

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Core update.png

2018-08-04T21:08:40Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-08-01T20:49:07Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

[[File:Core install interactive.png|center|800px]]

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

===Calling other commands within command classes===
Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

Here, we're attempting to call the <tt>say:hello</tt> command created in the Video above.
===Some important things to checkout===
Symfony Style Documentation here [https://symfony.com/doc/current/console/style.html]
<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-08-01T15:24:05Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

[[File:Core install interactive.png|center|800px]]

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

===Calling other commands within command classes===
Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

===Some important things to checkout===
Symfony Style Documentation here [https://symfony.com/doc/current/console/style.html]
<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Core install interactive.png

2018-08-01T15:21:27Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-08-01T15:01:39Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

===Calling other commands within command classes===
Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

===Some important things to checkout===
Symfony Style Documentation here [https://symfony.com/doc/current/console/style.html]
<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-08-01T14:54:34Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

===Calling other commands within command classes===
Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

if($code === 0) {
// command ran successfully, do something
}
}

...
}
</source>

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-08-01T14:50:08Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

===Calling other commands within command classes===
Should in case a command you want to write for the CLI Update is going to be require that you call an existing command internally, this is how that can be achieved from within another command class:

<source lang="php">
<?php
class RunHelloCommand extends AbstractCommand {
...

public function execute(): int {
$command = $this->getApplication()->getCommand('say:hello');
$code = $command->execute();

}

...
}
</source>

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-07-31T21:19:23Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
The CLI Update ships with some commands which are added based on the need seen as of the time. However, the CLI Update allows other commands to be added easily and this is what this section is for. A video tutorial is included below.

<div class="video-container">
{{#widget:YouTube|id=gcJJtTcPiTg}}
</div>

===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-07-30T21:39:27Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

[[File:All commands.png|center|800px]]

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==

===Adding more commands===

===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:All commands.png

2018-07-30T21:37:33Z

Bosunski:

J4.x:CLI Update

2018-07-30T21:16:56Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

[[File:CheckCheck.png|center|800px]]

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==

===Adding more commands===

===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:CheckCheck.png

2018-07-30T21:07:01Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-07-30T21:01:37Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

[[File:Core install file.png|center|800px]]

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==

===Adding more commands===

===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Core install file.png

2018-07-30T21:00:10Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-07-30T20:53:33Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>

[[File:Extension list.png|center|800px]]

*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>

[[File:Extension list type.png|center|800px]]

This will list out only language based extensions, you can specify type as module, plugin and component as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/Users/bosunski/docs/com_pathtester.zip</tt>

[[File:Extension install path.png|center|800px]]

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

[[File:Config set single.png|center|800px]]

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

[[File:Config get all.png|center|800px]]

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==

===Adding more commands===

===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Config get all.png

2018-07-30T20:51:56Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Config set single.png

2018-07-30T20:48:16Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Extension install path.png

2018-07-30T20:43:29Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Extension list type.png

2018-07-30T20:40:45Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Extension list.png

2018-07-30T20:34:32Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-07-30T07:35:48Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.

===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.

===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%

==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.

===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.

====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.

====Extension commands====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.

======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*''General Listing'': Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command:{{-}}<tt>php cli/joomla.php extension:list</tt/>
*''Listing By types'': General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: {{-}}<tt>php cli/joomla.php extension:list --type=component</tt>

This will list out only component based extensions, you can specify type as module, plugin and language as well.

======Installing an Extension======
Joomla provides installing an extension through an URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*''Installing from URL'': To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command.{{-}}<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>{{-}}This will download the <tt>com_patchtester</tt> extension.
{{-}}[[File:Extension install url.png|center|800px]]
*''Installing from a PATH'':To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this:{{-}}<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected.

======Removing an extension======
The last command under this category is the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 
<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|800px]]

====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla core updating it to the latest version available.

====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.

=====Interactive installation=====
To have a fresh installation of Joomla using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode will run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla will be installed.

=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode. In this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 
<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.

====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla installation:

=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.

[[File:Config set multiple.png|center|800px]]

=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 
<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|800px]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the available options.

=====Getting grouped configurations=====
The CLI Update adds an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provides an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

[[File:Config get group.png|center|800px]]

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As their name suggests, these commands allow you to quickly put your Joomla powered website into offline or online mode. Here is how to use the commands: 
<tt>php cli/joomla.php site:up</tt>

[[File:Site up.png|center|800px]]

<tt>php cli/joomla.php site:down</tt>

[[File:Site down.png|center|800px]]

The second command puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==

===Adding more commands===

===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Config set multiple.png

2018-07-30T07:31:47Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Site down.png

2018-07-30T07:30:22Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Site up.png

2018-07-30T07:29:35Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Config get group.png

2018-07-30T07:27:12Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-07-29T12:50:16Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.
===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.
===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell
==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%
==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.
===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.
====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.
====Extension commands:====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.
======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*General Listing
Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command: 
<tt>php cli/joomla.php extension:list</tt/>
 
*Listing By types
General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: 
<tt>php cli/joomla.php extension:list --type=component</tt>
 

This will list out only component based extensions, you can specify type as module, plugin and language as well.
======Installing an Extension======
Joomla! provides installing an extension through a URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*Installing from URL
To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command. 
<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>

This will download the <tt>com_patchtester</tt> extension.

[[File:Extension install url.png|center|Quick Icon]]

*Installing from a PATH
To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this: 
<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected
======Removing an extension======
The last command under this category is the the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla! CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>803</tt> 

<tt>php cli/joomla.php extension:remove 803</tt>

[[File:Extension Remove.png|center|Quick Icon]]
====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla! core updating it to the latest version available
====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla! CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.
=====Interactive installation=====
To have a fresh installation of Joomla! using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode with run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla! will be installed.
=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode, in this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 

<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.
====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla! installation:
=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.
=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 

<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|Quick Icon]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the options available.

=====Getting grouped configurations=====
The CLI Update added an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provide an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As thier name suggests, these commands allows you to quickly put your Joomla! powered website into offline or online mode. Here is how to use the commands: 

<tt>php cli/joomla.php site:up</tt>

<tt>php cli/joomla.php site:down</tt>

The second one puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-07-29T12:47:29Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.
===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.
===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell
==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%
==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.
===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.
====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.
====Extension commands:====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.
======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*General Listing
Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command: 
<tt>php cli/joomla.php extension:list</tt/>
 
*Listing By types
General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: 
<tt>php cli/joomla.php extension:list --type=component</tt>
 

This will list out only component based extensions, you can specify type as module, plugin and language as well.
======Installing an Extension======
Joomla! provides installing an extension through a URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*Installing from URL
To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command. 
<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>

This will download the <tt>com_patchtester</tt> extension.

[[File:Extension install url.png|center|Quick Icon]]

*Installing from a PATH
To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this: 
<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected
======Removing an extension======
The last command under this category is the the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla! CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>802</tt>
====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla! core updating it to the latest version available
====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla! CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.
=====Interactive installation=====
To have a fresh installation of Joomla! using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode with run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla! will be installed.
=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode, in this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 

<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.
====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla! installation:
=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.
=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 

<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|Quick Icon]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the options available.

=====Getting grouped configurations=====
The CLI Update added an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provide an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As thier name suggests, these commands allows you to quickly put your Joomla! powered website into offline or online mode. Here is how to use the commands: 

<tt>php cli/joomla.php site:up</tt>

<tt>php cli/joomla.php site:down</tt>

The second one puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:Extension Remove.png

2018-07-29T12:46:55Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Extension install url.png

2018-07-29T12:39:59Z

Bosunski:

== Licensing ==
{{LGPL}}

J4.x:CLI Update

2018-07-29T12:35:43Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.
===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.
===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell
==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%
==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.
===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.
====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.
====Extension commands:====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.
======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*General Listing
Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command: 
<tt>php cli/joomla.php extension:list</tt/>
 
*Listing By types
General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: 
<tt>php cli/joomla.php extension:list --type=component</tt>
 

This will list out only component based extensions, you can specify type as module, plugin and language as well.
======Installing an Extension======
Joomla! provides installing an extension through a URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*Installing from URL
To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command. 
<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>

This will download the <tt>com_patchtester</tt> extension.
*Installing from a PATH
To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this: 
<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected
======Removing an extension======
The last command under this category is the the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla! CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>802</tt>
====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla! core updating it to the latest version available
====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla! CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.
=====Interactive installation=====
To have a fresh installation of Joomla! using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode with run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla! will be installed.
=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode, in this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 

<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.
====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla! installation:
=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.
=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 

<tt>php cli/joomla.php config:get sitename</tt>

This will return the value for the option <tt>sitename</tt>

[[File:011-cli.png|center|Quick Icon]]

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the options available.

=====Getting grouped configurations=====
The CLI Update added an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provide an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As thier name suggests, these commands allows you to quickly put your Joomla! powered website into offline or online mode. Here is how to use the commands: 

<tt>php cli/joomla.php site:up</tt>

<tt>php cli/joomla.php site:down</tt>

The second one puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-07-29T12:24:44Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.
===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.
===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell
==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%
==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.
===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.
====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.
====Extension commands:====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.
======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*General Listing
Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command: 
<tt>php cli/joomla.php extension:list</tt/>
 
*Listing By types
General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: 
<tt>php cli/joomla.php extension:list --type=component</tt>
 

This will list out only component based extensions, you can specify type as module, plugin and language as well.
======Installing an Extension======
Joomla! provides installing an extension through a URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*Installing from URL
To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command. 
<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>

This will download the <tt>com_patchtester</tt> extension.
*Installing from a PATH
To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this: 
<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected
======Removing an extension======
The last command under this category is the the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla! CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>802</tt>
====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla! core updating it to the latest version available
====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla! CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.
=====Interactive installation=====
To have a fresh installation of Joomla! using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode with run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla! will be installed.
=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode, in this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 

<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.
====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla! installation:
=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.
=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 

<tt>php cli/joomla.php config:get mailer</tt>

This will return the value for the option <tt>mailer</tt>

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the options available.

[[File:011-cli.png|center|Quick Icon]]

=====Getting grouped configurations=====
The CLI Update added an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provide an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As thier name suggests, these commands allows you to quickly put your Joomla! powered website into offline or online mode. Here is how to use the commands: 

<tt>php cli/joomla.php site:up</tt>

<tt>php cli/joomla.php site:down</tt>

The second one puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

File:011-cli.png

2018-07-29T11:24:10Z

Bosunski:

== Licensing ==
{{LGPL}}

File:Config get single.png

2018-07-29T00:23:26Z

Bosunski:

== Licensing ==
{{GFDL}}

J4.x:CLI Update

2018-07-29T00:20:53Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.
===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.
===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell
==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%
==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.
===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.
====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.
====Extension commands:====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.
======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*General Listing
Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command: 
<tt>php cli/joomla.php extension:list</tt/>
 
*Listing By types
General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: 
<tt>php cli/joomla.php extension:list --type=component</tt>
 

This will list out only component based extensions, you can specify type as module, plugin and language as well.
======Installing an Extension======
Joomla! provides installing an extension through a URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*Installing from URL
To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command. 
<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>

This will download the <tt>com_patchtester</tt> extension.
*Installing from a PATH
To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this: 
<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected
======Removing an extension======
The last command under this category is the the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla! CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>802</tt>
====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla! core updating it to the latest version available
====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla! CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.
=====Interactive installation=====
To have a fresh installation of Joomla! using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode with run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla! will be installed.
=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode, in this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 

<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.
====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla! installation:
=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.
=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 

<tt>php cli/joomla.php config:get mailer</tt>

This will return the value for the option <tt>mailer</tt>

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the options available.

=====Getting grouped configurations=====
The CLI Update added an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provide an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports group values: mail, db and session.

====Site down and Site up commands====
As thier name suggests, these commands allows you to quickly put your Joomla! powered website into offline or online mode. Here is how to use the commands: 

<tt>php cli/joomla.php site:up</tt>

<tt>php cli/joomla.php site:down</tt>

The second one puts the website in offline mode while the first command brings the website to online mode.

==Contributing to CLI Update as a developer==
===Adding more commands===
===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-07-29T00:05:08Z

Bosunski:

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 
CLI Update Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}
== Introduction ==
Performing some minor task on the Joomla! administrator dashboard might seem cumbersome and slow. The CLI Update is introducing a faster way to perform some of these operations through the command line. It brings forward a way to integrate things faster in the Joomla! app. With it, small tests can be done faster without having to go through the process of the web dashboard. It a CLI Application to the Joomla! CMS that enables user to perform updates in the CMS.

This documentation shows how the CLI Update can be used and how you can extend it's functionality as a developer.
===Requirements===
As it goes for all CLI (Command Line Interface) Apps, access to a to your Joomla! installation via the command line is very important to use the tools provided by the CLI Update.
You might want to consider having an SSH access for your live server.
===Terms and definitions===
*CLI - Command Line Interface
*SSH - Secure SHell
==Using the CLI Update==
In other for you to use the tools provided by CLI Update, as said in former section, you need access to a CLI into the root of the Joomla Installation. In other words you have to be in the root folder of your Joomla CMS as all commands will run from the root folder.

%To include an Image here%
==General Command Usage==
In this section we will talk about the usage of commands, we will talk about different commands, what they are and how you can use them. We will go by checking out available commands in the CLI Update.
===Available commands===
There are quite a number of commands available in the CLI Update that ready for use, these commands are grouped based on the area of the Joomla! CMS that they are touching.
====Checking for Updates Updates====
The CLI Update provides a command to check for Joomla! updates, it works just like the web version of <tt>com_joomlaupdate</tt>, it retrieves update and tells if update is available or not. To run the update check, we will just issue the command like this from the root directory: 
<tt>php cli/joomla.php check-updates</tt>
 
The command runs and the output displays an available update version, if available, or tell otherwise that the current installation is up to date.
====Extension commands:====
The next group of commands are the extension based commands, simply put, the commands allows us to manage extensions within the Jommla! core, the CLI Update ships with commands to install, list and remove extensions.
======Listing installed extensions======
This command allows us to list all installed extensions. This command can run in two different ways which are:
*General Listing
Lists all the extensions installed, by extensions it means components, languages, plugins, modules will be listed together when you run this command. This is how you call the command: 
<tt>php cli/joomla.php extension:list</tt/>
 
*Listing By types
General listing of extension can be tedious if you're looking for a particular extension out of the big list, however, you can beat down the numbers specifying the type of extensions you can the command to display by adding a type option to the command. Here is how that is done: 
<tt>php cli/joomla.php extension:list --type=component</tt>
 

This will list out only component based extensions, you can specify type as module, plugin and language as well.
======Installing an Extension======
Joomla! provides installing an extension through a URL to the zip file or a path to the file, the CLI Update provides both as well and how you can use them is described below.
*Installing from URL
To install an extension from URL we will run the command like this and provide an argument and option for the <tt>extension:install</tt> command. 
<tt>php cli/joomla.php extension:install url --url=https://github.com/joomla-extensions/patchtester/releases/download/3.0.0-beta3/com_patchtester.zip</tt>

This will download the <tt>com_patchtester</tt> extension.
*Installing from a PATH
To install an extension from a PATH we will run the same <tt>extension:install</tt> command and specify arguments for paths like this: 
<tt>php cli/joomla.php extension:install path --path=/user/bosunski/docs/com_pathtester.zip</tt>

This loads the extension and performs the installation as expected
======Removing an extension======
The last command under this category is the the <tt>extension:remove</tt> command that is used to remove extensions from the Joomla! CMS. This command takes in the <tt>extension_id</tt> as an argument, you can always use the <tt>extension:list</tt> to display extension id. This is how we remove an extension of id <tt>802</tt>
====Updating the Joomla! Core====
As much as the CLI Update provides a command to check update, it also provides a command to perform the update if an update is available. To perform update we will just run this: 
<tt>php cli/joomla.php core:update</tt>

This command updates the Joomla! core updating it to the latest version available
====Installing Joomla! via the CLI====
The next command here is the <tt>core:intall</tt> command that lets installation of Joomla! CMS to be done via the CLI. This command can work in 2 modes: The Interactive mode and the Non-interactive mode.
=====Interactive installation=====
To have a fresh installation of Joomla! using the interactive mode we will just run the <tt>extension:install</tt> command like so: 
<tt>php cli/joomla.php extension:install</tt>

The default installation mode with run and will ask you to input the settings as it's required, once all options have been provided and validated, the installations will run and Joomla! will be installed.
=====Non-interactive Installation=====
The next type of installation is the Non-interactive mode, in this mode you will not be asked to input the options but rather all options will be specified within a file and the command will take in an option that specifies the path to the file you want to load the options from, it's done like this: 

<tt>php cli/joomla.php core:install --file=/path/to/config.json</tt>

An example of the contents of <tt>config.json</tt> can be: 

<source lang="json">
{
"language":"en-GB",
"site_name":"Joomla",
"admin_email":"email@example.com",
"admin_user":"user",
"admin_password":"password",
"db_type":"mysql",
"db_host":"localhost",
"db_user":"root",
"db_pass":"xcdxcx",
"db_name":"jtest",
"db_prefix":"efs0k_",
"db_old":"remove",
"helpurl":"https://joomla.org"
}
</source>

OR as sample <tt>config.ini</tt>

<source lang="ini">
site_name="gsoc"
admin_email="user@example.com"
admin_user="user"
admin_password="secret"
db_type="mysql"
db_host="localhost"
db_user="root"
db_pass=""
db_name="joomla"
db_prefix="prefix_"
</source>

The options defined are loaded and validated after which the installation will run.
====Configuration based commands====
The next set of commands we will be looking at is for setting and viewing configuration options inside the Joomla! installation:
=====Setting configurations=====
The CLI Update provides a command to change the value of an option existing in the configuration. Using the <tt>config:get</tt> command you can set any configuration option that exists inside the <tt>configuration.php</tt>. This is how to use command: 
<tt>php cli/joomla.php config:set mailer=mail</tt>

You can even add multiple option-value pairs like this: 

<tt>php cli/joomla.php config:set mailer=mail fromname=Joomla!</tt>

This will set multiple options at once.
=====Getting configurations=====
The next command in this category is the <tt>config:get</tt> command, as the name suggests it gets the value of an option that exists inside the <tt>configuration.php</tt>, when no argument is supplied to the command, it will display all the options available in a tabulated form. Here is the command: 

<tt>php cli/joomla.php config:get mailer</tt>

This will return the value for the option <tt>mailer<tt/>

<tt>php cli/joomla.php config:get</tt>

This will return all the values for the options available.

=====Getting grouped configurations=====
The CLI Update added an option to <tt>config:get</tt> command that allows us to get logically grouped options, say for example you want to view all your database related options, or you want to view all email related options. To achieve this the CLI Update provide an option to specify a group of options to display, here is how to do that:

<tt>php cli/joomla.php config:get --group=mail</tt>

The command takes in the <tt>group</tt> option and given the value of <tt>mail</tt>. CLI Update currently supports

====Site down and Site up commands====
==Contributing to CLI Update as a developer==
===Adding more commands===
===Calling other commands within command classes===

<noinclude>
[[Category:Google Summer of Code 2018]]
[[Category:Development]]
[[Category:Joomla!_4.x]]
</noinclude>

J4.x:CLI Update

2018-07-28T05:52:22Z

Bosunski:

J4.x:CLI Update

2018-07-27T18:27:00Z

Bosunski:

J4.x:CLI Update

2018-07-26T20:29:16Z

Bosunski:

J4.x:CLI Update

2018-07-26T19:55:32Z

Bosunski:

J4.x:CLI Update

2018-07-26T11:32:17Z

Bosunski:

J4.x:CLI Update

2018-07-26T11:29:55Z

Bosunski: Created Outline