Cloud CLI
L’outil d’interface de ligne de commande magento-cloud
permet aux développeurs et aux administrateurs système de gérer des projets et des environnements cloud, d’effectuer des routines et d’exécuter des tâches d’automatisation localement. L’interface de ligne de commande magento-cloud
étend les fonctionnalités du Cloud Console. Après avoir installé l’interface de ligne de commande magento-cloud
sur votre station de travail locale, vous pouvez l’utiliser pour gérer vos environnements d’intégration Adobe Commerce sur le cloud, Starter et Pro.
Pour installer l’interface de ligne de commande magento-cloud
:
-
Sur votre station de travail locale, accédez au répertoire dans lequel vous avez l’intention de cloner le projet cloud et dans lequel le propriétaire du système de fichiers dispose d’un accès en écriture.
-
Installez l’interface de ligne de commande
magento-cloud
.code language-bash curl -sS https://accounts.magento.cloud/cli/installer | php
-
Ajoutez l’interface de ligne de commande
magento-cloud
au profil bash.code language-bash export PATH=$PATH:$HOME/.magento-cloud/bin
-
Rechargez le profil bash mis à jour.
code language-bash . ~/.bash_profile
-
Pour lancer l’interface de ligne de commande, appelez
magento-cloud
et saisissez les informations d’identification de votre compte Cloud lorsque vous y êtes invité.code language-bash magento-cloud
code language-none Welcome to Magento Cloud! Please log in using your Magento Cloud account. Your email address or username:
-
Vérifiez que la commande
magento-cloud
se trouve dans votre chemin d’accès. L'exemple suivant répertorie les commandes disponibles.code language-bash magento-cloud list
Commandes communes
Adobe a conçu ces commandes pour gérer les environnements d’intégration cloud et vous recommande d’exécuter l’interface de ligne de commande magento-cloud
à partir d’un répertoire de projet afin que vous puissiez omettre le paramètre -p <project-ID>
.
La liste suivante des commandes d’interface de ligne de commande magento-cloud
couramment utilisées comprend uniquement les options requises. Vous pouvez utiliser l’option --help
avec n’importe quelle commande pour afficher plus d’informations.
magento-cloud login
magento-cloud list
magento-cloud environment:list
magento-cloud environment:checkout
magento-cloud environment:merge -e
magento-cloud variables
magento-cloud ssh
magento-cloud url
magento-cloud web
Commandes d’environnement
L’environnement nom est différent de l’environnement ID uniquement si vous utilisez des espaces ou des majuscules dans le nom de l’environnement. Un identifiant d’environnement se compose de toutes les lettres minuscules, de tous les chiffres et de tous les symboles autorisés. Les majuscules dans le nom d’un environnement sont converties en minuscules dans l’identifiant ; les espaces dans le nom d’un environnement sont convertis en tirets.
Un nom d’environnement ne peut pas inclure des caractères réservés à votre shell Linux ou à des expressions régulières. Les caractères interdits comprennent les accolades ({ }
), les parenthèses, l’astérisque (*
), les crochets (< >
), l’esperluette (&
), le pourcentage (%
) et d’autres caractères.
La commande magento-cloud environment:list
affiche les hiérarchies d’environnement, contrairement à git branch
. Si vous disposez d’environnements imbriqués, utilisez les méthodes suivantes :
magento-cloud environment:list
Redéploiement de l’environnement
Déclenchez un redéploiement sans utiliser de notification push. Vérifiez et confirmez l’environnement à redéployer. N’utilisez pas le redéploiement si une version est en attente.
magento-cloud environment:redeploy
Exemple de réponse :
Are you sure you want to redeploy the environment <environment-name>? [Y/n]
Commandes Git
Vous remarquerez peut-être que certaines de ces commandes sont similaires aux commandes Git. Les commandes magento-cloud
se connectent directement au projet cloud basé sur Git avec des fonctionnalités supplémentaires. Si vous créez une branche sans utiliser l’interface de ligne de commande magento-cloud
, elle n’est pas « activée » et ne se crée pas automatiquement lorsque vous envoyez des modifications à l’environnement distant. La commande de l’interface de ligne de commande magento-cloud
inclut l’activation.
Pour créer une branche, utilisez la commande magento-cloud
afin que la branche soit activée.
magento-cloud environment:branch <new-name> <parent-branch>
Pour le statut de la branche :
- Utilisez la commande
magento-cloud env
pour afficher la liste des branches d’environnement et leur statut : actives ou inactives. - Utilisez la commande
magento-cloud environment:activate
pour activer une branche d’environnement.
Envoyez une validation Git vide pour déclencher un déploiement. Par exemple :
git commit --allow-empty -m "redeploy" && git push <branch-name>
Certaines actions, telles que l’ajout d’un utilisateur, n’entraînent pas le déploiement.
Créer une branche d’environnement
Les étapes suivantes illustrent l’utilisation interchangeable des commandes CLI et Git pour gérer votre environnement local :
-
Sur votre station de travail locale, accédez au répertoire du projet.
-
Passez au propriétaire du système de fichiers.
-
Connectez-vous à votre projet.
code language-bash magento-cloud login
-
Répertoriez vos projets.
code language-bash magento-cloud project:list
-
Répertorier les environnements dans le projet. Chaque environnement comprend une branche Git active qui contient votre code, votre base de données, vos variables d’environnement, vos configurations et vos services.
code language-bash magento-cloud environment:list
note note NOTE Il est important d’utiliser la commande magento-cloud environment:list
car elle affiche les hiérarchies d’environnements, contrairement à la commandegit branch
. -
Récupérez les branches d’origine pour obtenir le code le plus récent.
code language-bash git fetch origin
-
Extrayez ou passez à une branche et un environnement spécifiques.
code language-bash magento-cloud environment:checkout <environment-ID>
Les commandes Git extraient uniquement la branche Git. La commande
magento-cloud checkout
extrait la branche et passe à l’environnement actif.note tip TIP Vous pouvez créer une branche d’environnement à l’aide de la syntaxe de commande magento-cloud environment:branch <environment-name> <parent-environment-ID>
. La création et l’activation d’une branche d’environnement peuvent prendre un certain temps supplémentaire. -
Utilisez l’ID d’environnement pour extraire le code mis à jour vers votre fichier local . Cela n’est pas nécessaire si la branche d’environnement est nouvelle.
code language-bash git pull origin <environment-ID>
-
(Facultatif) Créez un instantané de l’environnement en tant que sauvegarde.
code language-bash magento-cloud snapshot:create -e <environment-ID>
Mettre à jour l’interface de ligne de commande
L’interface de ligne de commande magento-cloud
vérifie les mises à jour disponibles lorsque vous vous connectez, mais vous pouvez vérifier les mises à jour à l’aide de la commande self:update
. Si une mise à jour est disponible, suivez les instructions pour mettre à jour l’interface en ligne de commande.
Si votre interface de ligne de commande magento-cloud
est à jour, la réponse suivante s’affiche :
magento-cloud update
Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found