[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 Cloud

Version : 1.47.0

Cette référence contient 123 commandes disponibles via l’outil de ligne de commande magento-cloud.
La liste initiale est générée automatiquement à l’aide de la commande magento-cloud 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, vous pouvez mettre à jour le code source pour l’implémentation de commande correspondante dans le référentiel codebase et envoyer vos modifications pour révision. Une autre méthode consiste à Nous faire part de vos commentaires (recherchez le lien en haut à droite). Pour obtenir des instructions sur les contributions, voir Coder les contributions.

Options globales

--help, -h

Afficher ce message d'aide

--version, -V

Afficher cette version de l'application

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

Augmenter la verbosité des messages

--quiet, -q

Imprimer uniquement la sortie nécessaire ; supprimer les autres messages et erreurs. Cela implique : aucune interaction. Il est ignoré en mode verbeux.

--yes, -y

Répondez « oui » aux questions de confirmation ; acceptez la valeur par défaut pour les autres questions ; désactivez l’interaction

--no-interaction

Ne posez pas de questions interactives ; acceptez les valeurs par défaut. Équivalent à l’utilisation de la variable d’environnement : MAGENTO_CLOUD_CLI_NO_INTERACTION=1

clear-cache

magento-cloud cc

Effacer le cache de l’interface de ligne de commande

Options

Pour les options globales, voir Options globales.

console

magento-cloud web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Ouvrez le projet dans la console

Options

Pour les options globales, voir Options globales.

--browser

Navigateur à utiliser pour ouvrir l’URL. Réglez 0 sur aucun.

--pipe

Générez l’URL dans stdout.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

decode

magento-cloud decode [-P|--property PROPERTY] [--] <value>

Décoder une chaîne codée telle que MAGENTO_CLOUD_VARIABLES

Arguments

value

Valeur de variable à décoder

Options

Pour les options globales, voir Options globales.

--property, -P

Propriété à afficher dans la variable

docs

magento-cloud docs [--browser BROWSER] [--pipe] [--] [<search>]...

Ouvrir la documentation en ligne

Arguments

search

Termes de recherche

Options

Pour les options globales, voir Options globales.

--browser

Navigateur à utiliser pour ouvrir l’URL. Réglez 0 sur aucun.

--pipe

Générez l’URL dans stdout.

help

magento-cloud help [--format FORMAT] [--raw] [--] [<command_name>]

Affiche l’aide d’une commande

The help command displays help for a given command:

  magento-cloud help list

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

  magento-cloud help --format=json 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

Format de sortie (txt, json ou md)

--raw

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

list

magento-cloud list [--raw] [--format FORMAT] [--all] [--] [<namespace>]

Répertorie les commandes

The list command lists all commands:

  magento-cloud list

You can also display the commands for a specific namespace:

  magento-cloud list project

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

  magento-cloud list --format=xml

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

  magento-cloud list --raw

Arguments

command

Commande à exécuter

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)

--all

Afficher toutes les commandes, y compris les commandes masquées

multi

magento-cloud multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [--] <cmd> (<cmd>)...

Exécuter une commande sur plusieurs projets

Arguments

cmd

Commande à exécuter

Options

Pour les options globales, voir Options globales.

--projects, -p

Liste d’identifiants de projet, séparés par des virgules et/ou des espaces

--continue

Continuer à exécuter les commandes même si une exception est rencontrée

--sort

Une propriété selon laquelle trier la liste des options du projet

--reverse

Inverser l’ordre des options du projet

activity:cancel

