Référence de l’interface de ligne de commande du cloud

Version : 1.46.1

Cette référence contient 119 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 sur Adobe Commerce sur l’infrastructure cloud.

Général

Cette référence est générée à partir du code base 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 à Laisser un commentaire (trouvez le lien en haut à droite). Pour obtenir des instructions sur les contributions, voir Contributions au code.

Options globales

--help, -h

Afficher ce message d’aide

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

Augmenter la verbalisation des messages

--version, -V

Afficher cette version de l’application

--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 aucune question interactive ; acceptez les valeurs par défaut. Équivalent à l’utilisation de la variable d’environnement : MAGENTO_CLOUD_CLI_NO_INTERACTION=1

clear-cache

magento-cloud magento-cloud cc

Effacer le cache de l’interface de ligne de commande

Options

Pour les options globales, voir Options globales.

decode

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

Décodez une chaîne codée telle que MAGENTO_CLOUD_VARIABLES .

Arguments

value

La valeur de la variable à décoder

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété à afficher dans la variable

docs

magento-cloud 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. Définissez 0 pour aucun.

--pipe

Extrayez l’URL vers stdout.

help

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

Affiche une aide pour 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 magento-cloud list [--raw] [--format FORMAT] [--all] [--] [<namespace>]

Commandes Listes

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

Format de sortie (txt, xml, json ou md)

--all

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

multi

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

Exécution d’une commande sur plusieurs projets

Arguments

cmd

Commande à exécuter

Options

Pour les options globales, voir Options globales.

--projects, -p

Une liste d’ID de projet, séparés par des virgules et/ou un espace blanc

--continue

Poursuivre l’exécution des commandes même en cas d’exception

--sort

Une propriété par laquelle trier la liste des options de projet

--reverse

Inverser l’ordre des options du projet

web

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

Ouvrez le projet dans l’interface utilisateur web.

Options

Pour les options globales, voir Options globales.

--browser

Navigateur à utiliser pour ouvrir l’URL. Définissez 0 pour aucun.

--pipe

Extrayez l’URL vers stdout.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

activity:cancel

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

Annulation d’une activité

Arguments

id

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

Options

Pour les options globales, voir Options globales.

--type, -t

Filtrer 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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour le type, par exemple '%var%' pour sélectionner les 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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure les types.

--all, -a

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

activity:get

magento-cloud 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>]

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

Arguments

id

ID d’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

Filtrer 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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour le type, par exemple '%var%' pour sélectionner les 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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure les 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 blancs.

--result

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

--incomplete, -i

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

--all, -a

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

activity:list

magento-cloud 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 des activités pour un environnement ou un projet

Options

Pour les options globales, voir Options globales.

--type, -t

Les activités de filtrage par type Valeurs peuvent être fractionnées par des virgules (par exemple "a, b, c") et/ou un espace blanc. 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ères génériques, par exemple '%var%' pour sélectionner des activités liées à des 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 blancs. 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 les 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é ou annulé. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--result

Filtrage des activités par résultat : succès ou échec

--incomplete, -i

Ne répertorier que 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*, created*, description*, progress*, state*, result*, completed, environment, 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

activity:log

magento-cloud 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>]

Afficher le journal d’une activité

Arguments

id

ID d’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 cette variable sur 0 pour désactiver l’actualisation.

--timestamps, -t

Affichage d’un horodatage en regard de chaque message

--type

Filtrer 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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour le type, par exemple '%var%' pour sélectionner les 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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure les 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 blancs.

--result

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

--incomplete, -i

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

--all, -a

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

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

app:config-get

magento-cloud 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 ou non du cache

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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 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 ou non du cache

--pipe

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

auth:api-token-login

magento-cloud magento-cloud auth:api-token-login

Connexion à 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 magento-cloud login [-f|--force] [--browser BROWSER] [--pipe]

Connexion à 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

Connectez-vous à nouveau, même si vous êtes déjà connecté.

--browser

Navigateur à utiliser pour ouvrir l’URL. Définissez 0 pour aucun.

--pipe

Extrayez l’URL vers stdout.

auth:info

magento-cloud 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

Propriété du compte à afficher

Options

Pour les options globales, voir Options globales.

--no-auto-login

Ignore la connexion automatique. Aucun résultat ne sera affiché s’il n’est pas connecté et le code de sortie sera 0, en supposant aucune autre erreur.

--property, -P

