DokumentationHandelAnvändarhandbok om Commerce i molninfrastrukturen

Cloud CLI

Last update: Thu Sep 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Administratör
  • Utvecklare

Med CLI-verktyget magento-cloud kan utvecklare och systemadministratörer hantera molnprojekt och miljöer, utföra rutiner och köra automatiseringsåtgärder lokalt. CLI:n magento-cloud utökar funktionerna i Cloud Console. När du har installerat CLI:n för magento-cloud på din lokala arbetsstation kan du använda den för att hantera din Adobe Commerce i integreringsmiljöer för Starter och Pro i molnet.

NOTE
Det här är ett lokalt verktyg och kan inte installeras i molnmiljön (som är skrivskyddad) med den här metoden. Du kan bara installera moduler i molnmiljön via distributionsarbetsflödet

Så här installerar du magento-cloud CLI:

  1. På din lokala arbetsstation ändrar du till den katalog där du vill klona Cloud-projektet och där filsystemägaren har write -åtkomst.

  2. Installera CLI:n för magento-cloud.

    code language-bash 
    curl -sS https://accounts.magento.cloud/cli/installer | php

  3. Lägg till magento-cloud CLI i basprofilen.

    code language-bash 
    export PATH=$PATH:$HOME/.magento-cloud/bin

  4. Läs in den uppdaterade basprofilen igen.

    code language-bash 
    . ~/.bash_profile

  5. Om du vill initiera CLI ringer du magento-cloud och anger autentiseringsuppgifterna för ditt molnkonto när du uppmanas till det.

    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:

  6. Kontrollera att kommandot magento-cloud finns i sökvägen. I följande exempel visas de tillgängliga kommandona.

    code language-bash 
    magento-cloud list

Gemensamma kommandon

Adobe har utformat de här kommandona för att hantera molnintegreringsmiljöer och rekommenderar att du kör CLI:n för magento-cloud från en projektkatalog så att du kan utelämna parametern -p <project-ID>.

Följande lista med vanliga magento-cloud CLI-kommandon innehåller endast obligatoriska alternativ. Du kan använda alternativet --help tillsammans med valfritt kommando för att visa mer information.

Kommando
Beskrivning
magento-cloud login
Logga in på projektet.
magento-cloud list
Visa en lista över tillgängliga kommandon för CLI-verktyget.
magento-cloud environment:list
Visa miljöerna i det aktuella projektet.
magento-cloud environment:checkout
Kolla in en befintlig miljö.
magento-cloud environment:merge -e
Sammanfoga ändringar i den här miljön med dess överordnade.
magento-cloud variables
Visa variabler i den här miljön.
magento-cloud ssh
Använd SSH för att ansluta till fjärrmiljön.
magento-cloud url
Öppna Adobe Commerce Store i en webbläsare.
magento-cloud web
Öppna Cloud Console.

Miljökommandon

Miljön name skiljer sig bara från miljön ID om du använder blanksteg eller versaler i miljönamnet. Ett miljö-ID består av alla gemener, siffror och tillåtna symboler. Versaler i ett miljönamn konverteras till gemener i ID:t. Blanksteg i ett miljönamn konverteras till streck.

Miljönamnet får inte innehålla tecken som är reserverade för ditt Linux-skal eller för reguljära uttryck. Otillåtna tecken är klammerparenteser ({ }), parenteser, asterisk (*), vinkelparenteser (< >), et-tecken (&), procent (%) och andra tecken.

Kommandot magento-cloud environment:list visar miljöhierarkier, men det gör inte git branch. Om du har kapslade miljöer använder du följande:

magento-cloud environment:list

Distribuera om miljön

Utlösa en omdistribution utan att använda en push-funktion. Verifiera och bekräfta miljön för omdistribution. Använd inte omdistribuering om det finns ett bygge i ett väntande tillstånd.

magento-cloud environment:redeploy

Exempelsvar:

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
Distributionsprocessen börjar när du utför en sammanfogning, push eller synkronisering av miljön, eller när du utlöser en manuell omdistribution, under vilken Commerce-programmet är i underhållsläge. För en produktionsmiljö rekommenderar Adobe att man slutför detta under tider med låg belastning för att undvika avbrott i tjänsten.

Git-kommandon

Vissa av dessa kommandon liknar Git-kommandona. magento-cloud-kommandona ansluter direkt till det Git-baserade Cloud-projektet med ytterligare funktioner. Om du skapar en gren utan att använda CLI:n för magento-cloud,"aktiveras" den inte och byggs inte automatiskt när du gör ändringar i fjärrmiljön. CLI-kommandot magento-cloud innehåller aktivering.

Om du vill skapa en gren använder du kommandot magento-cloud så att grenen aktiveras.

magento-cloud environment:branch <new-name> <parent-branch>

För filialstatus:

  • Använd kommandot magento-cloud env för att visa en lista över miljögrenarna och deras status: aktiv eller inaktiv.
  • Använd kommandot magento-cloud environment:activate för att aktivera en miljögren.

Tryck på en tom Git-implementering för att utlösa en distribution. Exempel:

git commit --allow-empty -m "redeploy" && git push <branch-name>

Vissa åtgärder, till exempel att lägga till en användare, leder inte till distribution.

Skapa en miljögren

Följande steg visar hur du använder kommandona CLI och Git för att hantera din lokala miljö:

  1. Byt till din projektkatalog på din lokala arbetsstation.

  2. Växla till filsystemets ägare.

  3. Logga in på ditt projekt.

    code language-bash 
    magento-cloud login

  4. Lista dina projekt.

    code language-bash 
    magento-cloud project:list

  5. Lista miljöer i projektet. Varje miljö innehåller en aktiv Git-gren som innehåller kod, databas, miljövariabler, konfigurationer och tjänster.

    code language-bash 
    magento-cloud environment:list
    note note
    NOTE
    Det är viktigt att använda kommandot magento-cloud environment:list eftersom det visar systemhierarkier, vilket kommandot git branch inte gör.

  6. Hämta ursprungliga grenar för att få den senaste koden.

    code language-bash 
    git fetch origin

  7. Checka ut, eller växla till, en viss gren och miljö.

    code language-bash 
    magento-cloud environment:checkout <environment-ID>

    Git-kommandon checkar bara ut Git-grenen. Kommandot magento-cloud checkout checkar ut grenen och växlar till den aktiva miljön.

    note tip
    TIP
    Du kan skapa en miljögren med kommandosyntaxen magento-cloud environment:branch <environment-name> <parent-environment-ID>. Det kan ta ytterligare tid att skapa och aktivera en miljögren.

  8. Använd miljö-ID:t för att hämta uppdaterad kod till din lokala dator. Detta är inte nödvändigt om miljögrenen är ny.

    code language-bash 
    git pull origin <environment-ID>

  9. (Valfritt) Skapa en ögonblicksbild av miljön som en säkerhetskopia.

    code language-bash 
    magento-cloud snapshot:create -e <environment-ID>

Uppdatera CLI

CLI:n magento-cloud söker efter tillgängliga uppdateringar när du loggar in, men du kan söka efter uppdateringar med kommandot self:update. Om det finns en uppdatering följer du instruktionerna för att uppdatera CLI.

Om ditt magento-cloud CLI är uppdaterat ser du följande svar:

magento-cloud update

Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found
recommendation-more-help
05f2f56e-ac5d-4931-8cdb-764e60e16f26