CLI de Studio

Studio CLI est un utilitaire en ligne de commande disponible globalement qui vous permet d’interagir avec les fonctionnalités de WordPress Studio depuis votre terminal, que Studio soit ouvert ou non.

Il est particulièrement utile pour :

• Gérer les sites Studio locaux.
• Créer et mettre à jour des sites de prévisualisation sur WordPress.com.
• Exécuter des commandes WP-CLI.
• S’intégrer à des agents de codage IA. Chaque site inclut un fichier AGENTS.md.
• Intégrer Studio à des scripts et à des étapes de build.

Installation

Application Studio

1. Ouvrez l’application « WordPress Studio ».
2. Dans le menu principal, ouvrez la fenêtre Réglages. Vous pouvez également cliquer sur l’icône d’engrenage dans le coin supérieur droit de l’application.
3. Activez l’option « Studio CLI » et cliquez sur Enregistrer.
4. Sur macOS, vous serez invité à saisir le mot de passe de votre compte pour autoriser l’installation.

Installateur autonome

macOS / Linux

curl -fsSL https://wordpress.studio/install.sh | bash

Windows (PowerShell)

irm https://wordpress.studio/install.ps1 | iex

Ouvrez un nouveau terminal afin que studio soit dans votre PATH, puis vérifiez :

studio --help

Utilisation

Le Studio CLI s’utilise avec la commande studio. Toutes les commandes suivent le schéma :

studio <area> <command> [options]

Vous pouvez consulter un aperçu général à tout moment avec :

studio --help

La plupart des commandes sont conçues pour être exécutées depuis le répertoire racine d’un site géré par Studio. Pour cibler un répertoire de site différent de votre répertoire de travail actuel, utilisez l’option --path :

studio <area> <command> --path /path/to/site

Commandes d’authentification

Utilisez les commandes auth pour gérer votre authentification WordPress.com pour les fonctionnalités de Studio qui nécessitent d’être connecté (par exemple, les sites de prévisualisation).

studio auth login      # Log in to WordPress.com
studio auth logout     # Log out and clear WordPress.com authentication
studio auth status     # Check authentication status

• studio auth login ouvre un flux d’authentification dans le navigateur pour connecter le CLI à votre compte WordPress.com. Vous recevrez un jeton d’authentification à coller dans le terminal pour terminer le processus de connexion.
• studio auth status indique si vous êtes actuellement authentifié et affiche le compte utilisé.
• studio auth logout déconnecte le CLI de votre compte WordPress.com et efface les identifiants enregistrés.

Si vous exécutez une commande nécessitant une authentification (comme studio preview create) alors que vous êtes déconnecté, le CLI renverra une erreur et vous indiquera comment vous connecter.

Utilisez le flag --help pour afficher les options détaillées de n’importe quelle commande d’authentification :

studio auth --help
studio auth login --help

Commandes de site de prévisualisation

Les sites de prévisualisation sont des environnements temporaires et partageables hébergés sur WordPress.com qui reflètent votre site Studio local. Utilisez-les pour partager votre travail avec des collègues ou des parties prenantes sans nécessiter d’environnement local.

studio preview create          # Create a preview site
studio preview list            # List preview sites
studio preview update <host>   # Update an existing preview site
studio preview delete <host>   # Delete a preview site

Création d’un site de prévisualisation

Depuis la racine de votre site Studio local :

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

Cela va :

• Construire et téléverser votre site local vers un environnement de prévisualisation.
• Renvoyer une URL de prévisualisation que vous pouvez partager avec d’autres personnes.
• Vous obliger à être connecté avec studio auth login.

Vous pouvez également spécifier explicitement un répertoire de site :

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

Lister les sites de prévisualisation

Pour afficher tous les sites de prévisualisation associés à votre compte :

studio preview list

Cela affiche l’hôte de chaque prévisualisation (par exemple, example-preview.wpcomstaging.com), que vous utiliserez avec les commandes update et delete.

Mettre à jour et supprimer des sites de prévisualisation

Chaque site de prévisualisation est identifié par son nom d’hôte :

# Rebuild and redeploy changes from your local site to the preview site:
studio preview update <host>

# Permanently remove a preview site:
studio preview delete <host>

Utilisez studio preview list pour trouver la valeur <host> appropriée si vous ne l’avez pas sous la main.

Pour l’ensemble complet des options :

studio preview --help
studio preview create --help
studio preview update --help
studio preview delete --help