Propriété du compte à afficher (syntaxe alternative)

--refresh

Actualisation ou non 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

auth:logout

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

Déconnexion de Magento Cloud

Options

Pour les options globales, voir Options globales.

--all, -a

Déconnexion de toutes les sessions locales

--other

Déconnexion à partir d’autres sessions locales

blackfire:setup

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

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

Options

Pour les options globales, voir Options globales.

--server_id

ID du serveur

--server_token

Jeton de serveur

--project, -p

ID ou URL du projet

--no-wait, -W

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

--wait

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

certificate:add

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

Ajout d’un certificat SSL au projet

Options

Pour les options globales, voir Options globales.

--cert

Chemin d’accès au fichier de certificat

--key

Le 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

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

certificate:delete

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

Suppression d’un certificat du projet

Arguments

id

L’ID de certificat (ou le début de celui-ci)

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

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

certificate:get

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

Affichage d’un certificat

Arguments

id

L’ID de certificat (ou le début de celui-ci)

Options

Pour les options globales, voir Options globales.

--property, -P

La propriété de certificat à afficher

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

--project, -p

ID ou URL du projet

certificate:list

magento-cloud 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

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

--exclude-domain

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

--issuer

Filtrage 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

Ne renvoient qu’une liste de noms de domaine couverts par les certificats

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

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

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

commit:get

magento-cloud 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. Cela peut également accepter les suffixes "HEAD" et caret (^) 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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

commit:list

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

Validation de liste

Arguments

commit

SHA de validation Git de départ. Cela peut également accepter les suffixes "HEAD" et caret (^) 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 de l’environnement. Utilisez "." 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, sha, summary. Les caractères % ou * peuvent être utilisés comme caractères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

db:dump

magento-cloud 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] [-i|--identity-file IDENTITY-FILE]

Créer un vidage local 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 "main").

--file, -f

Un nom de fichier personnalisé pour la sauvegarde

--directory, -d

Un répertoire personnalisé pour la vidage

--gzip, -z

Compresser la vidure à l’aide de gzip

--timestamp, -t

Ajouter un horodatage au nom de fichier de vidage

--stdout, -o

Sortie à STDOUT au lieu d’un fichier

--table

Tableau(s) à inclure

--exclude-table

Tableau(s) à exclure

--schema-only

vidage des schémas uniquement, sans données

--charset

Encodage du jeu de caractères pour le vidage

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--relationship, -r

Relation de service à utiliser

--identity-file, -i

Une identité SSH (clé privée) à utiliser

db:size

magento-cloud magento-cloud db:size [-B|--bytes] [-C|--cleanup] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE]

Estimation de l’utilisation du disque d’une base de données

This is an estimate of the database disk usage. The real size on disk is usually higher because of overhead.

To see more accurate disk usage, run: magento-cloud disk

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets.

--cleanup, -C

Vérifiez si les tableaux peuvent être nettoyés et affichez-moi des recommandations (InnoDb uniquement).

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--relationship, -r

Relation de service à utiliser

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : max, percent_used, utilisé. Les caractères % ou * peuvent être utilisés comme caractères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--identity-file, -i

Une identité SSH (clé privée) à utiliser

db:sql

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

Exécution SQL sur la base distante

Arguments

query

Instruction SQL à exécuter

Options

Pour les options globales, voir Options globales.

--raw

Générer une sortie brute et non tabulaire

--schema

Le schéma à utiliser. Omettez d’utiliser le schéma par défaut (généralement "main"). Transmettez une chaîne vide pour ne pas utiliser de schéma.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--relationship, -r

Relation de service à utiliser

--identity-file, -i

Une identité SSH (clé privée) à utiliser

domain:add

magento-cloud 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

Nom de domaine

Options

Pour les options globales, voir Options globales.

--cert

Chemin d’accès au fichier de certificat pour ce domaine

--key

Le chemin d’accès au fichier de clé privée pour le certificat fourni.

--chain

Le chemin d’accès au fichier ou aux fichiers de la chaîne de certificat pour le certificat fourni

--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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

domain:delete

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

Suppression d’un domaine du projet

Arguments

name

Nom de domaine

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

domain:get

magento-cloud 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>]

Affichage des informations détaillées d’un domaine

Arguments

name

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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

domain:list

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

Obtention d’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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

domain:update

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

Mettre à jour un domaine

Arguments

name

Nom de domaine

Options

