Zum Inhalt springen

Erste Schritte

Voraussetzungen

  • Node.js 18+
  • Ein WordPress-Theme oder Plugin, in dem du Blöcke installieren möchtest

Das blockstudio-Paket auf npm hat Version 0.0.1. Diese Veröffentlichung ist ein Platzhalter: Sie enthält nur einen add-Befehl, der Adding block: <name> ausgibt und beendet wird, ohne etwas abzurufen. Außerdem weist es init, list, search, remove, --yes und --dry-run als unbekannt zurück. Die Befehle auf diesen Seiten beschreiben die Registry-CLI im Repository Blockstudio (packages/registry).

Projekt initialisieren

Führe init im Stammverzeichnis deines Themes oder Plugins aus:

Shell
npx blockstudio init

CLI führt dich interaktiv durch die Einrichtung:

  1. Blockverzeichnis: Speicherort für installierte Blöcke (Standard: blockstudio)
  2. Registrys: Füge eine oder mehrere Registry-URLs mit Namen hinzu

Dadurch wird eine blocks.json-Datei erstellt:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json"
  }
}

Du kannst die interaktiven Eingabeaufforderungen auch überspringen:

Shell
npx blockstudio init --yes

Dadurch wird eine blocks.json mit Standardwerten erstellt. Du kannst sie anschließend manuell bearbeiten.

Einen Block hinzufügen

Shell
npx blockstudio add ui/tabs

Das Format lautet namespace/block, wobei namespace einem Schlüssel in deiner registries-Konfiguration entspricht.

CLI:

  1. Ruft die Registry ab
  2. Findet den Block
  3. Löst alle Abhängigkeiten auf (e.g. tabs hängt von tab-item ab)
  4. Lädt alle Dateien herunter
  5. Schreibt sie in dein Blockverzeichnis

Gibt es den Block nur in einer Registry, kannst du den Namensraum weglassen:

Shell
npx blockstudio add tabs

Gibt es ihn in mehreren Registrys, fordert CLI dich im Terminal zur Auswahl auf. Ohne Terminal wird mit einer Fehlermeldung abgebrochen, die die passenden Registrys auflistet. --yes wählt die erste Registry entsprechend der Reihenfolge in blocks.json aus.

Mehrere Blöcke hinzufügen

Shell
npx blockstudio add ui/tabs ui/hero ui/accordion

Alle Blöcke werden in einem einzigen Durchlauf installiert.

Vor der Installation eine Vorschau anzeigen

Shell
npx blockstudio add ui/tabs --dry-run

Hier siehst du, was installiert würde, ohne dass Dateien geschrieben werden.

Verfügbare Blöcke durchsuchen

Shell
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

list zeigt alle Blöcke aus allen Registrys oder einer bestimmten an. search sucht ohne Beachtung der Groß- und Kleinschreibung nach Teilübereinstimmungen in Blocknamen, Titeln und Beschreibungen.

Einen Block entfernen

Shell
npx blockstudio remove tabs

Dadurch wird der Blockordner gelöscht. Im interaktiven Modus wirst du um Bestätigung gebeten. Übergib --yes, um die Nachfrage zu überspringen.

CI und Automatisierung

init, add und remove akzeptieren --yes, um interaktive Eingabeaufforderungen zu überspringen. list und search fragen nie nach und weisen --yes als unbekannte Option zurück. Ist stdin kein Terminal (etwa bei CI-Läufen oder weitergeleiteter Eingabe), wechselt CLI in den nicht-interaktiven Modus: init überschreibt eine vorhandene blocks.json, add bricht mit einem Fehler ab, wenn ein Blockordner bereits vorhanden oder ein Blockname mehrdeutig ist, und remove löscht ohne Nachfrage.

Shell
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes