| i18nReady | true | ||||
|---|---|---|---|---|---|
| title | La CLI | ||||
| description | Découvrez les CLI de StudioCMS et comment les utiliser. | ||||
| sidebar |
|
||||
| tableOfContents |
|
import { Steps } from '@astrojs/starlight/components'; import { PackageManagers } from 'starlight-package-managers' import ReadMore from '~/components/ReadMore.astro';
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/upgrade: Mettre à niveau les projets StudioCMS et leurs modules d’extension.
Voici une présentation de la CLI de StudioCMS et de ses composants.
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.
Depuis la racine de votre projet StudioCMS
<PackageManagers type="exec" pkg="studiocms" args={'[command]'} />
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
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é
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
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
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
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 à :
- Configurez votre fichier d’environnement (.env) avec des options pour :
- Utiliser un exemple de modèle
.env - Utiliser le générateur interactif
.envqui 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
- Utiliser un exemple de modèle
Pour une liste complète des variables d’environnement, consultez la documentation des variables d’environnement.
utilisation : studiocms users [options]
Utilitaires pour peaufiner les utilisateurs dans StudioCMS
Options :
-h, --help afficher l’aide pour la commande
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
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.
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.
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.
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.
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
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.
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.