ECE-Tools CLI リファレンス

バージョン: 2002.2.11

このリファレンスには、ece-tools コマンドラインツールを通じて利用できる34のコマンドが含まれています。
最初のリストは、クラウドインフラストラクチャ上のAdobe Commerceでece-tools list コマンドを使用して自動生成されます。

一般

この参照は、アプリケーションコードベースから生成されます。 コンテンツを変更するには、フィードバックを送信してください （右上のリンクを見つけてください）。 貢献度ガイドラインについては、​ コード貢献度を参照してください。

グローバルオプション

--help, -h

指定されたコマンドのヘルプを表示します。 コマンドが指定されていない場合は、list コマンドのdisplay help

--silent

メッセージを出力しない

--quiet, -q

エラーのみが表示されます。 他のすべての出力は抑制されます

--verbose, -v|-vv|-vvv

メッセージの冗長性を上げます。通常の出力は1、詳細な出力は2、デバッグは3

--version, -V

このアプリケーションのバージョンを表示

--ansi

ANSI出力を強制（または – no-ansiを無効にする）

--no-ansi

「 – ansi」オプションを無効にする

--no-interaction, -n

インタラクティブな質問は避けてください

_complete

ece-tools _complete [-s|--shell SHELL] [-i|--input INPUT] [-c|--current CURRENT] [-a|--api-version API-VERSION] [-S|--symfony SYMFONY]

シェル補完の提案を提供する内部コマンド

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--shell, -s

シェルタイプ （“bash”, “fish”, “zsh”）

--input, -i

入力トークンの配列（例：COMP_WORDSまたはargv）

--current, -c

カーソルが置かれている「input」配列のインデックス（例：COMP_CWORD）

--api-version, -a

完了スクリプトのAPI バージョン

--symfony, -S

非推奨

build

ece-tools build

アプリケーションを構築します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

completion

ece-tools completion [--debug] [--] [<shell>]

シェル完了スクリプトをダンプします

The completion command dumps the shell completion script required
to use shell autocompletion (currently, bash, fish, zsh completion are supported).

Static installation
-------------------

Dump the script to a global completion file and restart your shell:

    bin/ece-tools completion  | sudo tee /etc/bash_completion.d/ece-tools

Or dump the script to a local file and source it:

    bin/ece-tools completion  > completion.sh

    # source the file whenever you use the project
    source completion.sh

    # or add this line at the end of your "~/.bashrc" file:
    source /path/to/completion.sh

Dynamic installation
--------------------

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

    eval "$(/var/jenkins/workspace/gendocs-ece-tools-cli/bin/ece-tools completion )"

引数

shell

シェルタイプ （例：「bash」）、環境変数「$SHELL」の値が指定されていない場合は使用されます

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--debug

完了デバッグログのテール

db-dump

ece-tools db-dump [-d|--remove-definers] [-a|--dump-directory DUMP-DIRECTORY] [--] [<databases>...]

データベースのバックアップを作成します。

引数

databases

バックアップ用データベース。 使用可能な値：[ メイン見積もり売上]。 引数の値が指定されていない場合、データベースのバックアップは、MAGENTO_CLOUD_RELATIONSHIP環境変数または.magento.env.yaml設定ファイルのstage.deploy.DATABASE_CONFIGURATION プロパティに格納されている資格情報を使用して作成されます。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--remove-definers, -d

データベースダンプからの定義の削除

--dump-directory, -a

ダンプを保存するための代替ディレクトリの使用

deploy

ece-tools deploy

アプリケーションをデプロイします。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

help

ece-tools help [--format FORMAT] [--raw] [--] [<command_name>]

コマンドのヘルプの表示

The help command displays help for a given command:

  bin/ece-tools help list

You can also output the help in other formats by using the --format option:

  bin/ece-tools help --format=xml list

To display the list of available commands, please use the list command.

引数

command_name

コマンド名

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--format

出力形式（txt、xml、json、md）

--raw

Raw コマンド ヘルプを出力するには

list

ece-tools list [--raw] [--format FORMAT] [--short] [--] [<namespace>]

リストコマンド

The list command lists all commands:

  bin/ece-tools list

You can also display the commands for a specific namespace:

  bin/ece-tools list test

