Inhaltsverzeichnis

CLI-Referenz

Der Host bietet eine Kommandozeilenschnittstelle für die Verwaltung von Add-ins. Sie ermöglicht Installation, Deinstallation und Auflistung ohne grafische Oberfläche. Darüber hinaus gibt es einen Debug-Modus für die Add-in-Entwicklung.

Zurück zur Übersicht.

Erkennung

Der Host erkennt den CLI-Modus an bestimmten Kommandozeilenparametern. Wenn einer dieser Parameter übergeben wird, startet die Anwendung ohne GUI, führt die Operation aus und beendet sich mit einem Exit-Code.

Befehle

Add-in installieren

wdochost --install-extension <pfad>

Installiert ein .wvdsx-Paket in das Benutzer-Erweiterungsverzeichnis.

Parameter:

Ablauf:

  1. Das ZIP-Archiv wird in ~/.wvdsx/extensions/<publisher>.<name>/ entpackt.
  2. plugin.json wird geparst und validiert.
  3. engineVersion wird gegen die Host-Version geprüft.
  4. dllChecksum wird verifiziert (falls vorhanden).
  5. Das Add-in wird in die Extension-Registry eingetragen.

Beispiel:

wdochost --install-extension wvds.assets-manager-1.2.0.wvdsx

Exit-Codes:

Add-in deinstallieren

wdochost --uninstall-extension <id>

Entfernt ein installiertes Add-in.

Parameter:

Ablauf:

  1. Das Installationsverzeichnis des Add-ins wird gelöscht.
  2. Der Registry-Eintrag wird entfernt.

Beispiel:

wdochost --uninstall-extension wvds.assets-manager

Installierte Add-ins auflisten

wdochost --list-extensions

Listet alle installierten Add-ins mit Id, Version und Status auf.

Beispielausgabe:

wvds.assets-manager    1.2.0  active
wvds.core-services     1.0.0  active
demo.hello-world       1.0.0  not-activated

Debug-Modus

wdochost --debug-extension=<id>

Startet die GUI-Anwendung mit einem bestimmten Add-in im Debug-Modus. Dieser Modus ist für die Entwicklung gedacht und ermöglicht es, ein Add-in zu testen, ohne es vorher installieren zu müssen.

Parameter:

Verhalten:

Beispiel:

wdochost --debug-extension=demo.asset-editor

Pfade

Verzeichnis Pfad Beschreibung
Machine-Add-ins <exe>/plugins/ Vom Administrator gebundelte Add-ins (MSI/GPO, schreibgeschützt)
Benutzer-Add-ins ~/.wvdsx/extensions/ Vom Benutzer installierte Add-ins (Roaming-Profile-kompatibel)
Benutzer-Einstellungen ~/.wvdsx/settings.json Globale Einstellungen
Workspace-Einstellungen .wvdsx/settings.json Projektspezifische Einstellungen
Benutzer-Storage ~/.wvdsx/storage/<id>/ Persistenter Speicher pro Add-in
Workspace-Storage .wvdsx/storage/<id>/ Workspace-spezifischer Speicher pro Add-in
Log-Dateien ~/.wvdsx/logs/ Host- und Add-in-Logs
Plugin-Daten ~/.wvdsx/plugin-data/ Per-Plugin persistenter Zustand

Zurück zur Übersicht.