J4.x:CLI Update/fr

2019-10-19T11:49:17Z

Cavo789: Created page with "Ceci listera seulement les extensions basées sur la langue, vous pouvez spécifier le type comme module, plugin et composant."

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

==Introduction==
Pour effectuer une tâche mineure dans Joomla!, le tableau de bord de l'administrateur peut sembler fastidieux et lent. La mise à jour de l'application CLI introduit un moyen plus rapide d'effectuer certaines de ces opérations via la ligne de commande. Cela offre un moyen d'intégrer les choses plus rapidement dans l'application Joomla!. Grâce à ce logiciel, les petits tests peuvent être effectués plus rapidement sans passer par le processus du tableau de bord Web. C’est une application CLI pour Joomla! CMS qui permet à l'utilisateur d'effectuer des mises à jour dans le CMS.

Cette documentation montre comment utiliser la mise à jour de l'application CLI et comment étendre ses fonctionnalités en tant que développeur.

===Pré-requis===
Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

===Termes et définitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Utilisation du 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]]

==Utilisation des commandes générales==
Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous irons voir les commandes disponibles dans le CLI Update.

===Commandes disponibles===
Il y a un certain nombre de commandes disponibles dans le CLI Update qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla! qu'elles touchent.

====Vérification des mises à jour mises à jour====
Le CLI Update fournit une commande pour vérifier les mises à jour de Joomla!, elle fonctionne comme la version web de <tt>com_joomlaupdate</tt>, elle récupère la mise à jour et indique si la mise à jour est disponible ou pas. Pour lancer la vérification de mise à jour, nous allons simplement lancer la commande comme ceci à partir du répertoire racine : 
<tt>php cli/joomla.php check-updates</tt>
 
La commande s'exécute et la sortie affiche une version de mise à jour disponible, si disponible, ou indique que l'installation actuelle est à jour.
[[File:Check updates.png|center|800px]]

====Commandes des composants====
Le groupe suivant de commandes sont les commandes basées sur l'extension, simplement dit, les commandes nous permettent de gérer les extensions dans le noyau Jommla!, le CLI Update est livré avec des commandes pour installer, lister et supprimer les extensions.

======Liste des extensions installées======
Cette commande nous permet de lister toutes les extensions installées. Cette commande peut s'exécuter de deux manières différentes qui sont :
*"Liste générale" : Liste toutes les extensions installées, par extension cela signifie que les composants, langages, plugins et modules seront listés ensemble lorsque vous lancez cette commande. C'est ainsi que vous appelez la commande :{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*"Listing par types" : La liste générale des extensions peut être fastidieuse si vous recherchez une extension particulière parmi la grande liste, cependant, vous pouvez réduire le nombre en spécifiant le type d'extensions que vous pouvez afficher la commande en ajoutant une option de type à cette commande. Voici comment cela se fait : {{-}}<tt>php cli/joomla.php extension:list --type=language</tt>{{-}}[[File:Extension list type.png|center|800px]]
Ceci listera seulement les extensions basées sur la langue, vous pouvez spécifier le type comme module, plugin et composant.

======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.

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

====Installing Joomla! via the CLI====
The next command here is the <tt>core:install</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! sitename="Joomla Site"</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: [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>

Translations:J4.x:CLI Update/23/fr

2019-10-19T11:49:16Z

Cavo789: Created page with "Ceci listera seulement les extensions basées sur la langue, vous pouvez spécifier le type comme module, plugin et composant."

Ceci listera seulement les extensions basées sur la langue, vous pouvez spécifier le type comme module, plugin et composant.

J4.x:CLI Update/fr

2019-10-19T11:48:09Z

Cavo789: Created page with ""Listing par types" : La liste générale des extensions peut être fastidieuse si vous recherchez une extension particulière parmi la grande liste, cependant, vous pouvez r..."

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

==Introduction==
Pour effectuer une tâche mineure dans Joomla!, le tableau de bord de l'administrateur peut sembler fastidieux et lent. La mise à jour de l'application CLI introduit un moyen plus rapide d'effectuer certaines de ces opérations via la ligne de commande. Cela offre un moyen d'intégrer les choses plus rapidement dans l'application Joomla!. Grâce à ce logiciel, les petits tests peuvent être effectués plus rapidement sans passer par le processus du tableau de bord Web. C’est une application CLI pour Joomla! CMS qui permet à l'utilisateur d'effectuer des mises à jour dans le CMS.

Cette documentation montre comment utiliser la mise à jour de l'application CLI et comment étendre ses fonctionnalités en tant que développeur.

===Pré-requis===
Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

===Termes et définitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Utilisation du 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]]

==Utilisation des commandes générales==
Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous irons voir les commandes disponibles dans le CLI Update.

===Commandes disponibles===
Il y a un certain nombre de commandes disponibles dans le CLI Update qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla! qu'elles touchent.

====Vérification des mises à jour mises à jour====
Le CLI Update fournit une commande pour vérifier les mises à jour de Joomla!, elle fonctionne comme la version web de <tt>com_joomlaupdate</tt>, elle récupère la mise à jour et indique si la mise à jour est disponible ou pas. Pour lancer la vérification de mise à jour, nous allons simplement lancer la commande comme ceci à partir du répertoire racine : 
<tt>php cli/joomla.php check-updates</tt>
 
La commande s'exécute et la sortie affiche une version de mise à jour disponible, si disponible, ou indique que l'installation actuelle est à jour.
[[File:Check updates.png|center|800px]]

====Commandes des composants====
Le groupe suivant de commandes sont les commandes basées sur l'extension, simplement dit, les commandes nous permettent de gérer les extensions dans le noyau Jommla!, le CLI Update est livré avec des commandes pour installer, lister et supprimer les extensions.

======Liste des extensions installées======
Cette commande nous permet de lister toutes les extensions installées. Cette commande peut s'exécuter de deux manières différentes qui sont :
*"Liste générale" : Liste toutes les extensions installées, par extension cela signifie que les composants, langages, plugins et modules seront listés ensemble lorsque vous lancez cette commande. C'est ainsi que vous appelez la commande :{{-}}<tt>php cli/joomla.php extension:list</tt/> {{-}}[[File:Extension list.png|center|800px]]
*"Listing par types" : La liste générale des extensions peut être fastidieuse si vous recherchez une extension particulière parmi la grande liste, cependant, vous pouvez réduire le nombre en spécifiant le type d'extensions que vous pouvez afficher la commande en ajoutant une option de type à cette commande. Voici comment cela se fait : {{-}}<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.

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

====Installing Joomla! via the CLI====
The next command here is the <tt>core:install</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! sitename="Joomla Site"</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: [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>

Translations:J4.x:CLI Update/22/fr

2019-10-19T11:48:09Z

"Listing par types" : La liste générale des extensions peut être fastidieuse si vous recherchez une extension particulière parmi la grande liste, cependant, vous pouvez réduire le nombre en spécifiant le type d'extensions que vous pouvez afficher la commande en ajoutant une option de type à cette commande. Voici comment cela se fait :

J4.x:CLI Update/fr

2019-10-19T11:46:18Z

Cavo789: Created page with ""Liste générale" : Liste toutes les extensions installées, par extension cela signifie que les composants, langages, plugins et modules seront listés ensemble lorsque vous..."

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

==Introduction==
Pour effectuer une tâche mineure dans Joomla!, le tableau de bord de l'administrateur peut sembler fastidieux et lent. La mise à jour de l'application CLI introduit un moyen plus rapide d'effectuer certaines de ces opérations via la ligne de commande. Cela offre un moyen d'intégrer les choses plus rapidement dans l'application Joomla!. Grâce à ce logiciel, les petits tests peuvent être effectués plus rapidement sans passer par le processus du tableau de bord Web. C’est une application CLI pour Joomla! CMS qui permet à l'utilisateur d'effectuer des mises à jour dans le CMS.

Cette documentation montre comment utiliser la mise à jour de l'application CLI et comment étendre ses fonctionnalités en tant que développeur.

===Pré-requis===
Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

===Termes et définitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Utilisation du 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]]

==Utilisation des commandes générales==
Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous irons voir les commandes disponibles dans le CLI Update.

===Commandes disponibles===
Il y a un certain nombre de commandes disponibles dans le CLI Update qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla! qu'elles touchent.

====Vérification des mises à jour mises à jour====
Le CLI Update fournit une commande pour vérifier les mises à jour de Joomla!, elle fonctionne comme la version web de <tt>com_joomlaupdate</tt>, elle récupère la mise à jour et indique si la mise à jour est disponible ou pas. Pour lancer la vérification de mise à jour, nous allons simplement lancer la commande comme ceci à partir du répertoire racine : 
<tt>php cli/joomla.php check-updates</tt>
 
