Breeze CLI

Outil en ligne de commande pour le système de gestion de contenu Breeze.

Installation

Utiliser le gestionnaire de paquets npm pour installer breeze-cli.

npm install -g @arkn/breeze-cli

Télécharger breeze à partir d'ici et les ajouter à la racine de votre template.

À propos

Le CLI fournit un ensemble de commandes qui vous aident à développer votre template plus rapidement.

Arguments et commandes pris en charge

Commandes et options principales

Usage: breeze [options] [command]

Options:
  -V, --version  Affiche le numéro de version
  -h, --help     Affiche l\'aide pour la commande

Commands:
  create         Créer un template
  add            Ajouter un élément à votre template
  remove         Supprimer un élément du template
  build          Builder votre template pour la production
  serve          Démarrer un serveur de développement

Création d'un nouveau template

Pour créer un nouveau modèle, exécutez :

breeze create my-new-template

La commande breeze create possède un certain nombre d'options et vous pouvez les explorer toutes en exécutant :

breeze create --help

Usage: create [options] <name>

Arguments:
  name               Nom du template

Options:
  -h, --here         Mettre les fichiers du template sur le chemin actuel
  -g, --no-git-init  Désactiver git init
  -n, --no-npm-init  Désactiver npm init
  --help             afficher l\'aide pour la commande

Ajouter une nouvelle section

Pour ajouter une nouvelle section à votre template, exécutez :

Note L'identifiant de section ou SID est toujours converti en snake case.

breeze add section new-section 'Nouvelle section' 'New section'

Vous avez la possibilité de générer des sections en appliquant des modèles spécifiques avec l'argument [ -m, --model ] :

breeze add section new-section -m header

| Liste des modèles disponibles | | ----------------------------- | header banner footer map contact-form

Vous pouvez ajouter votre fichier modèle personnalisé ici en le nommant de la manière suivante: [model-name].template

La sous-commande breeze add section dispose d'un certain nombre d'options et vous pouvez les explorer toutes en exécutant :

breeze add section --help

Usage: add section [options] <sid> [name-fr] [name-en]

Arguments:
  sid                                                  Identifiant de la section
  name-fr                                              Nom de la section en français
  name-en                                              Nom anglais de la section

Options:
  -u, --uid <uid>                                      Ajouter la chaîne uid de la section
  -f, --name-fr <name-fr>                              Ajouter le nom français de la section
  -e, --name-en <name-en>                              Ajouter le nom anglais de la section
  -p, --path <path>                                    Spécifier le chemin du composant de la section (default: "src/components/sections/")
  -P, --sections-path <sections-path>                  Spécifier le chemin de la liste des sections (default: "sections/index.json")
  -c, --e-commerce-categories <e-commerce-categories>  Nombre de catégories de e-commerce liées (default: 0)
  -n, --news-categories <news-categories>              Nombre de catégories de news liées (default: 0)
  -x, --no-component                                   Ne pas ajouter un fichier de composant
  -m, --model <model>                                  Modèle de section (default: "default")
  -h, --help                                           afficher l\'aide pour la commande

Supprimer la section

Warning La suppression de sections à partir de l'interface d'administration de breeze est plus recommandée car elle vous permet de supprimer également les données liées aux sections supprimées.

Pour supprimer la section de votre template, exécutez :

breeze remove section my-section

La sous-commande breeze remove section dispose d'un certain nombre d'options et vous pouvez les explorer toutes en exécutant :

breeze remove section --help

Usage: remove section [options] <sid>

Arguments:
  sid                                  Identifiant de la section

Options:
  -p, --path <path>                    Spécifier le chemin du composant de la section (default: "src/components/sections/")
  -P, --sections-path <sections-path>  Spécifier le chemin de la liste des sections (default: "sections/index.json")
  -a, --all                            Supprimer tous les SID liés
  -h, --help                           afficher l\'aide pour la commande

Démarrer le serveur de développement

Pour lancer votre template pendant le processus de développement, exécutez :

breeze serve

La commande breeze serve a un certain nombre d'options et vous pouvez les explorer toutes en exécutant :

breeze serve --help

Usage: serve [options]

Options:
  -h, --host       Spécifier l\'hôte
  -p, --port       Spécifier le port
  --help           afficher l\'aide pour la commande

Build

Pour builder votre template pour la production, exécutez :

breeze build

La commande breeze build dispose d'un certain nombre d'options et vous pouvez les explorer toutes en les exécutant :

breeze build --help

Usage: build [options]

Options:
  --help             afficher l\'aide pour la commande

Upgrade

Pour mettre à jour votre template, exécutez :

breeze upgrade

Warning Il est recommandé de valider ou de stasher vos modifications non validées avant de poursuivre.

Vous pouvez explorer la commande breeze upgrade en exécutant :

breeze upgrade --help

Usage: upgrade [options]

Options:
  -f, --force  Forcer la mise à niveau
  --help       afficher l\'aide pour la commande

Contribution

Les Pull requests sont les bienvenues. Pour les changements majeurs, veuillez d'abord ouvrir un issue pour discuter de ce que vous souhaitez changer.

Historique des modifications

Les changements détaillés pour chaque version sont documentés dans les notes de version.

Translations

• Anglais
• Français