Commandes de gestion des sites locaux

Utilisez les commandes site pour gérer les sites Studio locaux sur votre machine : les créer, les démarrer, les arrêter, les lister et les configurer.

studio site status    # Get status of local site
studio site create    # Create a new local site
studio site list      # List local sites
studio site start     # Start local site
studio site stop      # Stop local site(s)
studio site delete    # Delete local site
studio site set       # Configure site settings

Créer un site local

Vous pouvez exécuter la commande create depuis un répertoire vide ou un répertoire contenant déjà les fichiers d’un site WordPress, à condition qu’il ne soit pas déjà répertorié dans Studio.

Pour créer un nouveau site local géré par Studio :

# Create a new site in the current working directory, using all the default options
studio site create

# Create a new site with a custom domain and HTTPS
studio site create --https --domain hello.wp.local

# Create a new site in a different directory
studio site create --path /path/to/site

Cela créera un nouveau site dans votre répertoire de travail actuel, démarrera le serveur WordPress et ouvrira automatiquement wp-admin dans votre navigateur une fois l’opération terminée.

Plusieurs options sont prises en charge lors de la création d’un nouveau site. Pour consulter l’ensemble complet des options :

studio site create --help

Créer un site local à l’aide de la Galerie de blueprints

Studio offre l’accès à la Galerie de blueprints où vous pouvez choisir et activer des blueprints pour créer un site. La Galerie de blueprints est également disponible via l’interface CLI. Les commandes pour utiliser les blueprints sont :

# Show all available blueprints for creating a local Studio site
studio blueprint list

# Create a local site with selected blueprint
studio blueprint use <blueprint-slug> --name "<site-name>"

Lister et inspecter les sites

# Show all local sites known to Studio:
studio site list

# Show details and current status for the site in the current directory:
studio site status

# Or explicitly for a given path:
studio site status --path /path/to/site

La sortie d’état inclut des informations telles que :