Pour les options globales, voir Options globales.

--cert

Chemin d’accès au fichier de certificat pour ce domaine

--key

Le chemin d’accès au fichier de clé privée pour le certificat fourni.

--chain

Le chemin d’accès au fichier ou aux fichiers de la chaîne de certificat pour le certificat fourni

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:activate

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

Activation d’un environnement

Arguments

environment

Environnement(s) à activer

Options

Pour les options globales, voir Options globales.

--parent

Définition d’un nouveau parent d’environnement avant activation

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:branch

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

Branchement et environnement

Arguments

id

ID (nom de branche) du nouvel environnement

parent

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:checkout

magento-cloud magento-cloud checkout [-i|--identity-file IDENTITY-FILE] [--] [<id>]

Vérification d’un environnement

Arguments

id

L’identifiant de l’environnement à extraire. Par exemple : "sprint2"

Options

Pour les options globales, voir Options globales.

--identity-file, -i

Une identité SSH (clé privée) à utiliser

environment:delete

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

Suppression d’un ou de 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

Environnements à supprimer. Les caractères % ou * peuvent être utilisés comme caractères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

Options

Pour les options globales, voir Options globales.

--delete-branch

Suppression des branches Git pour les environnements inactifs, sans confirmation

--no-delete-branch

Ne supprimez aucune branche(s) Git (environnements inactifs)

--type

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

--only-type, -t

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

--exclude

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

--exclude-type

Les types d’environnement dont les valeurs ne doivent pas être supprimées peuvent être fractionnés par des virgules (par exemple "a, b, c") et/ou un espace blanc.

--inactive

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

--merged

Supprimez tous les environnements fusionnés (en les ajoutant à tous les autres environnements sélectionnés).

--allow-delete-parent

Autoriser la suppression des environnements ayant des enfants

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:http-access

magento-cloud 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 "permission:address". Utilisez 0 pour effacer toutes les adresses.

--auth

Informations d’identification HTTP Basic auth au format "username:password". Utilisez 0 pour effacer toutes les informations d’identification.

--enabled

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:info

magento-cloud 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>]

Lecture ou définition des propriétés d’un environnement

Arguments

property

Nom de la propriété

value

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

Options

Pour les options globales, voir Options globales.

--refresh

Actualisation ou non du cache

--date-fmt

Format de date (en tant que 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:init

magento-cloud 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

URL d’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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:list

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

Obtention d’une liste des environnements

Options

Pour les options globales, voir Options globales.

--no-inactive, -I

Ne pas afficher les environnements inactifs

--pipe

Générer une liste simple d’identifiants d’environnement.

--refresh

Actualisation ou non de la liste.

--sort

Propriété à trier par

--reverse

Tri dans l’ordre inverse (décroissant)

--type

Vous pouvez filtrer la liste par type d'environnement. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : id*, titre*, statut*, type*, créé, nom_machine, mise à 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

environment:logs

magento-cloud 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

Le type de journal, par exemple "access" ou "error"

Options

Pour les options globales, voir Options globales.

--lines

Le nombre de lignes à afficher

--tail

Quitter le journal en continu

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

environment:merge

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

Fusionner 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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:pause

magento-cloud 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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:push

magento-cloud 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] [-i|--identity-file IDENTITY-FILE] [--] [<source>]

Push du code dans un environnement

Arguments

source

Référence source : nom de branche ou 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 actuelle.

--force, -f

Autoriser des mises à jour non rapides

--force-with-lease

Autoriser les mises à jour à transfert rapide, si la branche de suivi à distance est à jour

--set-upstream, -u

Définissez l’environnement cible comme amont pour la branche source. Le projet cible sera également défini comme distant pour le référentiel local.

--activate

Activez l’environnement avant d’effectuer des opérations

--parent

Définissez le nouveau parent d’environnement (utilisé uniquement avec —activate).

--type

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

--no-clone-parent

Ne pas cloner les données de la branche parente (utilisé uniquement avec —activate)

--no-wait, -W

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

--wait

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--identity-file, -i

Une identité SSH (clé privée) à utiliser

environment:redeploy

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

Redéployer un environnement

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:relationships

magento-cloud magento-cloud relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<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

Actualisation ou non des relations

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--identity-file, -i

Une identité SSH (clé privée) à utiliser

environment:resume

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

Reprendre un environnement en pause

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:scp

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

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

Arguments

files

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

Options