magento-cloud activity:cancel [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

Annuler une activité

Arguments

id

Identifiant de l’activité. La valeur par défaut est l’activité annulable la plus récente.

Options

Pour les options globales, voir Options globales.

--type, -t

Filtrez par type (lors de la sélection d’une activité par défaut). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour le type, par exemple « %var% » pour sélectionner des activités liées aux variables.

--exclude-type, -x

Exclure par type (lors de la sélection d’une activité par défaut). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure des types.

--all, -a

Vérifier les activités récentes dans tous les environnements (lors de la sélection d’une activité par défaut)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

activity:get

magento-cloud activity:get [-P|--property PROPERTY] [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<id>]

Afficher des informations détaillées sur une seule activité

Arguments

id

Identifiant de l’activité. La valeur par défaut est l’activité la plus récente.

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété à afficher

--type, -t

Filtrez par type (lors de la sélection d’une activité par défaut). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour le type, par exemple « %var% » pour sélectionner des activités liées aux variables.

--exclude-type, -x

Exclure par type (lors de la sélection d’une activité par défaut). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure des types.

--state

Filtrer par état (lors de la sélection d’une activité par défaut) : en cours, en attente, terminé ou annulé. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--result

Filtrer par résultat (lors de la sélection d’une activité par défaut) : succès ou échec

--incomplete, -i

Incluez uniquement les activités incomplètes (lors de la sélection d’une activité par défaut). Il s’agit d’un raccourci de —state=in_progress,pending

--all, -a

Vérifier les activités récentes dans tous les environnements (lors de la sélection d’une activité par défaut)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

activity:list

magento-cloud activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Obtention d’une liste d’activités pour un environnement ou un projet

Options

Pour les options globales, voir Options globales.

--type, -t

Filtrer les activités par type Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. La première partie du nom de l’activité peut être omise ; par exemple, « cron » peut sélectionner les activités « environment.cron ». Les caractères % ou * peuvent être utilisés comme caractère générique, par exemple « %var% » pour sélectionner des activités liées aux variables.

--exclude-type, -x

Exclure les activités par type. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. La première partie du nom de l’activité peut être omise ; par exemple, « cron » peut exclure les activités « environment.cron ». Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure des types.

--limit

Limiter le nombre de résultats affichés

--start

Seules les activités créées avant cette date seront répertoriées

--state

Filtrer les activités par état : en cours, en attente, terminées ou annulées. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--result

Filtrer les activités par résultat : succès ou échec

--incomplete, -i

Répertorier uniquement les activités incomplètes

--all, -a

Liste des activités dans tous les environnements

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : id*, créé*, description*, progression*, état*, résultat*, terminé, environnements, time_build, time_deploy, time_execute, time_wait, type (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

activity:log

magento-cloud activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

Affichage du journal d’une activité

Arguments

id

Identifiant de l’activité. La valeur par défaut est l’activité la plus récente.

Options

Pour les options globales, voir Options globales.

--refresh

Intervalle d’actualisation des activités (secondes). Définissez sur 0 pour désactiver l’actualisation.

--timestamps, -t

Afficher un horodatage en regard de chaque message

--type

Filtrez par type (lors de la sélection d’une activité par défaut). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour le type, par exemple « %var% » pour sélectionner des activités liées aux variables.

--exclude-type, -x

Exclure par type (lors de la sélection d’une activité par défaut). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure des types.

--state

Filtrer par état (lors de la sélection d’une activité par défaut) : en cours, en attente, terminé ou annulé. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--result

Filtrer par résultat (lors de la sélection d’une activité par défaut) : succès ou échec

--incomplete, -i

Incluez uniquement les activités incomplètes (lors de la sélection d’une activité par défaut). Il s’agit d’un raccourci de —state=in_progress,pending

--all, -a

Vérifier les activités récentes dans tous les environnements (lors de la sélection d’une activité par défaut)

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

app:config-get

magento-cloud app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]

Affichage de la configuration d’une application

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété de configuration à afficher

--refresh

Actualisation du cache

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--identity-file, -i

[Option obsolète, n’est plus utilisée]

app:list

magento-cloud apps [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Liste des applications dans le projet

Options

Pour les options globales, voir Options globales.

--refresh

Actualisation du cache

--pipe

Générer une liste de noms d’application uniquement

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : nom*, type*, disque, chemin, taille (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

auth:api-token-login

magento-cloud auth:api-token-login

Connectez-vous à Magento Cloud à l’aide d’un jeton API

Use this command to log in to your Magento Cloud account using an API token.

You can create an account at:
    https://business.adobe.com/products/magento/magento-commerce.html

If you have an account, but you do not already have an API token, you can create one here:
    https://accounts.magento.cloud/user/api-tokens

Alternatively, to log in to the CLI with a browser, run:
    magento-cloud auth:browser-login

Options

Pour les options globales, voir Options globales.

auth:browser-login

magento-cloud login [-f|--force] [--method METHOD] [--max-age MAX-AGE] [--browser BROWSER] [--pipe]

Connectez-vous à Magento Cloud via un navigateur

Use this command to log in to the Magento Cloud CLI using a web browser.

It launches a temporary local website which redirects you to log in if
necessary, and then captures the resulting authorization code.

Your system's default browser will be used. You can override this using the
--browser option.

Alternatively, to log in using an API token (without a browser), run:
magento-cloud auth:api-token-login

To authenticate non-interactively, configure an API token using the
MAGENTO_CLOUD_CLI_TOKEN environment variable.

Options

Pour les options globales, voir Options globales.

--force, -f

Reconnectez-vous, même si vous êtes déjà connecté

--method

Exiger des méthodes d’authentification spécifiques

--max-age

Âge maximal (en secondes) de la session d’authentification web

--browser

Navigateur à utiliser pour ouvrir l’URL. Réglez 0 sur aucun.

--pipe

Générez l’URL dans stdout.

auth:info

magento-cloud auth:info [--no-auto-login] [-P|--property PROPERTY] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [<property>]

Afficher les informations de votre compte

Arguments

property

La propriété de compte à afficher

Options

Pour les options globales, voir Options globales.

--no-auto-login

Ignore la connexion automatique. Si vous n’êtes pas connecté, rien ne sera généré et le code de sortie sera 0, en supposant qu’il n’y ait aucune autre erreur.

--property, -P

La propriété de compte à afficher (syntaxe alternative)

--refresh

Actualisation du cache

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

auth:logout

magento-cloud logout [-a|--all] [--other]

Déconnectez-vous de Magento Cloud

Options

Pour les options globales, voir Options globales.

--all, -a

Se déconnecter de toutes les sessions locales

--other

Se déconnecter des autres sessions locales

autoscaling:get

magento-cloud autoscaling [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Afficher la configuration de mise à l’échelle automatique des applications et des programmes de travail sur un environnement

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : service*, mesure*, direction*, seuil*, durée*, activé*, nombre_d’instances*, recharge, instances_max, instances_min (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

autoscaling:set

magento-cloud autoscaling:set [-s|--service SERVICE] [-m|--metric METRIC] [--enabled ENABLED] [--threshold-up THRESHOLD-UP] [--duration-up DURATION-UP] [--cooldown-up COOLDOWN-UP] [--threshold-down THRESHOLD-DOWN] [--duration-down DURATION-DOWN] [--cooldown-down COOLDOWN-DOWN] [--instances-min INSTANCES-MIN] [--instances-max INSTANCES-MAX] [--dry-run] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Définir la configuration de mise à l’échelle automatique des applications ou des programmes de travail dans un environnement

Configure automatic scaling for apps or workers in an environment.

You can also configure resources statically by running: magento-cloud resources:set

Options

Pour les options globales, voir Options globales.

--service, -s

Nom de l’application ou du programme de travail pour lequel configurer la mise à l’échelle automatique

--metric, -m

Nom de la mesure à utiliser pour déclencher la mise à l’échelle automatique

--enabled

Activer la mise à l’échelle automatique en fonction de la mesure donnée

--threshold-up

Seuil au-delà duquel le service sera étendu

--duration-up

Durée pendant laquelle la mesure est évaluée par rapport au seuil de mise à l’échelle

--cooldown-up

Durée d’attente avant de tenter une mise à l’échelle supplémentaire après un événement de mise à l’échelle

--threshold-down

Seuil en dessous duquel le service sera réduit

--duration-down

Durée pendant laquelle la mesure est évaluée par rapport au seuil de réduction

--cooldown-down

Durée d’attente avant d’essayer de réduire davantage après un événement de mise à l’échelle

--instances-min

Nombre minimum d’instances qui seront réduites à

--instances-max

Nombre maximal d’instances qui seront mises à l’échelle

--dry-run

Afficher les modifications qui seraient apportées, sans rien changer

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

blackfire:setup

magento-cloud blackfire:setup [--server_id SERVER_ID] [--server_token SERVER_TOKEN] [-p|--project PROJECT] [-W|--no-wait] [--wait]

Configuration de l’intégration Blackfire.io pour le projet

Options

Pour les options globales, voir Options globales.

--server_id

Identifiant du serveur

--server_token

Jeton du serveur

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

certificate:add

magento-cloud certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-W|--no-wait] [--wait]

Ajouter un certificat SSL au projet

Options

Pour les options globales, voir Options globales.

--cert

Chemin d’accès au fichier de certificat

--key

Chemin d’accès au fichier de clé privée du certificat

--chain

Chemin d’accès au fichier de chaîne de certificats

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

certificate:delete

magento-cloud certificate:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] <id>

Supprimer un certificat du projet

Arguments

id

L’identifiant du certificat (ou son début)

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

certificate:get

magento-cloud certificate:get [-P|--property PROPERTY] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--] <id>

Afficher un certificat

Arguments

id

L’identifiant du certificat (ou son début)

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété de certificat à afficher

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

certificate:list

magento-cloud certificates [--domain DOMAIN] [--exclude-domain EXCLUDE-DOMAIN] [--issuer ISSUER] [--only-auto] [--no-auto] [--ignore-expiry] [--only-expired] [--no-expired] [--pipe-domains] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

Liste des certificats de projet

Options

Pour les options globales, voir Options globales.

--domain

Filtrer par nom de domaine (recherche non sensible à la casse)

--exclude-domain

Exclure des certificats, correspondance par nom de domaine (recherche non sensible à la casse)

--issuer

Filtrer par émetteur

--only-auto

Afficher uniquement les certificats configurés automatiquement

--no-auto

Afficher uniquement les certificats ajoutés manuellement

--ignore-expiry

Afficher les certificats expirés et non expirés

--only-expired

Afficher uniquement les certificats expirés

--no-expired

Afficher uniquement les certificats non expirés (par défaut)

--pipe-domains

Renvoie uniquement une liste de noms de domaine couverts par les certificats

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : créé, domaines, expiration, id, émetteur. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

commit:get

magento-cloud commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--] [<commit>]

Afficher les détails de validation

Arguments

commit

La validation SHA. Cette méthode accepte également les suffixes « HEAD », et signe d’insertion (^) ou tilde (~) pour les validations parentes.

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété commit à afficher.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

commit:list

magento-cloud commits [--limit LIMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<commit>]

Liste des validations

Arguments

commit

La validation Git de départ SHA. Cette méthode accepte également les suffixes « HEAD », et signe d’insertion (^) ou tilde (~) pour les validations parentes.

Options

Pour les options globales, voir Options globales.

--limit

Nombre de validations à afficher.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : auteur, date, partage, résumé. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

db:dump

magento-cloud db:dump [--schema SCHEMA] [-f|--file FILE] [-d|--directory DIRECTORY] [-z|--gzip] [-t|--timestamp] [-o|--stdout] [--table TABLE] [--exclude-table EXCLUDE-TABLE] [--schema-only] [--charset CHARSET] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP]

Créer une image mémoire locale de la base distante

Options

Pour les options globales, voir Options globales.

--schema

Le schéma à vider. Omettez d’utiliser le schéma par défaut (généralement « principal »).

--file, -f

Nom de fichier personnalisé pour l’image mémoire

--directory, -d

Un répertoire personnalisé pour l’image mémoire

--gzip, -z

Compresser l’image mémoire à l’aide de gzip

--timestamp, -t

Ajoutez une date et une heure au nom du fichier de vidage

--stdout, -o

Sortie vers STDOUT au lieu d'un fichier

--table

Table(s) à inclure

--exclude-table

Table(s) à exclure

--schema-only

Ne vider que les schémas, pas de données

--charset

Encodage du jeu de caractères pour l’image mémoire

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--relationship, -r

La relation de service à utiliser

db:sql

magento-cloud sql [--raw] [--schema SCHEMA] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [--] [<query>]

Exécuter SQL sur la base distante

Arguments

query

Instruction SQL à exécuter

Options

Pour les options globales, voir Options globales.

--raw

Produire une sortie brute et non tabulaire

--schema

Schéma à utiliser. Omettez d’utiliser le schéma par défaut (généralement « principal »). Transmettez une chaîne vide pour ne pas utiliser de schéma.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--relationship, -r

La relation de service à utiliser

domain:add

magento-cloud domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [--attach ATTACH] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

Ajouter un nouveau domaine au projet

Arguments

name

Le nom de domaine

Options

Pour les options globales, voir Options globales.

--cert

Chemin d’accès à un fichier de certificat personnalisé

--key

Chemin d’accès à la clé privée pour le certificat personnalisé

--chain

Chemin d’accès aux fichiers de chaîne pour le certificat personnalisé

--attach

Domaine de production que celui-ci remplace dans les itinéraires de l’environnement. Requis pour les domaines d’environnement hors production.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

domain:delete

magento-cloud domain:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

Supprimer un domaine du projet

Arguments

name

Le nom de domaine

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

domain:get

magento-cloud domain:get [-P|--property PROPERTY] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<name>]

Afficher des informations détaillées pour un domaine

Arguments

name

Le nom de domaine

Options

Pour les options globales, voir Options globales.

--property, -P

Propriété de domaine à afficher

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

domain:list

