[PaaS uniquement]{class="badge informative" title="S’applique uniquement aux projets Adobe Commerce on Cloud (infrastructure PaaS gérée par Adobe) et aux projets On-premise."}

Référence de l'interface de ligne de commande ECE-Tools

Version : 2002.2.7

Cette référence contient 34 commandes disponibles via l’outil de ligne de commande ece-tools.
La liste initiale est générée automatiquement à l’aide de la commande ece-tools list dans Adobe Commerce sur l’infrastructure cloud.

Général

Cette référence est générée à partir de la base de code de l’application. Pour modifier le contenu, Donnez-nous votre avis (recherchez le lien en haut à droite). Pour obtenir des instructions sur les contributions, voir Coder les contributions.

Options globales

--help, -h

Afficher l’aide pour la commande donnée. Lorsqu’aucune commande n’est fournie, afficher l’aide pour la commande de liste

--silent

Ne pas générer de message

--quiet, -q

Seules les erreurs s’affichent. Toute autre sortie est supprimée

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

Augmentez la verbosité des messages : 1 pour une sortie normale, 2 pour une sortie plus verbose et 3 pour le débogage

--version, -V

Afficher cette version de l'application

--ansi

Forcer (ou désactiver —no-ansi) la sortie ANSI

--no-ansi

Ignorer l’option « —ansi »

--no-interaction, -n

Ne posez aucune question interactive

_complete

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

Commande interne pour fournir des suggestions d'achèvement du shell

Options

Pour les options globales, voir Options globales.

--shell, -s

Le type de coque (« bash », « fish », « zsh »)

--input, -i

Tableau de jetons d’entrée (par exemple COMP_WORDS ou argv)

--current, -c

Index du tableau « input » dans lequel se trouve le curseur (par exemple COMP_CWORD)

--api-version, -a

Version API du script d'achèvement

--symfony, -S

obsolète

build

ece-tools build

Construit l’application.

Options

Pour les options globales, voir Options globales.

completion

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

Vider le script de fin du 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 )"

Arguments

shell

Le type de shell (par exemple « bash »), la valeur de la variable d'environnement « $SHELL » sera utilisée si elle n'est pas indiquée

Options

Pour les options globales, voir Options globales.

--debug

Faire apparaître dans le journal de débogage l’achèvement

db-dump

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

Crée des sauvegardes de base de données.

Arguments

databases

Bases de données pour la sauvegarde. Valeurs disponibles : [vente du devis principal]. Si la valeur de l’argument n’est pas spécifiée, les sauvegardes de la base de données sont créées à l’aide des informations d’identification stockées dans la variable d’environnement MAGENTO_CLOUD_RELATIONSHIP ou/et la propriété stage.deploy.DATABASE_CONFIGURATION du fichier de configuration .magento.env.yaml.

Options

Pour les options globales, voir Options globales.

--remove-definers, -d

Supprimer les définisseurs de l'image mémoire de la base de données

--dump-directory, -a

Utiliser un autre répertoire pour enregistrer le vidage

deploy

ece-tools deploy

Déploie l’application.

Options

Pour les options globales, voir Options globales.

help

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

Affichage de l’aide d’une commande

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.

Arguments

command_name

Nom de la commande

Options

Pour les options globales, voir Options globales.

--format

Le format de sortie (txt, xml, json ou md)

--raw

Pour générer l’aide de la commande brute

list

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

Commandes de liste

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

Arguments

namespace

Nom de l’espace de noms

Options

Pour les options globales, voir Options globales.

--raw

Pour générer la liste de commandes brute

--format

Le format de sortie (txt, xml, json ou md)

--short

Pour ignorer la description des arguments des commandes

patch

ece-tools patch

Applique des correctifs personnalisés.

Options

Pour les options globales, voir Options globales.

post-deploy

ece-tools post-deploy

Effectue après les opérations de déploiement.

Options

Pour les options globales, voir Options globales.

run

ece-tools run <scenario>...

Exécuter scénario(s).

Arguments

scenario

Scénario(s)

Options

Pour les options globales, voir Options globales.

backup:list

ece-tools backup:list

Affiche la liste des fichiers de sauvegarde.

Options

Pour les options globales, voir Options globales.

backup:restore

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

Restaurez les fichiers de configuration importants. Exécutez la sauvegarde :list pour afficher la liste des fichiers de sauvegarde.

Options