Pour les options globales, voir Options globales.

--recursive, -r

Copier récursivement des répertoires entiers

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

--identity-file, -i

Une identité SSH (clé privée) à utiliser

environment:ssh

magento-cloud magento-cloud ssh [--pipe] [--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<cmd>]...

SSH vers l’environnement actuel

Arguments

cmd

Commande à exécuter sur l’environnement.

Options

Pour les options globales, voir Options globales.

--pipe

Ne sortez que l’URL SSH.

--all

Sortez toutes les URL SSH (pour chaque application).

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

--identity-file, -i

Une identité SSH (clé privée) à utiliser

environment:synchronize

magento-cloud 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 avec 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

Que synchroniser : "code", "données" ou les deux

Options

Pour les options globales, voir Options globales.

--rebase

Synchroniser le code en rebasant au lieu de fusionner

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--no-wait, -W

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

--wait

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

environment:url

magento-cloud 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

Ne renvoie que l’URL de l’itinéraire principal

--browser

Navigateur à utiliser pour ouvrir l’URL. Définissez 0 pour aucun.

--pipe

Extrayez l’URL vers stdout.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

environment:xdebug

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

Ouvrir 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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

--identity-file, -i

Une identité SSH (clé privée) à utiliser

integration:activity:get

magento-cloud 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 une sélection dans une liste.

activity

ID d’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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

integration:activity:list

