La CLI

Les interfaces en ligne de commandes (CLI) de StudioCMS sont des utilitaires qui vous permettent de créer rapidement de nouveaux projets StudioCMS et qui exposent des utilitaires utiles pour StudioCMS.

Il existe plusieurs CLI différentes qui font partie de l’écosystème StudioCMS :

• studiocms : La CLI de l’utilitaire StudioCMS.
• create-studiocms : La CLI d’échafaudage du projet StudioCMS.
• @studiocms/migrator: Migrez votre projet StudioCMS depuis une ancienne version vers la dernière version.
• @studiocms/upgrade: Mettre à niveau les projets StudioCMS et leurs modules d’extension.

Voici une présentation de la CLI de StudioCMS et de ses composants.

studiocms

Options et commandes complètes de la CLI

Utilisation : studiocms [options] [command]

Options :
  -V, --version  Afficher la version actuelle de la boîte à outils CLI.
  -h, --help     afficher l’aide pour la commande

COMMANDES
  - add               Ajoutez un ou plusieurs modules d’extension StudioCMS à votre projet
  - crypto            Utilitaires de chiffrement pour la sécurité de StudioCMS
  - get-turso         Installer la CLI de Turso
  - init              Initialiser le projet StudioCMS après une nouvelle installation.
  - users             Utilitaires pour peaufiner les utilisateurs dans StudioCMS
  - migrate           Gérer les migrations de bases de données pour StudioCMS.

Exemple d’utilisation

Depuis la racine de votre projet StudioCMS

npm

npx studiocms [command]

pnpm

pnpm studiocms [command]

yarn

yarn studiocms [command]

Présentation des commandes

add

utilisation : studiocms add <plugins...>

Ajoute un ou plusieurs modules d’extension StudioCMS à votre projet.

Arguments :
  plugins    Module(s) d’extension à installer

Options :
  -h, --help  afficher l’aide pour la commande

crypto

utilisation : studiocms crypto [command]

Utilitaires de chiffrement pour la sécurité

Options :
  -h, --help  afficher l’aide pour la commande

Commandes :
  gen-jwt     Générer un jeton JWT à partir d’un fichier clé

crypto gen-jwt

utilisation : studiocms crypto gen-jwt [options] <key-file>

Génére un jeton JWT à partir d’un fichier clé

Arguments :
  key-file                     un chemin relatif (par exemple, `../keys/libsql.pem`) depuis le répertoire actuel vers votre fichier de clé privée (.pem)

Options :
  -e, --exp <date-in-seconds>  Date d’expiration en secondes (>=0) à partir de l’heure d’émission (iat)
  -h, --help                   afficher l’aide pour la commande

debug

Utilisation : studiocms debug [options]

Affiche les informations de débogage concernant votre installation de StudioCMS.

Options :
  -h, --help  afficher l'aide pour la commande
  --debug     Activer le mode débogage

get-turso

Télécharge et installe la dernière version de Turso à l’aide du script de la documentation^ de Turso

Note

Windows nécessite l’utilisation de WSL selon Turso

Utilisation : getTurso [options]

Programme d’installation de la CLI de Turso

Options :
  -h, --help  afficher l’aide pour la commande

init

Utilisation : studiocms init [options]

Initialise le projet StudioCMS après une nouvelle installation.

Options :
  -d, --dry-run     Mode de fonctionnement en marche à vide
  --skip-banners    Ignorer toutes les bannières
  --debug           Activer le mode débogage
  -h, --help        Afficher l’aide pour la commande

La commande init fournit une expérience de configuration interactive qui vous aide à :

1. Configurez votre fichier d’environnement (.env) avec des options pour :
   • Utiliser un exemple de modèle .env
   • Utiliser le générateur interactif .env qui peut :
     • Configurer une connexion à une base de données (libSQL, MySQL, PostgreSQL)
     • Configurer les fournisseurs OAuth (GitHub, Discord, Google, Auth0)
     • Définir les clés de chiffrement et autres variables requises
   • Ignorer la création du fichier d’environnement

Pour une liste complète des variables d’environnement, consultez la documentation des variables d’environnement.

users

utilisation : studiocms users [options]

Utilitaires pour peaufiner les utilisateurs dans StudioCMS

Options :
  -h, --help  afficher l’aide pour la commande

migrate

Utilisation : studiocms migrate [options]

Gérer les migrations de bases de données pour StudioCMS.

Options :
  -h, --help      afficher l'aide pour la commande
  --debug         Activer le mode débogage
  -r, --rollback  Restaurer l'état avant la dernière migration
  -l, --latest    Migrer vers la dernière version
  --status        Afficher l'état actuel de la migration

create-studiocms

Options et commandes complètes de la CLI

Utilisation : create-studiocms [options] [command]

