DokumentationHandbuch zu Commerce in Cloud Manager

Cloud-CLI

Last update: Fri Jan 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin
  • Entwickler

Mit dem magento-cloud CLI-Tool können Entwickler und Systemadministratoren Cloud-Projekte und -Umgebungen verwalten, Routinen ausführen und Automatisierungsaufgaben lokal ausführen. Die magento-cloud CLI erweitert die Funktionen und Möglichkeiten der Cloud Console. Nachdem Sie die magento-cloud CLI auf Ihrer lokalen Workstation installiert haben, können Sie sie zur Verwaltung Ihrer Adobe Commerce in Cloud Infrastructure Starter- und Pro-Integrationsumgebungen verwenden.

NOTE
Dies ist ein lokales Tool und kann nicht mit dieser Methode in der Cloud-Umgebung installiert werden (die schreibgeschützt ist). Module können nur über den Bereitstellungs-Workflow () in der Cloud-Umgebung installiert

So installieren Sie die magento-cloud CLI:

  1. Ändern Sie auf Ihrer lokalen Workstation in das Verzeichnis, in dem Sie das Cloud-Projekt klonen möchten und in dem der Dateisystembesitzer über Schreibzugriff verfügt.

  2. Installieren Sie magento-cloud CLI.

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

  3. Fügen Sie magento-cloud CLI zum Bash-Profil hinzu.

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

  4. Laden Sie das aktualisierte Bash-Profil neu.

    code language-bash 
    . ~/.bash_profile

  5. Um die CLI zu starten, rufen Sie magento-cloud auf und geben Sie bei Aufforderung Ihre Anmeldedaten für das Cloud-Konto ein.

    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. Stellen Sie sicher, dass sich der magento-cloud-Befehl im Pfad befindet. Im folgenden Beispiel werden die verfügbaren Befehle aufgelistet.

    code language-bash 
    magento-cloud list

Allgemeine Befehle

Adobe hat diese Befehle für die Verwaltung von Cloud-Integrationsumgebungen entwickelt und empfiehlt, die magento-cloud CLI in einem Projektverzeichnis auszuführen, damit Sie den -p <project-ID>-Parameter weglassen können.

Die folgende Liste der häufig verwendeten magento-cloud CLI-Befehle enthält nur die erforderlichen Optionen. Sie können die --help-Option mit jedem Befehl verwenden, um weitere Informationen anzuzeigen.

Befehl
Beschreibung
magento-cloud login
Melden Sie sich beim Projekt an.
magento-cloud list
Auflisten der verfügbaren Befehle für das CLI-Tool.
magento-cloud environment:list
Listen Sie die Umgebungen im aktuellen Projekt auf.
magento-cloud environment:checkout
Überprüfen einer vorhandenen Umgebung.
magento-cloud environment:merge -e
Änderungen in dieser Umgebung mit dem übergeordneten Element zusammenführen.
magento-cloud variables
Listenvariablen in dieser Umgebung.
magento-cloud ssh
Verwenden Sie SSH, um eine Verbindung zur Remote-Umgebung herzustellen.
magento-cloud url
Öffnen Sie die Adobe Commerce-Storefront in einem Browser.
magento-cloud web
Öffnen Sie die Cloud Console.

Umgebungsbefehle

Der Umgebungsname name unterscheidet sich von der Umgebung ID nur dann, wenn Sie im Umgebungsnamen Leerzeichen oder Großbuchstaben verwenden. Eine Umgebungs-ID besteht aus Kleinbuchstaben, Zahlen und zulässigen Symbolen. Großbuchstaben im Umgebungsnamen werden in der ID in Kleinbuchstaben umgewandelt, Leerzeichen im Umgebungsnamen in Bindestriche.

Ein Umgebungsname darf keine Zeichen enthalten die für Ihre Linux-Shell oder für reguläre Ausdrücke reserviert sind. Unzulässige Zeichen sind geschweifte Klammern ({ }), Klammern, Sternchen (*), spitze Klammern (< >), kaufmännisches Und-Zeichen (&), Prozent (%) und andere Zeichen.

Der Befehl magento-cloud environment:list zeigt Umgebungshierarchien an, während git branch dies nicht tut. Wenn Sie verschachtelte Umgebungen haben, verwenden Sie Folgendes:

magento-cloud environment:list

Umgebung erneut bereitstellen

Trigger einer erneuten Bereitstellung ohne Verwendung einer Push-Benachrichtigung. Überprüfen und bestätigen Sie die Umgebung für die erneute Bereitstellung. Verwenden Sie die erneute Bereitstellung nicht, wenn sich ein Build in einem ausstehenden Status befindet.