• Si le site est en cours d’exécution.
• L’URL locale (par exemple, http://localhost:PORT).
• Les principaux détails de configuration (version de PHP, état de la base de données, etc.).

Démarrer et arrêter des sites

# From inside a site directory:
studio site start
studio site stop

# Or by path:
studio site start --path /path/to/site
studio site stop --path /path/to/site

Démarrer un site lance les services locaux nécessaires pour y accéder dans un navigateur, tandis que l’arrêter arrête ces services.

Supprimer un site local

# Delete a site from Studio
studio site delete

# Delete the site and move the site directory to the system trash
studio site delete --files

Cette commande supprime le site de Studio et, éventuellement, les fichiers du site du disque.

Configurer les Réglages du site

Utilisez studio site set pour ajuster les Réglages d’un site local spécifique.

studio site set [options]

Voici quelques exemples d’utilisation de cette commande :

• Modifier la version de PHP ou de WordPress.
• Ajuster le domaine local ou le port.
• Activer ou désactiver des fonctionnalités qui affectent le fonctionnement de l’environnement local.

Pour voir la liste complète des options configurables, exécutez :

studio site set --help

Utiliser WP-CLI via Studio

La commande studio wp vous donne accès à WP-CLI dans le contexte d’un site géré par Studio, sans avoir besoin d’installer ou de configurer WP-CLI séparément.

studio wp [<wp-cli-command>] [<wp-cli-arguments>...]

Exemples (à exécuter depuis le répertoire racine de votre site) :

# Check WordPress version:
studio wp core version

# List installed plugins:
studio wp plugin list

# Run database upgrades:
studio wp core update-db

Points clés :

• Vous n’avez pas besoin d’une installation distincte de WP-CLI ; Studio le fournit et le configure pour vous.
• Les variables d’environnement, les chemins et les identifiants sont automatiquement définis en fonction du site sélectionné, de sorte que les commandes s’exécutent sur la bonne base de données et les bons fichiers.
• Vous pouvez utiliser --path si vous n’êtes pas dans le répertoire du site :

  studio wp plugin list --path /path/to/site

Pour obtenir la liste complète des sous-commandes et arguments WP-CLI pris en charge, consultez la documentation WP-CLI ou exécutez :

studio wp help
studio wp help <command>

Utiliser Studio CLI avec des agents de codage IA

Studio CLI fonctionne bien avec les outils de développement assisté par IA et les agents tels que Claude Code, Cursor et d’autres extensions d’IDE capables d’exécuter des commandes shell en votre nom.

Comme ces outils peuvent voir les fichiers de votre projet et exécuter des commandes dans le terminal, ils peuvent :

• Détecter que vous travaillez sur un projet WordPress géré par Studio.
• Appeler automatiquement les commandes studio pour gérer des sites locaux, des aperçus et des tâches WP-CLI.
• Utiliser la sortie des commandes pour orienter les modifications de code ou les étapes de débogage suivantes.

Flux de travail typiques avec les agents IA

Voici quelques façons concrètes de combiner Studio CLI avec un agent de codage IA.

1. Créer et gérer un site local

Vous pouvez demander à votre agent IA de créer et de lancer un site WordPress local via Studio. Par exemple, dans votre éditeur :

« Configure un nouveau site WordPress local avec la version 8.2 de PHP à l’aide de Studio dans ce dossier, démarre-le et donne-moi l’URL locale. »

En coulisses, l’agent pourrait exécuter :

studio site create --php 8.2
studio site start
studio site status

Ceci est utile lorsque :

• Vous créez rapidement un prototype de nouvelle extension ou d’un nouveau thème.
• Vous rejoignez un projet existant et souhaitez que l’agent configure l’environnement pour vous.

2. Débogage automatisé et opérations WP-CLI

Lorsque l’agent suggère un correctif ou une modification, il peut également exécuter des vérifications à l’aide de studio wp :

# Run database upgrades:
studio wp core update-db

# Check for current plugins:
studio wp plugin list

Vous pourriez demander :

« Exécute toutes les vérifications WP-CLI nécessaires via Studio pour diagnostiquer pourquoi le site renvoie une erreur 500, puis propose des correctifs. »

L’agent peut, de manière itérative :

1. Exécuter des commandes studio wp pour recueillir des informations de diagnostic.
2. Mettre à jour le code ou la configuration.
3. Réexécuter les commandes pour vérifier le correctif.

3. Créer et mettre à jour des sites de prévisualisation pour révision

Les agents peuvent vous aider à configurer et à maintenir des environnements de prévisualisation liés à votre branche ou à votre fonctionnalité :

« Crée un site de prévisualisation pour ce projet et donne-moi l’URL partageable. Ensuite, après chaque modification du code, mets à jour le même aperçu. »

Ce qui se traduit par :

studio auth login              # if needed
studio preview create          # initial deployment
studio preview update <host>   # after subsequent changes

Ceci est particulièrement utile lorsque :

• Partager l’avancement avec des parties prenantes non techniques.
• Collaborer avec des collègues qui ont besoin de voir le comportement en direct sans configurer un environnement local.

Bonnes pratiques lors de l’utilisation d’agents IA avec Studio CLI

• Restez à la racine d’un site Studio : De nombreuses commandes supposent que le répertoire courant est celui d’un site géré par Studio. Rappelez à votre agent de faire un cd vers le bon dossier ou d’utiliser --path.
• Soyez explicite dans les instructions : Lorsque vous donnez des instructions à un agent, mentionnez « utiliser l’interface de ligne de commande studio » ainsi que toute contrainte, par exemple :
  • « Ne pas supprimer les sites existants. »
  • « Demander une confirmation avant d’exécuter des migrations de base de données. »
  • « N’exécuter que des commandes studio wp en lecture seule. »
• Vérifiez les opérations destructrices : Des commandes comme studio site delete et studio preview delete peuvent supprimer des environnements. Demandez à l’agent d’afficher les commandes qu’il prévoit d’exécuter avant de les lancer.
• Utilisez l’authentification de manière réfléchie : Pour les commandes nécessitant un accès à WordPress.com (studio auth login, studio preview ...), assurez-vous d’être à l’aise avec le fait que l’agent lance des flux de connexion, et confirmez quel compte est utilisé.

En combinant Studio CLI avec des agents de codage IA, vous pouvez déléguer une grande partie de la configuration répétitive des environnements, des tests et de l’orchestration du déploiement, et vous concentrer davantage sur l’écriture et la révision de votre code WordPress.

Obtenir de l’aide

Chaque commande et sous-commande prend en charge --help pour la documentation en ligne, l’utilisation et les options disponibles. Par exemple :

studio --help
studio auth --help
studio preview create --help
studio site start --help
studio site set --help
studio wp help

C’est la meilleure façon d’explorer les fonctionnalités de la version précise de Studio CLI que vous avez installée.