Options :
  -V, --version  Afficher la version actuelle de la boîte à outils CLI.
  -h, --help     afficher l’aide pour la commande
  --color        forcer la sortie couleur
  --no-color     désactiver la sortie couleur

Commandes :
  get-turso      Obtenir la dernière version de Turso.
  help           Afficher l’aide pour la commande
  interactive*   Démarrer la CLI interactive.

  * Indique la commande par défaut qui est exécutée lors de l’appel de cette CLI.

Exemple d’utilisation

npm

npm create studiocms@latest

pnpm

pnpm create studiocms@latest

yarn

yarn create studiocms

create-studiocms s’exécute automatiquement en mode interactif, mais vous pouvez également spécifier le nom et le modèle de votre projet avec des arguments de ligne de commandes.

npm

npm create studiocms@latest -- --template studiocms/basics --project-name my-studiocms-project

pnpm

pnpm create studiocms@latest --template studiocms/basics --project-name my-studiocms-project

yarn

yarn create studiocms --template studiocms/basics --project-name my-studiocms-project

Découvrez la liste complète^ de modèles, disponibles sur GitHub.

Lors de l’utilisation de --template, la CLI recherche tous les dossiers dans le dépôt de modèles. Par exemple, le modèle studiocms/basics pointe vers le projet basics dans le dossier studiocms à la racine du dépôt.

Présentation des commandes

Interactif (commande par défaut)

Utilisation : create-studiocms interactive [options]

Démarre la CLI interactive. Propulsée par [clack](https://clack.cc).

Cette commande ouvrira une invite CLI interactive pour vous guider tout au long
du processus de création d’un nouveau projet StudioCMS (ou d’un paquet de
l’écosystème StudioCMS) à l’aide de l’un des modèles disponibles.

Options :
  -t, --template <template>          Le modèle à utiliser.
  -r, --template-ref <template-ref>  La référence du modèle à utiliser.
  -p, --project-name <project-name>  Le nom du projet.
  -i, --install                      Installer les dépendances.
  -g, --git                          Initialiser un dépôt git.
  -y, --yes                          Ignorer toutes les invites et utiliser les valeurs par défaut.
  -n, --no                           Ignorer toutes les invites et utiliser les valeurs par défaut.
  -q, --skip-banners                 Ignorer toutes les bannières et tous les messages.
  -d, --dry-run                      N’effectuer aucune action.
  -h, --help                         afficher l’aide pour la commande
  --do-not-install                   Ne pas installer de dépendances.
  --do-not-init-git                  Ne pas initialiser un dépôt git.

get-turso

Vous pouvez télécharger et installer la dernière version de Turso à l’aide du script de la documentation^ de Turso.

Note

Windows nécessite l’utilisation de WSL selon Turso

Utilisation : getTurso [options]

Programme d’installation de la CLI de Turso

Options :
  -h, --help  afficher l’aide pour la commande

@studiocms/migrator

Un outil en ligne de commande pour migrer votre projet StudioCMS depuis d’anciennes versions vers la dernière version.

Exemple d’utilisation

Exécution depuis npm

npm

npx @studiocms/migrator

pnpm

pnpx @studiocms/migrator

yarn

yarn dlx @studiocms/migrator

Installation locale

1. Installez l’outil de migration à la racine de votre projet StudioCMS :

   npm

   npm i @studiocms/migrator

   pnpm

   pnpm add @studiocms/migrator

   yarn

   yarn add @studiocms/migrator

2. Une fois installé, ajoutez le script suivant à votre fichier package.json :

   package.json

   {
     "scripts": {
       "migrate-studiocms": "studiocms-migrator"
     }
   }

3. Démarrez l’outil de migration en exécutant la commande suivante dans le répertoire de votre projet :

   npm

   npm run studiocms-migrator

   pnpm

   pnpm run studiocms-migrator

   yarn

   yarn run studiocms-migrator

   Cela lancera un serveur web local. Ouvrez votre navigateur et rendez-vous à l’adresse http://localhost:4321 pour accéder à l’interface de l’outil de migration.

@studiocms/upgrade

Un outil de ligne de commande pour mettre à niveau votre installation StudioCMS et vos dépendances.

Vous pouvez exécuter cette commande dans votre terminal pour mettre à niveau vos intégrations officielles du projet Astro en même temps que vous mettez à niveau StudioCMS.

Exemple d’utilisation

npm

npx @studiocms/upgrade

pnpm

pnpm @studiocms/upgrade

yarn

yarn @studiocms/upgrade

Options

étiquette (facultatif)

Il est possible de passer une étiquette (tag) spécifique pour résoudre les paquets. Si elle n’est pas incluse, @studiocms/upgrade recherche l’étiquette la plus récente.

npm

npx @studiocms/upgrade beta

pnpm

pnpm @studiocms/upgrade beta

yarn

yarn @studiocms/upgrade beta