La commande s'exécute et la sortie affiche une version de mise à jour disponible, si disponible, ou indique que l'installation actuelle est à jour.
[[File:Check updates.png|center|800px]]

====Commandes des composants====
Le groupe suivant de commandes sont les commandes basées sur l'extension, simplement dit, les commandes nous permettent de gérer les extensions dans le noyau Jommla!, le CLI Update est livré avec des commandes pour installer, lister et supprimer les extensions.

======Liste des extensions installées======
Cette commande nous permet de lister toutes les extensions installées. Cette commande peut s'exécuter de deux manières différentes qui sont :
*"Liste générale" : Liste toutes les extensions installées, par extension cela signifie que les composants, langages, plugins et modules seront listés ensemble lorsque vous lancez cette commande. C'est ainsi que vous appelez la commande :{{-}}<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.

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

====Installing Joomla! via the CLI====
The next command here is the <tt>core:install</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! sitename="Joomla Site"</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: [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>

La mise à jour de CLI fournit une commande pour vérifier les mises à jour de Joomla!, elle fonctionne comme la version web de <tt>com_joomlaupdate</tt>, elle récupère la mise à jour et indique si la mise à jour est disponible ou pas. Pour lancer la vérification de mise à jour, nous allons simplement lancer la commande comme ceci à partir du répertoire racine :

J4.x:CLI Update/fr

2019-10-19T11:41:18Z

Cavo789: Created page with "====Vérification des mises à jour mises à jour===="

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

==Introduction==
Pour effectuer une tâche mineure dans Joomla!, le tableau de bord de l'administrateur peut sembler fastidieux et lent. La mise à jour de l'application CLI introduit un moyen plus rapide d'effectuer certaines de ces opérations via la ligne de commande. Cela offre un moyen d'intégrer les choses plus rapidement dans l'application Joomla!. Grâce à ce logiciel, les petits tests peuvent être effectués plus rapidement sans passer par le processus du tableau de bord Web. C’est une application CLI pour Joomla! CMS qui permet à l'utilisateur d'effectuer des mises à jour dans le CMS.

Cette documentation montre comment utiliser la mise à jour de l'application CLI et comment étendre ses fonctionnalités en tant que développeur.

===Pré-requis===
Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

===Termes et définitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Utilisation de la mise-à-jour en mode CLI==
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]]

==Utilisation des commandes générales==
Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous irons voir les commandes disponibles dans la mise à jour de CLI.

===Commandes disponibles===
Il y a un certain nombre de commandes disponibles dans la mise à jour de CLI qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla ! qu'elles touchent.

====Vérification des mises à jour mises à jour====
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:Check updates.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.

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

====Installing Joomla! via the CLI====
The next command here is the <tt>core:install</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! sitename="Joomla Site"</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: [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>

Translations:J4.x:CLI Update/14/fr

2019-10-19T11:41:17Z

Cavo789: Created page with "====Vérification des mises à jour mises à jour===="

====Vérification des mises à jour mises à jour====

J4.x:CLI Update/fr

2019-10-19T11:41:00Z

Cavo789: Created page with "Il y a un certain nombre de commandes disponibles dans la mise à jour de CLI qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla..."

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

==Introduction==
Pour effectuer une tâche mineure dans Joomla!, le tableau de bord de l'administrateur peut sembler fastidieux et lent. La mise à jour de l'application CLI introduit un moyen plus rapide d'effectuer certaines de ces opérations via la ligne de commande. Cela offre un moyen d'intégrer les choses plus rapidement dans l'application Joomla!. Grâce à ce logiciel, les petits tests peuvent être effectués plus rapidement sans passer par le processus du tableau de bord Web. C’est une application CLI pour Joomla! CMS qui permet à l'utilisateur d'effectuer des mises à jour dans le CMS.

Cette documentation montre comment utiliser la mise à jour de l'application CLI et comment étendre ses fonctionnalités en tant que développeur.

===Pré-requis===
Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

===Termes et définitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Utilisation de la mise-à-jour en mode CLI==
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]]

==Utilisation des commandes générales==
Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous irons voir les commandes disponibles dans la mise à jour de CLI.

===Commandes disponibles===
Il y a un certain nombre de commandes disponibles dans la mise à jour de CLI qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla ! qu'elles touchent.