You can also output the information in other formats by using the --format option:

  bin/ece-tools list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

  bin/ece-tools list --raw

引数

namespace

名前空間名

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--raw

Raw コマンドリストを出力するには

--format

出力形式（txt、xml、json、md）

--short

コマンドの引数の記述をスキップするには

patch

ece-tools patch

カスタムパッチを適用します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

post-deploy

ece-tools post-deploy

デプロイ操作の後に実行します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

run

ece-tools run <scenario>...

シナリオを実行します。

引数

scenario

シナリオ

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

backup:list

ece-tools backup:list

バックアップ ファイルのリストを表示します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

backup:restore

ece-tools backup:restore [-f|--force] [--file [FILE]]

重要な設定ファイルを復元します。 バックアップ :listを実行して、バックアップ ファイルのリストを表示します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--force, -f

バックアップの復元中に既存のファイルを上書き

--file

特定のファイル回復パス

build:generate

ece-tools build:generate

ビルドステージに必要なすべてのファイルを生成します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

build:transfer

ece-tools build:transfer

生成されたファイルをinit ディレクトリに転送します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cloud:config:create

ece-tools cloud:config:create <configuration>

指定されたビルド、デプロイ、デプロイ後の変数設定を使用して.magento.env.yaml ファイルを作成します。 既存の.magento.env.yaml ファイルをすべて上書きします。

引数

configuration

JSON形式での設定

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cloud:config:update

ece-tools cloud:config:update <configuration>

指定された設定で既存の.magento.env.yaml ファイルを更新します。 ファイルが存在しない場合は、.magento.env.yaml ファイルを作成します。

引数

configuration

JSON形式での設定

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cloud:config:validate

ece-tools cloud:config:validate

.magento.env.yaml設定ファイルを検証します

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

config:dump

ece-tools config:dumpdump

静的コンテンツのデプロイメント用のダンプ設定。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cron:disable

ece-tools cron:disable

すべてのMagento cron プロセスを無効にし、実行中のすべてのプロセスを終了します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cron:enable

ece-tools cron:enable

Magento cron プロセスを有効にします。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cron:kill

ece-tools cron:kill

すべてのMagento cron プロセスを終了します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

cron:unlock

ece-tools cron:unlock [--job-code [JOB-CODE]]

「実行中」状態で停止したcron ジョブのロックを解除します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--job-code

ロックを解除するCron ジョブ コード。

dev:generate:schema-error

ece-tools dev:generate:schema-error

schema.error.yaml ファイルからdist/error-codes.md ファイルを生成します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

dev:git:update-composer

ece-tools dev:git:update-composer

Gitからデプロイメント用のコンポーザーを更新します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

env:config:show

ece-tools env:config:show [<variable>...]

エンコードされたクラウド設定環境変数を表示します。

引数

variable

表示する環境変数、可能なオプション：サービス、ルート、変数

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

error:show

ece-tools error:show [-j|--json] [--] [<error-code>]

エラーID別のエラーに関する情報または前回のデプロイメントのすべてのエラーに関する情報を表示します。

引数

error-code

エラーコード （コマンドが渡されない場合）最後のデプロイメントからのすべてのエラーに関する情報を表示

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

--json, -j

JSON形式で結果を取得するために使用します

module:refresh

ece-tools module:refresh

設定を更新して、新しく追加されたモジュールを有効にします。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

schema:generate

ece-tools schema:generate

スキーマ *.dist ファイルを生成します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

wizard:ideal-state

ece-tools wizard:ideal-state

構成の理想的な状態を検証します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

wizard:master-slave

ece-tools wizard:master-slave

マスタースレーブ設定を検証します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

wizard:scd-on-build

ece-tools wizard:scd-on-build

ビルド設定でSCDを検証します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

wizard:scd-on-demand

ece-tools wizard:scd-on-demand

オンデマンド設定のSCDを検証します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

wizard:scd-on-deploy

ece-tools wizard:scd-on-deploy

デプロイ設定時にSCDを検証します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。

wizard:split-db-state

ece-tools wizard:split-db-state

DBを分割する機能と、DBが既に分割されているかどうかを確認します。

オプション

グローバルオプションについては、​ グローバルオプション ​を参照してください。