Cloud CLI
magento-cloud CLIは、開発者とシステム管理者がローカル ワークステーションからクラウド インフラストラクチャ プロジェクトおよび環境でAdobe Commerceを管理できるようにするコマンドライン ツールです。
このツールは、追加の自動化機能とプロジェクト管理機能への直接アクセスを提供することで、Cloud Consoleの機能を拡張します。 ツールをローカルにインストールした後は、それを使用してStarter環境とPro統合環境の両方を管理できます。
magento-cloud CLIをインストールするには:
-
ローカルワークステーションで、クラウドプロジェクトを複製するディレクトリに変更します。このディレクトリでは、 ファイルシステム所有者が書き込み アクセスできます。
-
magento-cloudCLIをインストールします。code language-bash curl -sS https://accounts.magento.cloud/cli/installer | php -
Bash プロファイルに
magento-cloudCLIを追加します。code language-bash export PATH=$PATH:$HOME/.magento-cloud/bin -
更新したbash プロファイルをリロードします。
code language-bash . ~/.bash_profile -
CLIを開始するには、
magento-cloudを呼び出し、プロンプトが表示されたらCloud アカウントの資格情報を入力します。code language-bash magento-cloudcode language-none Welcome to Magento Cloud! Please log in using your Magento Cloud account. Your email address or username: -
magento-cloudコマンドがパス内にあることを確認します。 次の例は、使用可能なコマンドの一覧です。code language-bash magento-cloud list
共通コマンド
Adobeは、Cloud統合環境を管理するためにこれらのコマンドを設計し、-p <project-ID> パラメーターを省略できるように、プロジェクトディレクトリからmagento-cloud CLIを実行することをお勧めします。
一般的に使用されるmagento-cloud CLI コマンドの次のリストには、必要なオプションのみが含まれています。 任意のコマンドで--help オプションを使用すると、詳細を確認できます。
magento-cloud loginmagento-cloud listmagento-cloud environment:listmagento-cloud environment:checkoutmagento-cloud environment:merge -emagento-cloud variablesmagento-cloud sshmagento-cloud urlmagento-cloud web環境コマンド
環境 name が環境 ID と異なるのは、環境名にスペースまたは大文字を使用する場合のみです。 環境IDは、すべての小文字、数字、許可された記号で構成されます。 環境名の大文字はIDの小文字に変換され、環境名のスペースはダッシュに変換されます。
環境名には、Linux シェルまたは正規表現用に予約された文字を含めることはできません。 使用できない文字には、中括弧({ })、括弧、アスタリスク (*)、角括弧(< >)、アンパサンド (&)、% (%)などの文字が含まれます。
magento-cloud environment:list コマンドは環境階層を表示しますが、git branchは表示しません。 ネストされた環境がある場合は、次を使用します。
magento-cloud environment:list
環境の再デプロイ
プッシュ通知を使用せずに再デプロイメントをトリガーします。 再デプロイする環境を確認して確認します。 保留状態のビルドがある場合は、redeployを使用しないでください。
magento-cloud environment:redeploy
回答サンプル:
Are you sure you want to redeploy the environment <environment-name>? [Y/n]
Git コマンド
これらのコマンドのいくつかはGit コマンドに似ていることにお気づきでしょう。 magento-cloud コマンドは、追加機能を使用して、Git ベースのCloud プロジェクトに直接接続します。 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 コマンドを交互に使用してローカル環境を管理する方法を示します。
-
ローカル ワークステーションで、プロジェクト ディレクトリに移動します。
-
ファイルシステム所有者に切り替えます。
-
プロジェクトにログインします。
code language-bash magento-cloud login -
プロジェクトのリストを作成。
code language-bash magento-cloud project:list -
プロジェクト内の環境のリスト。 あらゆる環境には、コード、データベース、環境変数、設定、サービスを含むアクティブなGit ブランチが含まれます。
code language-bash magento-cloud environment:listnote NOTE 環境階層が表示されますが、 git branchコマンドは表示されないため、magento-cloud environment:listコマンドを使用することが重要です。 -
オリジン分岐を取得して最新のコードを取得します。
code language-bash git fetch origin -
特定のブランチや環境をチェックアウトするか、切り替えます。
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>コマンド構文を使用して作成できます。 環境ブランチの作成とアクティブ化にはさらに時間がかかる場合があります。 -
環境IDを使用して、更新されたコードをローカルに取り込みます。 環境ブランチが新しい場合、これは必要ありません。
code language-bash git pull origin <environment-ID> -
(オプション)環境の スナップショット をバックアップとして作成します。
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