====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:Check updates.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.

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

====Installing Joomla! via the CLI====
The next command here is the <tt>core:install</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! sitename="Joomla Site"</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: [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>

Translations:J4.x:CLI Update/13/fr

2019-10-19T11:40:59Z

Il y a un certain nombre de commandes disponibles dans la mise à jour de CLI qui sont prêtes à l'emploi. Ces commandes sont regroupées en fonction de la zone du CMS Joomla ! qu'elles touchent.

J4.x:CLI Update/fr

2019-10-19T11:40:16Z

Cavo789: Created page with "===Commandes disponibles==="

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

==Introduction==
Pour effectuer une tâche mineure dans Joomla!, le tableau de bord de l'administrateur peut sembler fastidieux et lent. La mise à jour de l'application CLI introduit un moyen plus rapide d'effectuer certaines de ces opérations via la ligne de commande. Cela offre un moyen d'intégrer les choses plus rapidement dans l'application Joomla!. Grâce à ce logiciel, les petits tests peuvent être effectués plus rapidement sans passer par le processus du tableau de bord Web. C’est une application CLI pour Joomla! CMS qui permet à l'utilisateur d'effectuer des mises à jour dans le CMS.

Cette documentation montre comment utiliser la mise à jour de l'application CLI et comment étendre ses fonctionnalités en tant que développeur.

===Pré-requis===
Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

===Termes et définitions===
*CLI - Command Line Interface
*SSH - Secure SHell

==Utilisation de la mise-à-jour en mode CLI==
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]]

==Utilisation des commandes générales==
Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous irons voir les commandes disponibles dans la mise à jour de CLI.

===Commandes disponibles===
There are quite a number of commands available in the CLI Update that are 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:Check updates.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.

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

