ドキュメントCommerceクラウドインフラストラクチャー上の Commerce に関するガイド

クラウド CLI

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

作成対象：

  • 管理者
  • 開発者

magento-cloud CLI ツールを使用すると、開発者やシステム管理者は、クラウドのプロジェクトや環境の管理、ルーチンの実行、自動化タスクのローカル実行が可能になります。 magento-cloud CLI は、Cloud Console の機能を拡張します。 ローカルワークステーションに magento-cloud CLI をインストールすると、それを使用してクラウドインフラストラクチャー上のAdobe Commerce Starter および Pro 統合環境を管理できます。

NOTE
これはローカルツールであり、この方法を使用してクラウド環境（読み取り専用）にインストールすることはできません。 デプロイメントワークフロー を通じて、クラウド環境にモジュールのみをインストールできます

magento-cloud CLI をインストールするには:

  1. ローカルワークステーション で、クラウドプロジェクトを複製するディレクトリと、 ファイルシステムの所有者が 書き込み アクセス権を持つディレクトリに変更します。

  2. magento-cloud CLI をインストールします。

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

  3. bash プロファイ magento-cloud に CLI を追加します。

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

  4. 更新した bash プロファイルを再読み込みします。

    code language-bash 
    . ~/.bash_profile

  5. CLI を開始するには、magento-cloud を呼び出し、プロンプトが表示されたらクラウドアカウントの資格情報を入力します。

    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. magento-cloud コマンドがパス内にあることを確認します。 次の例は、使用可能なコマンドを示しています。

    code language-bash 
    magento-cloud list

一般的なコマンド

Adobeでは、これらのコマンドを設計してクラウド統合環境を管理し、-p <project-ID> パラメーターを省略できるように、プロジェクトディレクトリから magento-cloud CLI を実行することをお勧めします。

一般的に使用される magento-cloud CLI コマンドの次のリストには、必要なオプションのみが含まれています。 --help オプションを任意のコマンドと共に使用すると、詳細を確認できます。

コマンド
説明
magento-cloud login
プロジェクトにログインします。
magento-cloud list
CLI ツールで使用可能なコマンドを一覧表示します。
magento-cloud environment:list
現在のプロジェクトの環境をリストします。
magento-cloud environment:checkout
既存の環境をチェックアウトします。
magento-cloud environment:merge -e
この環境の変更をその親と結合します。
magento-cloud variables
この環境のリスト変数。
magento-cloud ssh
SSH を使用してリモート環境に接続します。
magento-cloud url
ブラウザーでAdobe Commerce ストアフロントを開きます。
magento-cloud web
Cloud Console を開きます。

環境コマンド

環境 name は、環境名にスペースまたは大文字を使用する場合にのみ、環境 ID と異なります。 環境 ID は、すべての小文字、数字、許可された記号で構成されます。 環境名の大文字は、ID では小文字に変換され、環境名のスペースはダッシュに変換されます。

環境名には、Linux シェルまたは正規表現で予約されている文字を含めることができません 使用できません。 禁止されている文字には、中括弧（{ }）、括弧、アスタリスク（*）、山括弧（< >）、アンパサンド（&）、パーセント（%）、その他の文字があります。

magento-cloud environment:list コマンドは環境階層を表示しますが、git branch は表示しません。 ネストされた環境がある場合は、次を使用します。

magento-cloud environment:list

環境の再デプロイ

プッシュを使用せずに再デプロイメントをトリガーします。 再デプロイする環境を検証し、確認します。 保留状態のビルドがある場合は、再デプロイを使用しません。

magento-cloud environment:redeploy

応答の例：

Are you sure you want to redeploy the environment <environment-name>? [Y/n]
WARNING
デプロイメントプロセスは、環境のマージ、プッシュまたは同期化を実行するとき、または Commerce アプリケーションがメンテナンスモードである場合に手動で再デプロイをトリガーするときに開始されます。 実稼動環境の場合、Adobeは、サービスが中断されないように、この作業をピーク外の時間に完了することをお勧めします。

Git コマンド

これらのコマンドの一部は Git コマンドに似ていることに気付くかもしれません。 magento-cloud のコマンドは、追加機能を使用して Git ベースのクラウドプロジェクトに直接接続します。 magento-cloud CLI を使用せずにブランチを作成した場合、ブランチは「アクティブ化」されず、変更をリモート環境にプッシュしても自動的にビルドされません。 magento-cloud CLI コマンドにはアクティブ化が含まれます。

分岐を作成するには、magento-cloud コマンドを使用して分岐をアクティブにします。

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

分岐ステータスの場合：

  • magento-cloud env コマンドを使用して、環境ブランチとそのステータス（アクティブまたは非アクティブ）のリストを表示します。
  • magento-cloud environment:activate コマンドを使用して、環境ブランチをアクティベートします。

空の Git コミットをプッシュしてデプロイメントをトリガーにします。 例：

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

ユーザーの追加など、一部のアクションではデプロイメントは発生しません。

環境ブランチの作成

次の手順は、CLI コマンドと Git コマンドを交互に使用してローカル環境を管理する方法を示しています。

  1. ローカルワークステーションで、をプロジェクトディレクトリに変更します。

  2. ファイルシステム所有者に切り替えます。

  3. プロジェクトにログインします。

    code language-bash 
    magento-cloud login

  4. プロジェクトのリストを作成します。

    code language-bash 
    magento-cloud project:list

  5. プロジェクト内の環境をリストします。 すべての環境には、コード、データベース、環境変数、設定およびサービスを含んだアクティブな Git ブランチが含まれています。

    code language-bash 
    magento-cloud environment:list
    note note
    NOTE
    magento-cloud environment:list コマンドは環境階層を表示するのに対して、git branch コマンドは表示しないので、このコマンドを使用することが重要です。

  6. オリジンブランチを取得して最新のコードを取得します。

    code language-bash 
    git fetch origin

  7. 特定のブランチと環境をチェックアウトするか、切り替えます。

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

    Git コマンドは、Git ブランチのみをチェックアウトします。 magento-cloud checkout コマンドは、ブランチをチェックアウトし、アクティブな環境に切り替えます。

    note tip
    TIP
    magento-cloud environment:branch <environment-name> <parent-environment-ID> のコマンド構文を使用して、環境ブランチを作成できます。 環境ブランチの作成とアクティブ化にはさらに時間がかかる場合があります。

  8. 環境 ID を使用して、更新されたコードをローカルに取り込みます。 環境ブランチが新しい場合は、これは必要ありません。

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

  9. （オプション）環境の スナップショットをバックアップとして作成します。

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

CLI の更新

ログイン時に magento-cloud CLI は利用可能な更新をチェックしますが、self:update コマンドを使用すると更新をチェックできます。 更新がある場合は、手順に従って CLI を更新します。

magento-cloud CLI が最新の場合は、次の応答が表示されます。

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