Studio CLI

Was ist Studio CLI?

Studio CLI ist ein global verfügbares Kommandozeilen-Tool zur Interaktion mit WordPress Studio-Funktionen über das Terminal. Es ist so konzipiert, dass es auch funktioniert, wenn die Studio-Desktop-App geschlossen ist, und dient der Verwaltung lokaler Studio-Sites sowie Preview-Umgebungen, die auf WordPress.com gehostet werden.

Das CLI kann mit Studio installiert werden (es ist gebündelt) oder als eigenständiges npm-Modul wp-studio genutzt werden. Sein Kernzweck ist es, Studio-bezogene Aufgaben – wie die Erstellung von Preview-Sites, Updates und Authentifizierung – aus Skripten und Build-Schritten zu steuern.

Wichtige Funktionen

• Globales Terminal-Kommando (studio): Führen Sie Studio-bezogene Aktionen von überall aus, ohne dass Studio geöffnet bleiben muss.
• Strukturierte Befehlssyntax (studio <area> <command> [options]): Wenden Sie vorhersagbare Muster für Site- und Preview-Workflows an.
• Pfad-Zielung (--path): Richten Sie Befehle auf ein spezifisches Studio-Site-Verzeichnis aus, statt auf das aktuelle Arbeitsverzeichnis angewiesen zu sein.
• WordPress.com-Authentifizierungsverwaltung: Nutzen Sie studio auth login, studio auth logout und studio auth status, um CLI-Aktionen mit einem authentifizierten WordPress.com-Konto zu verknüpfen, wenn erforderlich.
• Preview-Site-Operationen: Erstellen, auflisten, aktualisieren und löschen Sie temporäre teilbare Preview-Sites auf WordPress.com mit Befehlen wie studio preview create, studio preview list, studio preview update und studio preview delete.
• Lokale Site-Verwaltungs-Befehle: Verwalten Sie lokale Studio-Sites (Status, Erstellen, Auflisten, Starten, Stoppen, Löschen und Konfigurieren) über das Terminal mit studio site ...-Befehlen.

So verwenden Sie Studio CLI

1. Studio CLI in der Studio-App aktivieren (empfohlen, wenn Sie Studio bereits nutzen):

   • Öffnen Sie die „WordPress Studio“-Anwendung.
   • Öffnen Sie im Hauptmenü das Einstellungen-Modal (oder klicken Sie auf das Zahnrad-Symbol).
   • Aktivieren Sie „Studio CLI“ und klicken Sie auf Speichern.
   • Unter macOS werden Sie möglicherweise nach Ihrem Konto-Passwort gefragt, um die Installation zu erlauben.

2. Terminal öffnen und Verfügbarkeit prüfen:

   • Führen Sie studio --help aus, um eine Übersicht zu erhalten.

3. Für Aufgaben mit WordPress.com-Zugriff authentifizieren (z. B. Preview-Sites):

   • Führen Sie studio auth login aus.
   • Der Befehl startet einen browserbasierten Flow; Sie erhalten ein Authentifizierungstoken, das Sie ins Terminal einfügen.
   • Überprüfen Sie mit studio auth status.

4. Preview-Site aus lokaler Studio-Site erstellen und teilen:

   • Vom Root Ihrer lokalen Studio-Site aus:

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

   • Das CLI baut Ihre lokale Site und lädt sie in eine Preview-Umgebung hoch und liefert eine teilbare Preview-URL zurück.

5. Previews mit Host-Namen aktualisieren oder löschen:

   • Listen Sie Previews mit studio preview list auf, um den host-Bezeichner zu erhalten.
   • Aktualisieren:

     studio preview update <host>
     

   • Löschen:

     studio preview delete <host>
     

6. Bei Bedarf ein anderes Site-Verzeichnis anvisieren:

   • Fügen Sie --path /path/to/site zu Befehlen hinzu, statt Verzeichnisse zu wechseln:

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

Anwendungsfälle

• Lokale Studio-Sites direkt im Terminal verwalten: Nutzen Sie studio site status, studio site start, studio site stop und studio site list, um lokale Umgebungen in skriptlastigen Workflows zu steuern.

• Preview-Umgebungen für Teammitglieder oder Stakeholder erstellen: Führen Sie studio preview create vom Root Ihrer lokalen Studio-Site aus, um eine temporäre teilbare Preview-URL auf WordPress.com zu erzeugen.

• Preview bei Änderungen iterieren: Nach der Erstellung nutzen Sie studio preview update <host>, um Änderungen aus der lokalen Site in die bestehende Preview-Umgebung neu zu bauen und bereitzustellen.

• Preview-Umgebungen aufräumen: Verwenden Sie studio preview delete <host>, um eine Preview-Site dauerhaft zu entfernen, sobald sie nicht mehr benötigt wird.

• Studio-Workflows in Build-Schritten automatisieren: Integrieren Sie studio-Befehle in Skripte, um Aufgaben wie Preview-Erstellung/-Updates und Site-Verwaltung in Ihre Entwicklungspipeline einzubinden.

FAQ

Muss die Studio-Desktop-App geöffnet sein, um Studio CLI zu nutzen? Nein. Studio CLI ist so konzipiert, dass es mit Studio-Funktionen interagiert, unabhängig davon, ob Studio geöffnet ist.

Wie richte ich einen Befehl auf ein spezifisches Studio-Site-Verzeichnis? Die meisten Befehle gehen davon aus, dass Sie sie vom Root einer Studio-verwalteten Site ausführen. Andernfalls nutzen Sie die --path-Option (z. B. studio preview create --path /path/to/site).

Was passiert, wenn ich einen Preview-Befehl ohne Anmeldung ausführe? Befehle, die Authentifizierung erfordern (wie studio preview create), geben einen Fehler zurück und weisen Sie an, sich anzumelden.

Wie finde ich den Preview-Host-Namen für Update/Löschung? Führen Sie studio preview list aus, um zugehörige Previews und deren Host-Werte anzuzeigen. Verwenden Sie diesen Host mit studio preview update <host> oder studio preview delete <host>.

Woher kommt die Authentifizierungsinformation für studio auth login? Der Login-Befehl startet einen browserbasierten Flow, um das CLI mit Ihrem WordPress.com-Konto zu verknüpfen, und liefert ein Token, das Sie ins Terminal einfügen, um den Vorgang abzuschließen.

Alternativen

• Manueller Studio-UI-Workflow: Wenn Sie keine Terminal-Automatisierung benötigen, deckt die direkte Nutzung der Studio-Anwendung die Erstellung von Vorschauen und die Steuerung lokaler Sites ab – ohne CLI-Integration.
• Generische WordPress-Befehlszeilen-Tools (z. B. WP-CLI + eigene Skripte): Wo Studio-spezifische Vorschau-Umgebungen nicht erforderlich sind, können Sie Befehlszeilen-WordPress-Tools mit eigenen Skripten kombinieren, um Site-Aufgaben zu verwalten – Vorschau-Hosting und Studio-spezifische Funktionen sind jedoch möglicherweise nicht abgedeckt.
• Andere Ansätze zur lokalen WordPress-Orchestrierung: Statt der Site-Management-Befehle von Studio können Sie unterschiedliche lokale WordPress-Setups (containerisiert oder skriptbasiert) nutzen und Vorschauen über separate Deployment-Schritte handhaben – auf Kosten des einheitlichen Studio-CLI-Workflows für Vorschau/Änderung/Löschung und Studio-verwaltete Sites.