magento-cloud magento-cloud int:act [--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 d’une liste des activités pour une intégration

Arguments

id

Identifiant d’intégration. Laissez vide pour effectuer une sélection 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 blancs.

--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 blancs. Les caractères % ou * peuvent être utilisés comme caractère générique pour exclure les 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

Filtrage des activités par état. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--result

Filtrage des activités par résultat

--incomplete, -i

Ne répertorier que les activités incomplètes

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : id*, created*, description*, type*, state*, result*, completed (* = 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que 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 magento-cloud integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<integration>] [<activity>]

Afficher le journal d’une activité d’intégration

Arguments

integration

Identifiant d’intégration. Laissez vide pour effectuer une sélection dans une liste.

activity

ID d’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

Affichage d’un horodatage en regard de chaque message

--date-fmt

Format de date (en tant que 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 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]

Ajout d’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', 'split', 'sumological', 'syslog').

--base-url

URL de base de l’installation du serveur

--bitbucket-url

URL de base de l’installation du serveur Bitbucket

--username

Nom d’utilisateur du serveur Bitbucket

--token

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

--key

Une clé de consommateur OAuth pour Bitbucket

--secret

Un secret de consommateur OAuth pour Bitbucket

--license-key

Clé de licence des journaux New Relic

--server-project

Le projet (par exemple 'espace de noms/repo')

--repository

Le référentiel à suivre (par exemple, 'propriétaire/référentiel')

--build-merge-requests

GitLab : créer des requêtes de fusion en tant qu’environnements

--build-pull-requests

Créer chaque demande d’extraction en tant qu’environnement

--build-draft-pull-requests

Création de requêtes d’extraction de brouillons

--build-pull-requests-post-merge

Créer des requêtes d’extraction en fonction de leur état de post-fusion

--build-wip-merge-requests

GitLab : création de requêtes de fusion en cours

--merge-requests-clone-parent-data

GitLab : données de clone pour les requêtes de fusion

--pull-requests-clone-parent-data

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

--resync-pull-requests

Resynchroniser les données de l’environnement des demandes d’extraction sur chaque version

--fetch-branches

Récupérer toutes les branches à partir de la distante (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', 'défaut', 'manuel', 'parent')

--url

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

--shared-key

Webhook : clé secrète partagée JWS

--file

Nom d’un fichier local qui contient le script à charger.

--events

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

--states

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

--environments

Les identifiants d’environnement à inclure

--excluded-environments

Les identifiants d’environnement à exclure

--from-address

[Facultatif] Adresse de l’expéditeur personnalisée pour les e-mails d’alerte

--recipients

Adresse électronique du ou des destinataires

--channel

Canal Slack

--routing-key

Clé de routage PagerDuty

--category

La catégorie Logique de sumo, utilisée pour le filtrage

--index

Index Splunk

--sourcetype

Type de source d’événement Splunk

--protocol

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

--syslog-host

Relais/hôte collecteur Syslog

--syslog-port

Port du relais/collecteur Syslog

--facility

Fonctionnalité 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

Indique si la vérification de certificat HTTPS doit être activée (recommandé).

--header

En-tête(s) HTTP à utiliser dans les requêtes de 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

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

integration:delete

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

Suppression d’une intégration d’un projet

Arguments

id

ID d’intégration. Laissez vide pour effectuer une sélection 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

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

integration:get

magento-cloud 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 une sélection 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

integration:list

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

Affichage d’une liste des intégrations de projet

Options

Pour les options globales, voir Options globales.

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

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

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

integration:update

magento-cloud 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>]

Mettre à jour une intégration

Arguments

id

ID 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', 'split', 'sumological', 'syslog').

--base-url

URL de base de l’installation du serveur

--bitbucket-url

URL de base de l’installation du serveur Bitbucket

--username

Nom d’utilisateur du serveur Bitbucket

--token

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

--key

Une clé de consommateur OAuth pour Bitbucket

--secret

Un secret de consommateur OAuth pour Bitbucket

--license-key

Clé de licence des journaux New Relic

--server-project

Le projet (par exemple 'espace de noms/repo')

--repository

Le référentiel à suivre (par exemple, 'propriétaire/référentiel')

--build-merge-requests

GitLab : créer des requêtes de fusion en tant qu’environnements

--build-pull-requests

Créer chaque demande d’extraction en tant qu’environnement

--build-draft-pull-requests

Création de requêtes d’extraction de brouillons

--build-pull-requests-post-merge

Créer des requêtes d’extraction en fonction de leur état de post-fusion

--build-wip-merge-requests

GitLab : création de requêtes de fusion en cours

--merge-requests-clone-parent-data

GitLab : données de clone pour les requêtes de fusion

--pull-requests-clone-parent-data

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

--resync-pull-requests

Resynchroniser les données de l’environnement des demandes d’extraction sur chaque version

--fetch-branches

Récupérer toutes les branches à partir de la distante (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', 'défaut', 'manuel', 'parent')

--url

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

--shared-key

Webhook : clé secrète partagée JWS

--file

Nom d’un fichier local qui contient le script à charger.

--events

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

--states

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

--environments

Les identifiants d’environnement à inclure

--excluded-environments

Les identifiants d’environnement à exclure

--from-address

[Facultatif] Adresse de l’expéditeur personnalisée pour les e-mails d’alerte

--recipients

Adresse électronique du ou des destinataires

--channel

Canal Slack

--routing-key

Clé de routage PagerDuty

--category

La catégorie Logique de sumo, utilisée pour le filtrage

--index

Index Splunk

--sourcetype

Type de source d’événement Splunk

--protocol

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

--syslog-host

Relais/hôte collecteur Syslog

--syslog-port

Port du relais/collecteur Syslog

--facility

Fonctionnalité 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

Indique si la vérification de certificat HTTPS doit être activée (recommandé).

--header

En-tête(s) HTTP à utiliser dans les requêtes de 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

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

integration:validate

magento-cloud 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 une sélection dans une liste.

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

local:build

magento-cloud 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>]...

Créer localement le projet actuel

Arguments

app

Spécification des applications à créer

Options

Pour les options globales, voir Options globales.

--abslinks, -a

Utiliser des liens absolus

--source, -s

Répertoire source. La valeur par défaut est la racine du projet actuel.

--destination, -d

La destination, à laquelle la racine web de chaque application sera associé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 à partir de la source

--clone

Utilisation de Git pour cloner l’HEAD actuel dans le répertoire de génération

--run-deploy-hooks

Exécuter le déploiement et/ou les hooks post_deploy

--no-clean

Ne pas supprimer les anciennes versions

--no-archive

Ne pas créer ni utiliser d’archive de version

--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 crochets après la génération

--no-deps

N’installez pas de 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

Supprimer : définissez le nombre de projets simultanés qui seront traités simultanément.

--lock

Drush : création ou mise à jour d'un fichier de verrouillage (disponible uniquement avec Drush version 7+)

local:dir

magento-cloud magento-cloud dir [<subdir>]

Recherche de la racine de projet locale

Arguments

subdir

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

Options

Pour les options globales, voir Options globales.

metrics:all

magento-cloud 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]

BETA Afficher les mesures du processeur, du disque et de la mémoire pour un environnement

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--range, -r

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

--interval, -i

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

--to

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

--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ères génériques.

--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ères génériques.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

metrics:cpu

magento-cloud 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]

