Studio CLI

Qu’est-ce que Studio CLI ?

Studio CLI est un utilitaire en ligne de commande disponible globalement pour interagir avec les fonctionnalités de WordPress Studio depuis votre terminal. Il est conçu pour fonctionner même lorsque l’application de bureau Studio est fermée, et il sert à gérer les sites locaux Studio et les environnements d’aperçu hébergés sur WordPress.com.

La CLI peut être installée avec Studio (elle est incluse) ou utilisée comme un module npm autonome appelé wp-studio. Son objectif principal est de vous permettre de contrôler les tâches liées à Studio — telles que la création d’aperçus, les mises à jour et l’authentification — depuis des scripts et des étapes de build.

Fonctionnalités principales

• Commande terminal globale (studio) : Exécutez des actions liées à Studio depuis n’importe où sans que Studio doive rester ouvert.
• Syntaxe de commande structurée (studio <area> <command> [options]) : Appliquez des modèles prévisibles pour les workflows de sites et d’aperçus.
• Ciblage de chemin (--path) : Orientez les commandes vers un répertoire de site Studio spécifique au lieu de dépendre du répertoire de travail actuel.
• Gestion de l’authentification WordPress.com : Utilisez studio auth login, studio auth logout et studio auth status pour connecter les actions CLI à un compte WordPress.com authentifié si nécessaire.
• Opérations sur les aperçus : Créez, listez, mettez à jour et supprimez des aperçus temporaires partageables sur WordPress.com avec des commandes comme studio preview create, studio preview list, studio preview update et studio preview delete.
• Commandes de gestion de sites locaux : Gérez les sites locaux Studio (état, création, liste, démarrage, arrêt, suppression et configuration) depuis le terminal avec les commandes studio site ....

Comment utiliser Studio CLI

1. Activez Studio CLI dans l’application Studio (recommandé si vous utilisez déjà Studio) :

   • Ouvrez l’application « WordPress Studio ».
   • Dans le menu principal, ouvrez la modale Paramètres (ou cliquez sur l’icône d’engrenage).
   • Activez « Studio CLI » et cliquez sur Enregistrer.
   • Sur macOS, on vous demandera peut-être votre mot de passe de compte pour autoriser l’installation.

2. Ouvrez un terminal et vérifiez la disponibilité :

   • Utilisez studio --help pour afficher un aperçu général.

3. Authentifiez-vous pour les tâches nécessitant un accès WordPress.com (ex. : aperçus) :

   • Exécutez studio auth login.
   • La commande ouvre un flux basé sur le navigateur ; vous recevrez un jeton d’authentification à coller dans le terminal.
   • Confirmez avec studio auth status.

4. Créez et partagez un aperçu à partir de votre site local Studio :

   • Depuis la racine de votre site local Studio, exécutez :

     cd /path/to/your/studio-site
     studio preview create
     

   • La CLI construit et téléverse votre site local vers un environnement d’aperçu et retourne une URL d’aperçu à partager.

5. Mettez à jour ou supprimez des aperçus en utilisant le nom d’hôte de l’aperçu :

   • Listez les aperçus avec studio preview list pour obtenir l’identifiant host.
   • Mise à jour :

     studio preview update <host>
     

   • Suppression :

     studio preview delete <host>
     

6. Ciblez un répertoire de site différent si nécessaire :

   • Ajoutez --path /path/to/site aux commandes au lieu de changer de répertoire :

     studio preview create --path /path/to/your/studio-site
     

Cas d’utilisation

• Gérez les sites locaux Studio sans quitter le terminal : Utilisez studio site status, studio site start, studio site stop et studio site list pour contrôler les environnements locaux dans un workflow axé sur les scripts.

• Créez des environnements d’aperçu à partager avec vos coéquipiers ou parties prenantes : Exécutez studio preview create depuis la racine de votre site local Studio pour générer une URL d’aperçu temporaire partageable hébergée sur WordPress.com.

• Itérez sur un aperçu au fur et à mesure des changements : Après la création initiale de l’aperçu, utilisez studio preview update <host> pour reconstruire et redéployer les changements du site local vers l’environnement d’aperçu existant.

• Nettoyez les environnements d’aperçu : Utilisez studio preview delete <host> pour supprimer définitivement un site d’aperçu une fois qu’il n’est plus nécessaire.

• Automatisez les workflows Studio dans les étapes de build : Utilisez les commandes studio depuis des scripts pour intégrer des tâches comme la création/mise à jour d’aperçus et la gestion de sites dans votre pipeline de développement.

FAQ

Ai-je besoin d’avoir l’application de bureau Studio ouverte pour utiliser Studio CLI ? Non. Studio CLI est conçu pour interagir avec les fonctionnalités de Studio depuis votre terminal, que Studio soit ouvert ou non.

Comment cibler un répertoire de site Studio spécifique avec une commande ? La plupart des commandes supposent que vous les exécutez depuis la racine d’un site géré par Studio. Sinon, utilisez l’option --path (par exemple, studio preview create --path /path/to/site).

Que se passe-t-il si j’exécute une commande d’aperçu déconnecté ? Les commandes nécessitant une authentification (comme studio preview create) renvoient une erreur et vous guident vers la connexion.

Comment trouver le nom d’hôte de l’aperçu à utiliser pour la mise à jour/suppression ? Exécutez studio preview list pour afficher les aperçus associés et leurs valeurs d’hôte. Utilisez cet hôte avec studio preview update <host> ou studio preview delete <host>.

D’où vient l’information d’authentification pour studio auth login ? La commande de connexion lance un flux basé sur le navigateur pour connecter la CLI à votre compte WordPress.com, puis fournit un jeton d’authentification à coller dans le terminal pour finaliser le processus.

Alternatives

• Flux de travail manuel dans l'interface Studio : Si vous n'avez pas besoin d'automatisation en terminal, utiliser directement l'application Studio permet de créer des aperçus et de contrôler les sites locaux sans intégration CLI.
• Outils en ligne de commande WordPress génériques (ex. WP-CLI + scripts personnalisés) : Là où les environnements d'aperçu spécifiques à Studio ne sont pas requis, vous pouvez combiner des outils WordPress en ligne de commande avec vos propres scripts pour gérer les tâches de site, bien que l'hébergement d'aperçus et les fonctionnalités spécifiques à Studio ne soient pas couverts.
• Autres approches d'orchestration WordPress locale : Au lieu des commandes de gestion de sites de Studio, vous pouvez utiliser d'autres configurations WordPress locales (conteneurisées ou scriptées) et gérer les aperçus via des étapes de déploiement séparées, au prix de la perte du flux de travail unifié de Studio CLI pour les aperçus/création/mise à jour/suppression et les sites gérés par Studio.