magento-cloud domains [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Obtenir une liste de tous les domaines

Options

Pour les options globales, voir Options globales.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : name*, ssl*, created_at*, registered_name, replace_for, type, updated_at (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

domain:update

magento-cloud domain:update [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

Mise à jour d’un domaine

Arguments

name

Le nom de domaine

Options

Pour les options globales, voir Options globales.

--cert

Chemin d’accès à un fichier de certificat personnalisé

--key

Chemin d’accès à la clé privée pour le certificat personnalisé

--chain

Chemin d’accès aux fichiers de chaîne pour le certificat personnalisé

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:activate

magento-cloud environment:activate [--parent PARENT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

Activation d’un environnement

Arguments

environment

Le ou les environnements à activer

Options

Pour les options globales, voir Options globales.

--parent

Définir un nouveau parent d’environnement avant l’activation

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:branch

magento-cloud branch [--title TITLE] [--type TYPE] [--no-clone-parent] [--no-checkout] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<id>] [<parent>]

Branchement d’un environnement

Arguments

id

L’identifiant (nom de la branche) du nouvel environnement

parent

Le parent du nouvel environnement

Options

Pour les options globales, voir Options globales.

--title

Titre du nouvel environnement

--type

Type du nouvel environnement

--no-clone-parent

Ne pas cloner les données de l’environnement parent

--no-checkout

Ne pas extraire la branche localement

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:checkout

magento-cloud checkout [<id>]

Extraction d’un environnement

Arguments

id

Identifiant de l’environnement à extraire. Par exemple : « sprint2 »

Options

Pour les options globales, voir Options globales.

environment:delete

magento-cloud environment:delete [--delete-branch] [--no-delete-branch] [--type TYPE] [-t|--only-type ONLY-TYPE] [--exclude EXCLUDE] [--exclude-type EXCLUDE-TYPE] [--inactive] [--status STATUS] [--only-status ONLY-STATUS] [--exclude-status EXCLUDE-STATUS] [--merged] [--allow-delete-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

Supprimer un ou plusieurs environnements

When a Magento Cloud environment is deleted, it will become "inactive": it will
exist only as a Git branch, containing code but no services, databases nor
files.

This command allows you to delete environments as well as their Git branches.

Arguments

environment

Environnement(s) à supprimer. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

Options

Pour les options globales, voir Options globales.

--delete-branch

Supprimer la ou les branches Git pour les environnements inactifs, sans confirmation

--no-delete-branch

Ne supprimez aucune branche Git (environnements inactifs).

--type

Supprimer tous les environnements d’un type (en les ajoutant aux autres sélectionnés) Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--only-type, -t

Seuls les environnements de suppression d’un type spécifique Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--exclude

Environnement(s) à supprimer. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--exclude-type

Type(s) d’environnement pour lequel(lesquels) ne pas supprimer Les valeurs peuvent être fractionnées par des virgules (par exemple « a, b, c ») et/ou des espaces.

--inactive

Supprimer tous les environnements inactifs (en les ajoutant aux autres sélectionnés)

--status

Supprimer tous les environnements d’un statut (en les ajoutant aux autres sélectionnés) Les valeurs peuvent être fractionnées par des virgules (par exemple « a, b, c ») et/ou des espaces.

--only-status

Seuls les environnements de suppression ayant un statut spécifique Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--exclude-status

Statut(s) d’environnement pour lequel/lesquels ne pas supprimer Les valeurs peuvent être fractionnées par des virgules (par exemple « a, b, c ») et/ou des espaces.

--merged

Supprimer tous les environnements fusionnés (en les ajoutant aux autres sélectionnés)

--allow-delete-parent

Autoriser la suppression des environnements ayant des enfants

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:deploy

magento-cloud deploy [-s|--strategy STRATEGY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Déploiement des modifications intermédiaires d’un environnement

Options

Pour les options globales, voir Options globales.

--strategy, -s

La stratégie de déploiement, arrêter le démarrage (par défaut, redémarrer avec un arrêt) ou en continu (aucun temps d’arrêt)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:deploy:type

magento-cloud environment:deploy:type [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<type>]

Afficher ou définir le type de déploiement de l’environnement

Choose automatic (the default) if you want your changes to be deployed immediately as they are made.
Choose manual to have changes staged until you trigger a deployment (including changes to code, variables, domains and settings).

Arguments

type

Le type de déploiement de l’environnement : automatique ou manuel.

Options

Pour les options globales, voir Options globales.

--pipe

Générer le type de déploiement en sortie stdout

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:http-access

magento-cloud httpaccess [--access ACCESS] [--auth AUTH] [--enabled ENABLED] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Mise à jour des paramètres d’accès HTTP pour un environnement

Options

Pour les options globales, voir Options globales.

--access

Restriction d’accès au format « autorisation :address. Utilisez 0 pour effacer toutes les adresses.

--auth

Informations d’identification d’authentification de base HTTP au format « nom d’utilisateur :password ». Utilisez 0 pour effacer toutes les informations d’identification.

--enabled

Indique si le contrôle d’accès doit être activé : 1 pour activer, 0 pour désactiver

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:info

magento-cloud environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]

Lire ou définir des propriétés pour un environnement

Arguments

property

Nom de la propriété

value

Définissez une nouvelle valeur pour la propriété

Options

Pour les options globales, voir Options globales.

--refresh

Actualisation du cache

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:init

magento-cloud environment:init [--profile PROFILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <url>

Initialisation d’un environnement à partir d’un référentiel Git public

Arguments

url

Une URL vers un référentiel Git

Options

Pour les options globales, voir Options globales.

--profile

Nom du profil

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:list

magento-cloud environments [-I|--no-inactive] [--status STATUS] [--pipe] [--refresh REFRESH] [--sort SORT] [--reverse] [--type TYPE] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

Obtenir une liste des environnements

Options

Pour les options globales, voir Options globales.

--no-inactive, -I

Ne pas afficher les environnements inactifs

--status

Filtrer les environnements par statut (actif, inactif, sale, en pause, suppression). Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--pipe

Génère une liste simple d’identifiants d’environnement.

--refresh

Actualiser la liste.

--sort

Propriété par laquelle effectuer le tri

--reverse

Tri dans l’ordre inverse (décroissant)

--type

Filtrer la liste par type(s) d’environnement. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : id*, titre*, statut*, type*, créé, nom_machine, mis à jour (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

environment:logs

magento-cloud log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [--] [<type>]

Lecture des journaux d’un environnement

Arguments

type

Type de journal, par exemple « accès » ou « erreur »

Options

Pour les options globales, voir Options globales.

--lines

Nombre de lignes à afficher

--tail

Enregistrer le journal en continu

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

environment:merge

magento-cloud merge [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]

Fusion d’un environnement

This command will initiate a Git merge of the specified environment into its parent environment.

Arguments

environment

Environnement à fusionner

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:pause

magento-cloud environment:pause [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Mettre en pause un environnement

Pausing an environment helps to reduce resource consumption and carbon emissions.

The environment will be unavailable until it is resumed. No data will be lost.

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:push

magento-cloud push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upstream] [--activate] [--parent PARENT] [--type TYPE] [--no-clone-parent] [-W|--no-wait] [--wait] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<source>]

Code push vers un environnement

Arguments

source

La référence de source Git, par exemple un nom de branche ou un hachage de validation.

Options

Pour les options globales, voir Options globales.

--target

Nom de la branche cible. La valeur par défaut est la branche active.

--force, -f

Autoriser les mises à jour non rapides

--force-with-lease

Autoriser les mises à jour non rapides si la branche de tracking distant est à jour

--set-upstream, -u

Définissez l’environnement cible comme amont de la branche source. Cela définit également le projet cible comme distant pour le référentiel local.

--activate

Activez l’environnement. Les environnements en pause reprendront. Cela permet de s’assurer que l’environnement est actif même si aucune modification n’a été transmise.

--parent

Définir le parent de l’environnement (utilisé uniquement avec —activate)

--type

Définissez le type d’environnement (utilisé uniquement avec —activate )

--no-clone-parent

Ne clonez pas les données de la branche parent (utilisée uniquement avec —activate).

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

environment:redeploy

magento-cloud redeploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Redéploiement d’un environnement

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:relationships

magento-cloud relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [<environment>]

Afficher les relations d’un environnement

Arguments

environment

L'environnement

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété de relation à afficher

--refresh

Actualiser ou non les relations

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

environment:resume

magento-cloud environment:resume [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Reprise d’un environnement en pause

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:scp

magento-cloud scp [-r|--recursive] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [--] [<files>]...

Copier des fichiers vers et depuis un environnement à l’aide de scp

Arguments

files

Fichiers à copier. Utilisez le préfixe remote : pour définir les emplacements distants.

Options

Pour les options globales, voir Options globales.

--recursive, -r

Copie récursive de répertoires entiers

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

environment:ssh

magento-cloud ssh [--pipe] [--all] [-o|--option OPTION] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [--] [<cmd>]...

SSH vers l’environnement actuel

Arguments

cmd

Commande à exécuter sur l’environnement.

Options

Pour les options globales, voir Options globales.

--pipe

Générez uniquement l’URL SSH.

--all

Générez toutes les URL SSH (pour chaque application).

--option, -o

Transmettre une option supplémentaire à SSH

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

environment:synchronize

magento-cloud sync [--rebase] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<synchronize>]...

Synchroniser le code et/ou les données d’un environnement à partir de son parent

This command synchronizes to a child environment from its parent environment.

Synchronizing "code" means there will be a Git merge from the parent to the
child.

Synchronizing "data" means that all files in all services (including
static files, databases, logs, search indices, etc.) will be copied from the
parent to the child.

Arguments

synchronize

Éléments à synchroniser : « code », « données » ou les deux

Options

Pour les options globales, voir Options globales.

--rebase

Synchroniser le code en le basant au lieu de le fusionner

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

environment:url

magento-cloud url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Obtention des URL publiques d’un environnement

Options

Pour les options globales, voir Options globales.

--primary, -1

Renvoyer uniquement l’URL de l’itinéraire principal

--browser

Navigateur à utiliser pour ouvrir l’URL. Réglez 0 sur aucun.

--pipe

Générez l’URL dans stdout.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

environment:xdebug

magento-cloud xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Ouverture d’un tunnel vers Xdebug sur l’environnement

Options

Pour les options globales, voir Options globales.

--port

Le port local

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

integration:activity:get

magento-cloud integration:activity:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<integration>] [<activity>]

Affichage d’informations détaillées sur une seule activité d’intégration

Arguments

integration

Identifiant d’intégration. Laissez vide pour effectuer un choix dans une liste.

activity

Identifiant de l’activité. La valeur par défaut est l’activité d’intégration la plus récente.

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété à afficher

--project, -p

ID ou URL du projet

--environment, -e

[Option obsolète, non utilisée]

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

integration:activity:list

magento-cloud integration:activities [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

Obtention de la liste des activités pour une intégration

Arguments

id

Identifiant d’intégration. Laissez vide pour effectuer un choix dans une liste.

Options

Pour les options globales, voir Options globales.

--type

Filtrez les activités par type. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--exclude-type, -x

Exclure les activités par type. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure des types.

--limit

Limiter le nombre de résultats affichés

--start

Seules les activités créées avant cette date seront répertoriées

--state

Filtrez les activités par état. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--result

Filtrer les activités par résultat

--incomplete, -i

Répertorier uniquement les activités incomplètes

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : id*, créé*, description*, type*, état*, résultat*, terminé, progression, time_build, time_deploy, time_execute, time_wait (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

[Option obsolète, non utilisée]

integration:activity:log

magento-cloud integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<integration>] [<activity>]

Affichage du journal d’une activité d’intégration

Arguments

integration

Identifiant d’intégration. Laissez vide pour effectuer un choix dans une liste.

activity

Identifiant de l’activité. La valeur par défaut est l’activité d’intégration la plus récente.

Options

Pour les options globales, voir Options globales.

--timestamps, -t

Afficher un horodatage en regard de chaque message

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

[Option obsolète, non utilisée]

integration:add

magento-cloud integration:add [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--resources-init RESOURCES-INIT] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait]

Ajouter une intégration au projet

Options

Pour les options globales, voir Options globales.

--type

Le type d'intégration ('bitbucket', 'bitbucket_server', 'github', 'gitlab', 'webhook', 'health.email', 'health.pagerduty', 'health.slack', 'health.webhook', 'httplog', 'script', 'newrelic', 'splunk', 'sumological', 'syslog', 'otlplog')

--base-url

URL de base de l’installation du serveur

--bitbucket-url

URL de base de l’installation de Bitbucket Server

--username

Nom d’utilisateur du serveur Bitbucket

--token

Jeton d’authentification ou d’accès pour l’intégration

--key

Clé de consommateur OAuth Bitbucket

--secret

Secret du client OAuth Bitbucket

--license-key

La clé de licence Journaux New Relic

--server-project

Le projet (par exemple 'namespace/repo')

--repository

Référentiel à suivre (par exemple, « propriétaire/référentiel »)

--build-merge-requests

GitLab : création de demandes de fusion en tant qu’environnements

--build-pull-requests

Création de chaque demande d’extraction en tant qu’environnement

--build-draft-pull-requests

Créer des brouillons de demandes d’extraction

--build-pull-requests-post-merge

Générer des demandes d’extraction en fonction de leur état après la fusion

--build-wip-merge-requests

GitLab : création de demandes de fusion de travaux en cours

--merge-requests-clone-parent-data

GitLab : clonage des données pour les demandes de fusion

--pull-requests-clone-parent-data

Clonez les données de l’environnement parent pour les demandes d’extraction

--resync-pull-requests

Resynchroniser les données de l’environnement de requête d’extraction sur chaque version

--fetch-branches

Récupérer toutes les branches à partir de l’environnement distant (en tant qu’environnements inactifs)

--prune-branches

Supprimer les branches qui n’existent pas sur la télécommande

--resources-init

Les ressources à utiliser lors de l'initialisation d'un nouveau service ('minimum', 'default', 'manual', 'parent')

--url

Point d’entrée d’URL ou d’API pour l’intégration

--shared-key

Webhook : clé secrète partagée JWS

--file

Nom d’un fichier local contenant le script à charger

--events

Liste des événements sur lesquels agir, par exemple environment.push

--states

Une liste des états sur lesquels agir, par exemple en attente, en cours, terminé

--environments

Identifiants d’environnement à inclure

--excluded-environments

Identifiants d’environnement à exclure

--from-address

[Facultatif] Adresse d’expédition personnalisée pour les e-mails d’alerte

--recipients

Adresse(s) email du destinataire

--channel

Le canal Slack

--routing-key

La clé de routage PagerDuty

--category

La catégorie Logique Sumo , utilisée pour le filtrage.

--index

Index Splunk

--sourcetype

Le type de source d’événement Splunk

--protocol

Protocole de transport Syslog ('tcp', 'udp', 'tls')

--syslog-host

Hôte de collecte/relais Syslog

--syslog-port

Port du collecteur/relais Syslog

--facility

Fonction Syslog

--message-format

Format du message Syslog ('rfc3164' ou 'rfc5424')

--auth-mode

Mode d'authentification ('prefix' ou 'structured_data')

--auth-token

Jeton d’authentification

--verify-tls

Si la vérification du certificat HTTPS doit être activée (recommandé)

--header

En-tête(s) HTTP à utiliser dans les requêtes POST. Séparez les noms et les valeurs par deux points (:).

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

integration:delete

magento-cloud integration:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]

Supprimer une intégration d’un projet

Arguments

id

Identifiant d’intégration. Laissez vide pour effectuer un choix dans une liste.

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

integration:get

magento-cloud integration:get [-P|--property [PROPERTY]] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--] [<id>]

Affichage des détails d’une intégration

Arguments

id

Identifiant d’intégration. Laissez vide pour effectuer un choix dans une liste.

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété d’intégration à afficher

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

integration:list

magento-cloud integrations [-t|--type TYPE] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

Afficher une liste des intégrations de projet

Options

Pour les options globales, voir Options globales.

--type, -t

Filtrer par type

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : id, résumé, type. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

integration:update

magento-cloud integration:update [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--resources-init RESOURCES-INIT] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]

Mise à jour d’une intégration

Arguments

id

Identifiant de l’intégration à mettre à jour

Options

Pour les options globales, voir Options globales.

--type

Le type d'intégration ('bitbucket', 'bitbucket_server', 'github', 'gitlab', 'webhook', 'health.email', 'health.pagerduty', 'health.slack', 'health.webhook', 'httplog', 'script', 'newrelic', 'splunk', 'sumological', 'syslog', 'otlplog')

--base-url

URL de base de l’installation du serveur

--bitbucket-url

URL de base de l’installation de Bitbucket Server

--username

Nom d’utilisateur du serveur Bitbucket

--token

Jeton d’authentification ou d’accès pour l’intégration

--key

Clé de consommateur OAuth Bitbucket

--secret

Secret du client OAuth Bitbucket

--license-key

La clé de licence Journaux New Relic

--server-project

Le projet (par exemple 'namespace/repo')

--repository

Référentiel à suivre (par exemple, « propriétaire/référentiel »)

--build-merge-requests

GitLab : création de demandes de fusion en tant qu’environnements

--build-pull-requests

Création de chaque demande d’extraction en tant qu’environnement

--build-draft-pull-requests

Créer des brouillons de demandes d’extraction

--build-pull-requests-post-merge

Générer des demandes d’extraction en fonction de leur état après la fusion

--build-wip-merge-requests

GitLab : création de demandes de fusion de travaux en cours

--merge-requests-clone-parent-data

GitLab : clonage des données pour les demandes de fusion

--pull-requests-clone-parent-data

Clonez les données de l’environnement parent pour les demandes d’extraction

--resync-pull-requests

Resynchroniser les données de l’environnement de requête d’extraction sur chaque version

--fetch-branches

Récupérer toutes les branches à partir de l’environnement distant (en tant qu’environnements inactifs)

--prune-branches

Supprimer les branches qui n’existent pas sur la télécommande

--resources-init

Les ressources à utiliser lors de l'initialisation d'un nouveau service ('minimum', 'default', 'manual', 'parent')

--url

Point d’entrée d’URL ou d’API pour l’intégration

--shared-key

Webhook : clé secrète partagée JWS

--file

Nom d’un fichier local contenant le script à charger

--events

Liste des événements sur lesquels agir, par exemple environment.push

--states

Une liste des états sur lesquels agir, par exemple en attente, en cours, terminé

--environments

Identifiants d’environnement à inclure

--excluded-environments

Identifiants d’environnement à exclure

--from-address

[Facultatif] Adresse d’expédition personnalisée pour les e-mails d’alerte

--recipients

Adresse(s) email du destinataire

--channel

Le canal Slack

--routing-key

La clé de routage PagerDuty

--category

La catégorie Logique Sumo , utilisée pour le filtrage.

--index

Index Splunk

--sourcetype

Le type de source d’événement Splunk

--protocol

Protocole de transport Syslog ('tcp', 'udp', 'tls')

--syslog-host

Hôte de collecte/relais Syslog

--syslog-port

Port du collecteur/relais Syslog

--facility

Fonction Syslog

--message-format

Format du message Syslog ('rfc3164' ou 'rfc5424')

--auth-mode

Mode d'authentification ('prefix' ou 'structured_data')

--auth-token

Jeton d’authentification

--verify-tls

Si la vérification du certificat HTTPS doit être activée (recommandé)

--header

En-tête(s) HTTP à utiliser dans les requêtes POST. Séparez les noms et les valeurs par deux points (:).

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

integration:validate

magento-cloud integration:validate [-p|--project PROJECT] [--] [<id>]

Validation d’une intégration existante

This command allows you to check whether an integration is valid.

An exit code of 0 means the integration is valid, while 4 means it is invalid.
Any other exit code indicates an unexpected error.

Integrations are validated automatically on creation and on update. However,
because they involve external resources, it is possible for a valid integration
to become invalid. For example, an access token may be revoked, or an external
repository may be deleted.

Arguments

id

Identifiant d’intégration. Laissez vide pour effectuer un choix dans une liste.

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

local:build

magento-cloud build [-a|--abslinks] [-s|--source SOURCE] [-d|--destination DESTINATION] [-c|--copy] [--clone] [--run-deploy-hooks] [--no-clean] [--no-archive] [--no-backup] [--no-cache] [--no-build-hooks] [--no-deps] [--working-copy] [--concurrency CONCURRENCY] [--lock] [--] [<app>]...

Générer le projet actuel localement

Arguments

app

Spécifier la ou les applications à créer

Options

Pour les options globales, voir Options globales.

--abslinks, -a

Utiliser des liens absolus

--source, -s

Le répertoire source. La valeur par défaut est la racine actuelle du projet.

--destination, -d

Destination vers laquelle la racine web de chaque application sera liée par un lien symbolique. Valeur par défaut : _www

--copy, -c

Copiez dans un répertoire de build, au lieu de créer un lien symbolique depuis la source

--clone

Utilisez Git pour cloner l’HEAD active dans le répertoire de build

--run-deploy-hooks

Exécution des hooks de déploiement et/ou de post_déploiement

--no-clean

Ne pas supprimer les anciennes versions

--no-archive

Ne créez ou n’utilisez pas d’archive de build

--no-backup

Ne pas sauvegarder le build précédent

--no-cache

Désactiver la mise en cache

--no-build-hooks

N’exécutez pas les hooks de post-génération.

--no-deps

N’installez pas les dépendances de build localement.

--working-copy

Drush : utilisez git pour cloner un référentiel de chaque module Drupal plutôt que de simplement télécharger une version

--concurrency

Pincer : permet de définir le nombre de projets simultanés qui seront traités en même temps

--lock

Drush : permet de créer ou de mettre à jour un fichier de verrouillage (disponible uniquement avec les versions 7 et ultérieures de Drush).

local:dir

magento-cloud dir [<subdir>]

Rechercher la racine du projet local

Arguments

subdir

Le sous-répertoire à rechercher ('local', 'web' ou 'shared')

Options

Pour les options globales, voir Options globales.

metrics:all

magento-cloud metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Affichage des mesures de CPU, de disque et de mémoire pour un environnement

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--range, -r

La période. Les mesures seront chargées pendant cette durée jusqu’à l’heure de fin (—à). Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 5m, maximum 8h ou plus (selon le projet), par défaut 10m.

--interval, -i

Intervalle de temps. La valeur par défaut est une division de la plage. Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 1m.

--to

L'heure de fin. La valeur par défaut est maintenant.

--latest, -1

Afficher uniquement le dernier point de données unique

--service, -s

Filtrer par nom de service ou d’application Les caractères % ou * peuvent être utilisés comme caractère générique.

--type

Filtrez par type de service (si —service n’est pas fourni). La version n’est pas requise. Les caractères % ou * peuvent être utilisés comme caractère générique.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : timestamp*, service*, cpu_percent*, mem_percent*, disk_percent*, tmp_disk_percent*, cpu_limit, cpu_used, disk_limit, disk_used, inodes_limit, inodes_percent, inodes_used, mem_limit, mem_used, tmp_disk_limit, tmp_disk_used, tmp_inodes_limit, tmp_inodes_percent, tmp_inodes_used, type (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

metrics:cpu

magento-cloud cpu [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Affichage de l’utilisation de CPU dans un environnement

Options

Pour les options globales, voir Options globales.

--range, -r

La période. Les mesures seront chargées pendant cette durée jusqu’à l’heure de fin (—à). Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 5m, maximum 8h ou plus (selon le projet), par défaut 10m.

--interval, -i

Intervalle de temps. La valeur par défaut est une division de la plage. Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 1m.

--to

L'heure de fin. La valeur par défaut est maintenant.

--latest, -1

Afficher uniquement le dernier point de données unique

--service, -s

Filtrer par nom de service ou d’application Les caractères % ou * peuvent être utilisés comme caractère générique.

--type

Filtrez par type de service (si —service n’est pas fourni). La version n’est pas requise. Les caractères % ou * peuvent être utilisés comme caractère générique.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : horodatage*, service*, utilisé*, limite*, pourcentage*, type (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

metrics:disk-usage

magento-cloud disk [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [--tmp] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Afficher l’utilisation du disque d’un environnement

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--range, -r

La période. Les mesures seront chargées pendant cette durée jusqu’à l’heure de fin (—à). Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 5m, maximum 8h ou plus (selon le projet), par défaut 10m.

--interval, -i

Intervalle de temps. La valeur par défaut est une division de la plage. Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 1m.

--to

L'heure de fin. La valeur par défaut est maintenant.

--latest, -1

Afficher uniquement le dernier point de données unique

--service, -s

Filtrer par nom de service ou d’application Les caractères % ou * peuvent être utilisés comme caractère générique.

--type

Filtrez par type de service (si —service n’est pas fourni). La version n’est pas requise. Les caractères % ou * peuvent être utilisés comme caractère générique.

--tmp

Rapport sur l’utilisation temporaire du disque (affiche les colonnes : timestamp, service, tmp_used, tmp_limit, tmp_percent, tmp_ipercent)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : horodatage*, service*, utilisé*, limite*, pourcentage*, ipercent*, tmp_percent*, ilimit, iused, tmp_ilimit, tmp_ipercent, tmp_iused, tmp_iused, tmp_limit, tmp_used, type (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

metrics:memory

magento-cloud mem [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Afficher l’utilisation de la mémoire d’un environnement

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--range, -r

La période. Les mesures seront chargées pendant cette durée jusqu’à l’heure de fin (—à). Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 5m, maximum 8h ou plus (selon le projet), par défaut 10m.

--interval, -i

Intervalle de temps. La valeur par défaut est une division de la plage. Vous pouvez indiquer des unités : heures (h), minutes (m) ou secondes (s). Minimum 1m.

--to

L'heure de fin. La valeur par défaut est maintenant.

--latest, -1

Afficher uniquement le dernier point de données unique

--service, -s

Filtrer par nom de service ou d’application Les caractères % ou * peuvent être utilisés comme caractère générique.

--type

Filtrez par type de service (si —service n’est pas fourni). La version n’est pas requise. Les caractères % ou * peuvent être utilisés comme caractère générique.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : horodatage*, service*, utilisé*, limite*, pourcentage*, type (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

mount:download

magento-cloud mount:download [-a|--all] [-m|--mount MOUNT] [--target TARGET] [--source-path] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Télécharger des fichiers à partir d’un montage, à l’aide de rsync

Options

Pour les options globales, voir Options globales.

--all, -a

Télécharger depuis tous les montages

--mount, -m

Le montage (en tant que chemin relatif à l’application)

--target

Répertoire dans lequel les fichiers seront téléchargés. Si —all est utilisé, le chemin de montage est ajouté

--source-path

Utilisez le chemin source du montage (plutôt que le chemin de montage) comme sous-répertoire de la cible, lorsque —all est utilisé

--delete

Supprimer les fichiers superflus dans le répertoire cible

--exclude

Fichier(s) à exclure du téléchargement (motif)

--include

Fichier(s) à ne pas exclure (motif)

--refresh

Actualisation du cache

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

mount:list

magento-cloud mounts [--paths] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Obtention d’une liste des montages

Options

Pour les options globales, voir Options globales.

--paths

Générez uniquement les chemins de montage (un par ligne).

--refresh

Actualisation du cache

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : définition, chemin. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

mount:upload

magento-cloud mount:upload [--source SOURCE] [-m|--mount MOUNT] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Chargez des fichiers sur un montage à l’aide de rsync.

Options

Pour les options globales, voir Options globales.

--source

Un répertoire contenant les fichiers à charger

--mount, -m

Le montage (en tant que chemin relatif à l’application)

--delete

Permet de supprimer les fichiers superflus dans le montage

--exclude

Fichier(s) à exclure du chargement (modèle)

--include

Fichier(s) à ne pas exclure (motif)

--refresh

Actualisation du cache

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--instance, -I

Identifiant d’une instance

operation:list

magento-cloud ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Liste des opérations d’exécution sur un environnement

Options

Pour les options globales, voir Options globales.

--full

Ne limitez pas la longueur de la commande à afficher. La limite par défaut est de 24 lignes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : service*, nom*, démarrage*, rôle, arrêt (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

operation:run

magento-cloud operation:run [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-W|--no-wait] [--wait] [--] [<operation>]

Exécuter une opération sur l’environnement

Arguments

operation

Nom de l’opération

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Un nom de collaborateur

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

project:clear-build-cache

magento-cloud project:clear-build-cache [-p|--project PROJECT]

Effacer le cache de génération d’un projet

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

project:get

magento-cloud get [-e|--environment ENVIRONMENT] [--depth DEPTH] [--build] [-p|--project PROJECT] [--] [<project>] [<directory>]

Cloner un projet localement

Arguments

project

Identifiant du projet

directory

Répertoire vers lequel effectuer le clonage. La valeur par défaut est le titre du projet

Options

Pour les options globales, voir Options globales.

--environment, -e

Identifiant d’environnement à cloner. La valeur par défaut est celle du projet ou du premier environnement disponible

--depth

Créer un clone superficiel : limite le nombre de validations dans l’historique.

--build

Générer le projet après le clonage

--project, -p

ID ou URL du projet

project:info

magento-cloud project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]

Lire ou définir des propriétés pour un projet

Arguments

property

Nom de la propriété

value

Définissez une nouvelle valeur pour la propriété

Options

Pour les options globales, voir Options globales.

--refresh

Actualisation du cache

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

--no-wait, -W

N’attendez pas la fin de l’opération

--wait

Attendre la fin de l’opération (par défaut)

project:list

magento-cloud projects [--pipe] [--region REGION] [--title TITLE] [--my] [--refresh REFRESH] [--sort SORT] [--reverse] [--page PAGE] [-c|--count COUNT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Obtenir une liste de tous les projets actifs

Options

Pour les options globales, voir Options globales.

--pipe

Génère une liste simple d’identifiants de projet. Désactive la pagination.

--region

Filtrer par région (correspondance exacte)

--title

Filtrer par titre (recherche non sensible à la casse)

--my

Afficher uniquement les projets que vous possédez

--refresh

Actualisation de la liste

--sort

Propriété par laquelle effectuer le tri

--reverse

Tri dans l’ordre inverse (décroissant)

--page

Numéro de page. Cela permet la pagination, malgré la configuration ou —count. Ignoré si —pipe est spécifié.

--count, -c

Nombre de projets à afficher par page. Utilisez 0 pour désactiver la pagination. Ignoré si —page est spécifié.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns

Colonnes à afficher. Colonnes disponibles : id*, titre*, région*, created_at, organization_id, organization_label, nom_organisation, type_organisation, statut (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

project:set-remote

magento-cloud set-remote [<project>]

Définir le projet distant pour le référentiel Git actuel

Arguments

project

Identifiant du projet

Options

Pour les options globales, voir Options globales.

repo:cat

magento-cloud repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] <path>

Lire un fichier dans le référentiel du projet

Arguments

path

Chemin d’accès au fichier

Options

Pour les options globales, voir Options globales.

--commit, -c

La validation SHA. Cette méthode accepte également les suffixes « HEAD », et signe d’insertion (^) ou tilde (~) pour les validations parentes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

repo:ls

magento-cloud repo:ls [-d|--directories] [-f|--files] [--git-style] [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]

Répertorier les fichiers dans le référentiel du projet

Arguments

path

Chemin d’accès à un sous-répertoire

Options

Pour les options globales, voir Options globales.

--directories, -d

Afficher uniquement les répertoires

--files, -f

Afficher uniquement les fichiers

--git-style

Sortie de style similaire à « git-tree »

--commit, -c

La validation SHA. Cette méthode accepte également les suffixes « HEAD », et signe d’insertion (^) ou tilde (~) pour les validations parentes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

repo:read

magento-cloud read [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]

Lire un répertoire ou un fichier dans le référentiel du projet

Arguments

path

Chemin d’accès au répertoire ou fichier

Options

Pour les options globales, voir Options globales.

--commit, -c

La validation SHA. Cette méthode accepte également les suffixes « HEAD », et signe d’insertion (^) ou tilde (~) pour les validations parentes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

resources:build:get

magento-cloud build-resources:get [-p|--project PROJECT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Affichage des ressources de build d’un projet

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : processeur, mémoire. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

route:get

magento-cloud route:get [--id ID] [-1|--primary] [-P|--property PROPERTY] [--refresh] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<route>]

Afficher des informations détaillées sur un itinéraire

Arguments

route

URL d’origine de l’itinéraire

Options

Pour les options globales, voir Options globales.

--id

Identifiant d’itinéraire à sélectionner

--primary, -1

Sélectionner l'itinéraire principal

--property, -P

La propriété à afficher

--refresh

Contournement du cache des itinéraires

--date-fmt

Le format de date (sous forme de chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

[Option obsolète, n’est plus utilisée]

--identity-file, -i

[Option obsolète, n’est plus utilisée]

route:list

magento-cloud routes [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<environment>]

Liste de tous les itinéraires pour un environnement

Arguments

environment

Identifiant de l’environnement

Options

Pour les options globales, voir Options globales.

--refresh

Contournement du cache des itinéraires

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : itinéraire*, type*, vers*, URL (* = colonnes par défaut). Le caractère « + » peut être utilisé comme espace réservé pour les colonnes par défaut. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

self:install

magento-cloud self:install [--shell-type SHELL-TYPE]

Installation ou mise à jour des fichiers de configuration de l’interface de ligne de commande

This command automatically installs shell configuration for the Magento Cloud CLI,
adding autocompletion support and handy aliases. Bash and ZSH are supported.

Options

Pour les options globales, voir Options globales.

--shell-type

Type de shell pour la saisie semi-automatique (bash ou zsh)

self:update

magento-cloud update [--no-major] [--unstable] [--manifest MANIFEST] [--current-version CURRENT-VERSION] [--timeout TIMEOUT]

Mettre à jour l’interface de ligne de commande vers la dernière version

Options

Pour les options globales, voir Options globales.

--no-major

Mise à jour uniquement entre les versions mineures ou de correctif

--unstable

Mettre à jour vers une nouvelle version instable, le cas échéant

--manifest

Remplacer l'emplacement du fichier manifeste

--current-version

Remplacer la version actuelle

--timeout

Temporisation de la vérification de version

service:list

magento-cloud services [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Répertorier les services du projet

Options

Pour les options globales, voir Options globales.

--refresh

Actualisation du cache

--pipe

Générer une liste de noms de service uniquement

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : disque, nom, taille, type. Les caractères % ou * peuvent être utilisés comme caractère générique. Les valeurs peuvent être fractionnées par des virgules (par exemple, « a, b, c ») et/ou des espaces.

--no-header

Ne pas afficher l’en-tête du tableau

service:mongo:dump

magento-cloud mongodump [-c|--collection COLLECTION] [-z|--gzip] [-o|--stdout] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Créer un vidage d’archives binaires de données à partir de MongoDB

Options

Pour les options globales, voir Options globales.

--collection, -c

La collection à vider

--gzip, -z

Compresser l’image mémoire à l’aide de gzip

--stdout, -o

Sortie vers STDOUT au lieu d'un fichier

--relationship, -r

La relation de service à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

service:mongo:export

magento-cloud mongoexport [-c|--collection COLLECTION] [--jsonArray] [--type TYPE] [-f|--fields FIELDS] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Exporter des données à partir de MongoDB

Options

Pour les options globales, voir Options globales.

--collection, -c

Collection à exporter

--jsonArray

Exporter des données sous la forme d’un seul tableau JSON

--type

Type d’exportation, par exemple « csv »

--fields, -f

Les champs à exporter

--relationship, -r

La relation de service à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant d’environnement. Utiliser « . » pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

service:mongo:restore

magento-cloud mongorestore [-c|--collection COLLECTION] [-r|--relationship RELATIONSHIP] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Restaurer un vidage d’archives binaires de données dans MongoDB

Options

Pour les options globales, voir Options globales.

--collection, -c

Collection à restaurer

--relationship, -r

La relation de service à utiliser