BETA Afficher l’utilisation du processeur dans un environnement

Options

Pour les options globales, voir Options globales.

--range, -r

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

--interval, -i

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

--to

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

--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ères génériques.

--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ères génériques.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

metrics:disk-usage

magento-cloud 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 dans un environnement

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--range, -r

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

--interval, -i

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

--to

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

--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ères génériques.

--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ères génériques.

--tmp

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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*, used*, limit*, percent*, ipercent*, tmp_percent*, ilimit, iused, tmp_ilimit, tmp_ipercent, 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

metrics:memory

magento-cloud 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]

BETA Afficher l’utilisation de la mémoire dans un environnement

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--range, -r

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

--interval, -i

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

--to

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

--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ères génériques.

--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ères génériques.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

mount:download

magento-cloud 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] [-i|--identity-file IDENTITY-FILE]

Téléchargement de fichiers à partir d’un montage à l’aide de la synchronisation

Options

Pour les options globales, voir Options globales.

--all, -a

Téléchargement depuis toutes les montures

--mount, -m

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

--target

Répertoire vers 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

Suppression des fichiers superflus dans le répertoire cible

--exclude

Fichier(s) à exclure du téléchargement (modèle)

--include

Fichier(s) à ne pas exclure (motif)

--refresh

Actualisation ou non du cache

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

--identity-file, -i

Une identité SSH (clé privée) à utiliser

mount:list

magento-cloud 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 de montages

Options

Pour les options globales, voir Options globales.

--paths

Sortie des chemins de montage uniquement (une par ligne)

--refresh

Actualisation ou non 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

mount:size

magento-cloud magento-cloud mount:size [-B|--bytes] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Vérification de l’utilisation des supports sur le disque

Use this command to check the disk size and usage for an application's mounts.

Mounts are directories mounted into the application from a persistent, writable
filesystem. They are configured in the mounts key in the application configuration.

The filesystem's total size is determined by the disk key in the same file.

Options

Pour les options globales, voir Options globales.

--bytes, -B

Afficher les tailles en octets

--refresh

Actualisation du cache

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : disponibles, max, montées, percent_used, tailles, utilisées. Les caractères % ou * peuvent être utilisés comme caractères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--identity-file, -i

Une identité SSH (clé privée) à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

mount:upload

magento-cloud 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] [-i|--identity-file IDENTITY-FILE]

Chargement de fichiers sur un montage à l’aide de la synchronisation

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

Suppression des fichiers superflus dans le montage

--exclude

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

--include

Fichier(s) à ne pas exclure (motif)

--refresh

Actualisation ou non du cache

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--instance, -I

Un ID d’instance

--identity-file, -i

Une identité SSH (clé privée) à utiliser

operation:list

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

Opérations d’exécution Liste Beta 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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--format

Format de sortie : tableau, csv, tsv ou brut

--columns, -c

Colonnes à afficher. Colonnes disponibles : service*, nom*, début*, 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

operation:run

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

BETA 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 de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

--worker

Nom du travailleur

--no-wait, -W

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

--wait

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

project:clear-build-cache

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

Effacer le cache de création d’un projet

Options

Pour les options globales, voir Options globales.

--project, -p

ID ou URL du projet

project:get

magento-cloud magento-cloud get [-e|--environment ENVIRONMENT] [--depth DEPTH] [--build] [-p|--project PROJECT] [-i|--identity-file IDENTITY-FILE] [--] [<project>] [<directory>]

Clonage local d’un projet

Arguments

project

ID de projet

directory

Répertoire vers lequel effectuer le clonage. Par défaut, titre du projet

Options

Pour les options globales, voir Options globales.

--environment, -e

ID d’environnement à cloner. La valeur par défaut est le projet ou le premier environnement disponible.

--depth

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

--build

Création du projet après clonage

--project, -p

ID ou URL du projet

--identity-file, -i

Une identité SSH (clé privée) à utiliser

project:info

magento-cloud 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>]

Lecture ou définition des propriétés d’un projet

Arguments

property

Nom de la propriété

value

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

Options

Pour les options globales, voir Options globales.

--refresh

Actualisation ou non du cache

--date-fmt

Format de date (en tant que 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer 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

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

project:list

magento-cloud 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]

Obtention d’une liste de tous les projets actifs

Options

Pour les options globales, voir Options globales.

--pipe

Permet de générer une liste simple d’ID de projet. Désactive la pagination.