magento-cloud environment:redeploy

Beispielantwort:

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
Trigger Der Bereitstellungsprozess beginnt, wenn Sie eine Zusammenführung, einen Push oder eine Synchronisierung Ihrer Umgebung durchführen oder eine manuelle erneute Bereitstellung durchführen, während der sich die Commerce-Anwendung im Wartungsmodus befindet. Für eine Produktionsumgebung empfiehlt Adobe, diese Arbeiten außerhalb der Spitzenzeiten durchzuführen, um Service-Unterbrechungen zu vermeiden.

Git-Befehle

Möglicherweise stellen Sie fest, dass einige dieser Befehle Git-Befehlen ähneln. Die magento-cloud-Befehle stellen eine direkte Verbindung zum Git-basierten Cloud-Projekt mit zusätzlichen Funktionen her. Wenn Sie eine Verzweigung erstellen, ohne die magento-cloud CLI zu verwenden, wird sie nicht „aktiviert“ und wird nicht automatisch erstellt, wenn Sie Änderungen in die Remote-Umgebung pushen. Der magento-cloud CLI-Befehl umfasst die Aktivierung.

Um eine Verzweigung zu erstellen, verwenden Sie den Befehl magento-cloud , damit die Verzweigung aktiviert wird.

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

Für den Status der Verzweigung:

  • Verwenden Sie den Befehl magento-cloud env , um eine Liste der Verzweigungen der Umgebung und ihres Status anzuzeigen: aktiv oder inaktiv.
  • Verwenden Sie den Befehl magento-cloud environment:activate , um eine Umgebungsverzweigung zu aktivieren.

Pushen Sie einen leeren Git-Commit, um einen Trigger für eine Bereitstellung auszuführen. Beispiel:

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

Einige Aktionen, z. B. das Hinzufügen eines Benutzers, führen nicht zur Bereitstellung.

Erstellen einer Umgebungsverzweigung

Die folgenden Schritte zeigen, wie Sie die CLI- und Git-Befehle synonym zur Verwaltung Ihrer lokalen Umgebung verwenden:

  1. Wechseln Sie auf Ihrer lokalen Workstation in Ihr Projektverzeichnis.

  2. Wechseln Sie zum Dateisystembesitzer.

  3. Melden Sie sich bei Ihrem Projekt an.

    code language-bash 
    magento-cloud login

  4. Auflisten der Projekte

    code language-bash 
    magento-cloud project:list

  5. Auflisten der Umgebungen im Projekt. Jede Umgebung enthält eine aktive Git-Verzweigung, die Ihren Code, Ihre Datenbank, Umgebungsvariablen, Konfigurationen und Services enthält.

    code language-bash 
    magento-cloud environment:list
    note note
    NOTE
    Es ist wichtig, den Befehl magento-cloud environment:list zu verwenden, da er Umgebungshierarchien anzeigt, der Befehl git branch dagegen nicht.

  6. Abrufen von Ursprungszweigen, um den neuesten Code zu erhalten.

    code language-bash 
    git fetch origin

  7. Auschecken oder Wechseln zu einer bestimmten Verzweigung und Umgebung.

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

    Git-Befehle checken nur die Git-Verzweigung aus. Der Befehl magento-cloud checkout checkt die Verzweigung aus und wechselt zur aktiven Umgebung.

    note tip
    TIP
    Sie können eine Umgebungsverzweigung mithilfe der magento-cloud environment:branch <environment-name> <parent-environment-ID>-Befehlssyntax erstellen. Es kann einige Zeit dauern, bis eine Umgebungsverzweigung erstellt und aktiviert wird.

  8. Verwenden Sie die Umgebungs-ID, um aktualisierten Code an Ihren lokalen Computer zu übertragen. Dies ist nicht erforderlich, wenn die Verzweigung „Umgebung“ neu ist.

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

  9. (Optional) Erstellen Momentaufnahme der Umgebung als Backup.

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

Aktualisieren der CLI

Die magento-cloud CLI sucht nach verfügbaren Aktualisierungen, wenn Sie sich anmelden. Sie können jedoch mit dem Befehl self:update nach Aktualisierungen suchen. Wenn ein Update verfügbar ist, befolgen Sie die Anweisungen zum Aktualisieren der CLI.

Wenn Ihre magento-cloud-CLI auf dem neuesten Stand ist, wird die folgende Antwort angezeigt:

magento-cloud update

Checking for Magento Cloud CLI updates (current version: X.XX.X)
No updates found
recommendation-more-help