====Installing Joomla! via the CLI====
The next command here is the <tt>core:install</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! sitename="Joomla Site"</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: [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>

Translations:J4.x:CLI Update/12/fr

2019-10-19T11:40:16Z

Cavo789: Created page with "===Commandes disponibles==="

===Commandes disponibles===

J4.x:CLI Update/fr

2019-10-19T11:40:05Z

Cavo789: Created page with "Dans cette section, nous parlerons de l'utilisation des commandes, nous parlerons des différentes commandes, de ce qu'elles sont et comment vous pouvez les utiliser. Nous iro..."

2019-10-19T11:38:00Z

Comme c'est le cas pour toutes les applications CLI (Command Line Interface), l'accès à votre installation Joomla! via la ligne de commande est nécessaire pour utiliser les outils fournis par le CLI Update.
Vous devriez peut-être envisager d'avoir un accès SSH pour votre serveur en direct.

J4.x:CLI Database Exporter Importer/fr

2019-10-19T11:30:21Z

Cavo789:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.0}}</noinclude>
{{-}}
== À propos ==
Avant de mettre à jour Joomla! ou [[S:MyLanguage/J4.x:CLI Update|d'installer une extension tierce]], il est fortement recommandé de sauvegarder votre site. 
La Console Joomla! 4.x fournit des commandes pour exporter (sauvegarder) et importer (restaurer) votre base de données Joomla!.

== Pré-requis ==
Pour utiliser ces commandes, vous avez besoin d'un accès via un shell sécurisé (SSH) à votre hébergeur auquel PHP CLI (interface en ligne de commande) est installé.
Prenez en considération d'avoir quelques connaissances élémentaires d'usage des commandes shell.

== Instructions ==
Se connecter à votre hébergeur et aller au dossier racine de votre site. 
Je recommande d'utiliser le dossier 'tmp' de Joomla dans votre <chemin_dossier> pour avoir les autorisations en lecture/écriture.

* Lister toutes les commandes disponibles de la Console Joomla: <tt>php cli/joomla.php list</tt>
* Exporter la base de données dans le dossier: <tt>php cli/joomla.php database:export --all --folder <chemin_dossier></tt>
* Importer la base de données à partir du dossier: <tt>php cli/joomla.php database:import --all --folder <chemin_dossier></tt>

Vous pouvez aussi:
* Exporter la base de données sous forme de fichier .zip: <tt>php cli/joomla.php database:export --all --zip</tt>
* Exporter une table spécifique: <tt>php cli/joomla.php database:export --table <nom_table></tt>
* Exporter une table comme un fichier .zip: <tt>php cli/joomla.php database:export --table <nom_table> --zip</tt>
* Importer une table: <tt>php cli/joomla.php database:import --table <nom_table></tt>
* Si vous avez besoin d'aide: <tt>php cli/joomla.php database:export --help</tt> <tt>php cli/joomla.php database:import --help</tt>

== Sauvegarder et restaurer ==
Pour faire une sauvegarde complète (avec les dossiers, les fichiers et la base de données) de votre site, vous pouvez exécuter ces commandes:
# Archiver votre répertoire racine de Joomla: <tt>tar --exclude='./tmp/joomla_bak.*' -zcvf tmp/joomla_bak.tgz . > tmp/joomla_bak.log</tt>
# Exporter toute la base de données Joomla: <tt>php cli/joomla.php database:export --all --folder tmp/db_bak</tt>

Et pour la restaurer, exécutez ces commandes:
# Importer toute la base de données Joomla: <tt>php cli/joomla.php database:import --all --folder tmp/db_bak</tt>
# Extraire l'archive: <tt>tar --recursive-unlink -xvf tmp/joomla_bak.tgz .</tt>

<noinclude>
[[Category:Joomla! 4.x]]
[[Category:Joomla! 4.0{{#translation:}}]]
[[Category:Development{{#translation:}}]]
[[Category:Platform{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>

J4.x:CLI Database Exporter Importer/fr

2019-10-19T11:27:39Z

Cavo789:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.0}}</noinclude>
{{-}}
== À propos ==
Avant de mettre à jour Joomla! ou [[S:MyLanguage/J4.x:CLI Update|d'installer une extension tierce]], il est fortement recommandé de sauvegarder votre site. 
La Console Joomla! 4.x fournit des commandes pour exporter (sauvegarder) et importer (restaurer) votre base de données Joomla!.

== Pré-requis ==
Pour utiliser ces commandes, vous avez besoin d'un accès via un shell sécurisé (SSH) à votre hébergeur auquel PHP CLI (interface en ligne de commande) est installé.
Prenez en considération d'avoir quelques connaissances élémentaires d'usage des commandes shell.

== Instructions ==
<div class="mw-translate-fuzzy">
Se connecter à votre hébergeur et aller au dossier racine de votre site. 
Je recommande d'utiliser le dossier 'tmp' de Joomla dans votre <chemin_dossier> pour avoir les autorisations en lecture/écriture.
</div>

* Lister toutes les commandes disponibles de la Console Joomla: <tt>php cli/joomla.php list</tt>
* Exporter la base de données dans le dossier: <tt>php cli/joomla.php database:export --all --folder <chemin_dossier></tt>
* Importer la base de données à partir du dossier: <tt>php cli/joomla.php database:import --all --folder <chemin_dossier></tt>

Vous pouvez aussi:
* Exporter la base de données sous forme de fichier .zip: <tt>php cli/joomla.php database:export --all --zip</tt>
* Exporter une table spécifique: <tt>php cli/joomla.php database:export --table <nom_table></tt>
* Exporter une table comme un fichier .zip: <tt>php cli/joomla.php database:export --table <nom_table> --zip</tt>
* Importer une table: <tt>php cli/joomla.php database:import --table <nom_table></tt>
* Si vous avez besoin d'aide: <tt>php cli/joomla.php database:export --help</tt> <tt>php cli/joomla.php database:import --help</tt>

== Sauvegarder et restaurer ==
Pour faire une sauvegarde complète (avec les dossiers, les fichiers et la base de données) de votre site, vous pouvez exécuter ces commandes:
# Archiver votre répertoire racine de Joomla: <tt>tar --exclude='./tmp/joomla_bak.*' -zcvf tmp/joomla_bak.tgz . > tmp/joomla_bak.log</tt>
# Exporter toute la base de données Joomla: <tt>php cli/joomla.php database:export --all --folder tmp/db_bak</tt>

Et pour la restaurer, exécutez ces commandes:
# Importer toute la base de données Joomla: <tt>php cli/joomla.php database:import --all --folder tmp/db_bak</tt>
# Extraire l'archive: <tt>tar --recursive-unlink -xvf tmp/joomla_bak.tgz .</tt>

<noinclude>
[[Category:Joomla! 4.x]]
[[Category:Joomla! 4.0{{#translation:}}]]
[[Category:Development{{#translation:}}]]
[[Category:Platform{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>