--region

Filtrage par région (correspondance exacte)

--title

Filtrage par titre (recherche non sensible à la casse)

--my

Afficher uniquement les projets que vous possédez

--refresh

Actualisation ou non de la liste

--sort

Propriété à trier par

--reverse

Tri dans l’ordre inverse (décroissant)

--page

Numéro de page. Cela active 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, organization_name, status (* = 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--date-fmt

Format de date (en tant que chaîne de format de date PHP)

project:set-remote

magento-cloud magento-cloud set-remote [<project>]

Définition du projet distant pour le référentiel Git actuel

Arguments

project

ID de projet

Options

Pour les options globales, voir Options globales.

repo:cat

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

Lecture d’un fichier dans le référentiel de projet

Arguments

path

Chemin d’accès au fichier

Options

Pour les options globales, voir Options globales.

--commit, -c

La validation SHA. Cela peut également accepter les suffixes "HEAD" et caret (^) ou tilde (~) pour les validations parentes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

repo:ls

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

Liste des 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 les fichiers uniquement

--git-style

Sortie de style similaire à "git ls-tree"

--commit, -c

La validation SHA. Cela peut également accepter les suffixes "HEAD" et caret (^) ou tilde (~) pour les validations parentes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

repo:read

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

Lecture d’un répertoire ou d’un fichier dans le référentiel de projet

Arguments

path

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

Options

Pour les options globales, voir Options globales.

--commit, -c

La validation SHA. Cela peut également accepter les suffixes "HEAD" et caret (^) ou tilde (~) pour les validations parentes.

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

route:get

magento-cloud 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>]

Affichage d’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

Format de date (en tant que chaîne de format de date PHP)

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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 magento-cloud routes [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<environment>]

Répertorier toutes les routes d’un environnement

Arguments

environment

ID d’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 : route*, type*, to*, 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

self:install

magento-cloud 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 shell pour la saisie semi-automatique (bash ou zsh)

self:update

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

Mise à jour de 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 les versions de correctif

--unstable

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

--manifest

Remplacement de l’emplacement du fichier manifeste

--current-version

Remplacer la version actuelle

--timeout

Délai d’expiration de la vérification de version

service:list

magento-cloud 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 ou non du cache

--pipe

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

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." 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ères génériques. Les valeurs peuvent être fractionnées par des virgules (par exemple "a,b,c") et/ou des espaces blancs.

--no-header

Ne pas générer l’en-tête du tableau

service:mongo:dump

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

Création d’un vidage d’archive binaire de données à partir de MongoDB

Options

Pour les options globales, voir Options globales.

--collection, -c

La collection à vider

--gzip, -z

Compresser la vidure à l’aide de gzip

--stdout, -o

Sortie à STDOUT au lieu d’un fichier

--relationship, -r

Relation de service à utiliser

--identity-file, -i

Une identité SSH (clé privée) à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

service:mongo:export

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

Exporter des données depuis MongoDB

Options

Pour les options globales, voir Options globales.

--collection, -c

La collection à exporter

--jsonArray

Exportation des données sous la forme d’un tableau JSON unique

--type

Type d’exportation, par exemple "csv"

--fields, -f

Champs à exporter

--relationship, -r

Relation de service à utiliser

--identity-file, -i

Une identité SSH (clé privée) à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

service:mongo:restore

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

Restauration d’un vidage d’archive binaire de données dans MongoDB

Options

Pour les options globales, voir Options globales.

--collection, -c

La collection à restaurer

--relationship, -r

Relation de service à utiliser

--identity-file, -i

Une identité SSH (clé privée) à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

service:mongo:shell

magento-cloud magento-cloud mongo [--eval EVAL] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Utilisation du conteneur MongoDB

Options

Pour les options globales, voir Options globales.

--eval

Transmettre un fragment JavaScript au conteneur

--relationship, -r

Relation de service à utiliser

--identity-file, -i

Une identité SSH (clé privée) à utiliser

--project, -p

ID ou URL du projet

--environment, -e

Identifiant de l’environnement. Utilisez "." pour sélectionner l’environnement par défaut du projet.

--app, -A

Nom de l’application distante

service:redis-cli

magento-cloud magento-cloud redis [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [<args>]

Accès à l’interface de ligne de commande Redis

Arguments

args

Arguments à ajouter à la commande Redis

Options

Pour les options globales, voir Options globales.

--relationship, -r