Pour les options globales, voir Options globales.

--force, -f

Écraser les fichiers existants lors de la restauration d’une sauvegarde

--file

Chemin de récupération de fichier spécifique

build:generate

ece-tools build:generate

Génère tous les fichiers nécessaires à l’étape de création.

Options

Pour les options globales, voir Options globales.

build:transfer

ece-tools build:transfer

Transfère les fichiers générés dans le répertoire init.

Options

Pour les options globales, voir Options globales.

cloud:config:create

ece-tools cloud:config:create <configuration>

Crée un fichier .magento.env.yaml avec la configuration de variable de build, de déploiement et de post-déploiement spécifiée. Remplace tout fichier .magento.env.yaml existant.

Arguments

configuration

Configuration au format JSON

Options

Pour les options globales, voir Options globales.

cloud:config:update

ece-tools cloud:config:update <configuration>

Met à jour le fichier .magento.env.yaml existant avec la configuration spécifiée. Crée .magento.env.yaml fichier s'il n'existe pas.

Arguments

configuration

Configuration au format JSON

Options

Pour les options globales, voir Options globales.

cloud:config:validate

ece-tools cloud:config:validate

Valide .magento.env.yaml fichier de configuration

Options

Pour les options globales, voir Options globales.

config:dump

ece-tools config:dumpdump

Configuration du vidage pour le déploiement de contenu statique.

Options

Pour les options globales, voir Options globales.

cron:disable

ece-tools cron:disable

Désactivez tous les processus cron de Magento et arrêtez tous les processus en cours d’exécution.

Options

Pour les options globales, voir Options globales.

cron:enable

ece-tools cron:enable

Active les processus Magento cron.

Options

Pour les options globales, voir Options globales.

cron:kill

ece-tools cron:kill

Termine tous les processus cron de Magento.

Options

Pour les options globales, voir Options globales.

cron:unlock

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

Déverrouillez les tâches cron qui sont bloquées au statut « en cours d’exécution ».

Options

Pour les options globales, voir Options globales.

--job-code

Code de traitement cron à déverrouiller.

dev:generate:schema-error

ece-tools dev:generate:schema-error

Génère le fichier dist/error-codes.md à partir du fichier schema.error.yaml.

Options

Pour les options globales, voir Options globales.

dev:git:update-composer

ece-tools dev:git:update-composer

Met à jour le compositeur pour le déploiement à partir de Git.

Options

Pour les options globales, voir Options globales.

env:config:show

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

Affichez les variables d’environnement de configuration cloud codées.

Arguments

variable

Variables d’environnement à afficher, options possibles : services, itinéraires, variables

Options

Pour les options globales, voir Options globales.

error:show

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

Affiche des informations sur l’erreur par ID d’erreur ou des informations sur toutes les erreurs du dernier déploiement.

Arguments

error-code

Le code d’erreur, s’il n’est pas transmis, affiche des informations sur toutes les erreurs du dernier déploiement

Options

Pour les options globales, voir Options globales.

--json, -j

Utilisé pour obtenir un résultat au format JSON

module:refresh

ece-tools module:refresh

Actualise la configuration pour activer les modules nouvellement ajoutés.

Options

Pour les options globales, voir Options globales.

schema:generate

ece-tools schema:generate

Génère le fichier schema *.dist.

Options

Pour les options globales, voir Options globales.

wizard:ideal-state

ece-tools wizard:ideal-state

Vérifie l’état idéal de la configuration.

Options

Pour les options globales, voir Options globales.

wizard:master-slave

ece-tools wizard:master-slave

Vérifie la configuration maître-esclave.

Options

Pour les options globales, voir Options globales.

wizard:scd-on-build

ece-tools wizard:scd-on-build

Vérifie le SCD sur la configuration de la version.

Options

Pour les options globales, voir Options globales.

wizard:scd-on-demand

ece-tools wizard:scd-on-demand

Vérifie la configuration SCD à la demande.

Options

Pour les options globales, voir Options globales.

wizard:scd-on-deploy

ece-tools wizard:scd-on-deploy

Vérifie le SCD lors de la configuration du déploiement.

Options

Pour les options globales, voir Options globales.

wizard:split-db-state

ece-tools wizard:split-db-state

Vérifie la possibilité de fractionner la base de données et si cette dernière a déjà été fractionnée ou non.

Options

Pour les options globales, voir Options globales.