Wednesday, November 13, 2024

Erstellen Sie Ihre erste Zendesk-App mit ZCLI

📝 Inhaltsverzeichnis

EinfĂŒhrung

– Was ist zcli?

Erste Schritte mit zcli

– Installation von zcli

– HinzufĂŒgen eines Profils

– Erstellen von Starterdateien fĂŒr eine neue Zendesk-App

– Lokales Testen der App

– Bereitstellen der App auf Ihrer Zendesk-Instanz

– Aktualisieren einer App auf Ihrer Zendesk-Instanz

EinschrÀnkungen von zcli

– Aktuelle EinschrĂ€nkungen

– Mögliche Workarounds

Fortgeschrittene Themen und Befehle

– ZukĂŒnftige Funktionen

– VorschlĂ€ge fĂŒr zukĂŒnftige Themen

Schlussfolgerung

📝 EinfĂŒhrung

Suchen Sie nach einer Befehlszeilenschnittstelle, die Ihnen beim Erstellen und Verwalten Ihrer Zendesk-Apps hilft? Suchen Sie nicht weiter als zcli! In diesem Artikel werden wir untersuchen, was zcli ist, warum es gebaut wurde, und einige seiner aktuellen EinschrĂ€nkungen. Wir werden Ihnen auch zeigen, wie Sie eine einfache App mit dem Zendesk-App-Framework zusammen mit zcli erstellen und ausfĂŒhren können. Schließlich werden wir ĂŒber einige der aufregenden Dinge sprechen, die wir fĂŒr zcli in der Zukunft geplant haben.

Was ist zcli?

Zcli ist eine Befehlszeilenschnittstelle, die Ihnen beim Erstellen und Verwalten Ihrer Zendesk-Apps hilft. Mit zcli können Sie neue Apps erstellen, sie direkt auf Ihrer Zendesk-Instanz hochladen und die Apps bei Bedarf direkt vom Terminal aus aktualisieren. Zcli ist mit Node.js unter Verwendung des OpenCLI-Frameworks erstellt, was zu einer viel reibungsloseren Entwicklererfahrung und nativer Windows-UnterstĂŒtzung fĂŒhrt. Dies bedeutet, dass Sie keine Linux-Installation auf Windows-Maschinen mehr benötigen, um die frĂŒheren Zendesk-Apps-Tools auszufĂŒhren, sowie volle KompatibilitĂ€t mit M1 Max.

📝 Erste Schritte mit zcli

Installation von zcli

Um zcli zu installieren, benötigen Sie Node v12 oder höher. Sie können Ihre Node-Version ĂŒberprĂŒfen, indem Sie `node -v` im Terminal ausfĂŒhren. Wenn Ihre Version unter v12 liegt, können Sie sie mit Node Version Manager aktualisieren oder auf die Node-Website gehen, um die erforderlichen Updates herunterzuladen.

Als nĂ€chstes können Sie zcli installieren, indem Sie den Befehl `npm install @zendesk/zcli -g` im Terminal ausfĂŒhren. Sie können die Installationsversion bestĂ€tigen, indem Sie `zcli -v` ausfĂŒhren.

HinzufĂŒgen eines Profils

Ein Profil in zcli entspricht Ihren Anmeldeinformationen in Zendesk, und zcli unterstĂŒtzt ein Profil pro Subdomain. Sie werden aufgefordert, Ihre E-Mail-Adresse, Ihr Passwort und Ihre Zendesk-Instanz-Subdomain einzugeben. Wenn Sie den Zugriff auf das Passwort deaktiviert haben, können Sie stattdessen einen API-Token verwenden, der das Format `E-Mail/Token` verwendet.

Erstellen von Starterdateien fĂŒr eine neue Zendesk-App

Ähnlich wie bei den Zendesk-Apps-Tools gibt es verschiedene Möglichkeiten, Starterdateien fĂŒr Ihre App zu generieren. FĂŒr diesen Artikel beschrĂ€nken wir uns auf die grundlegenden App-Daten-Dateien. Um zu beginnen, werden wir `cd` in den Desktop, da wir dort das App-Verzeichnis haben möchten. Als nĂ€chstes werden wir den Befehl `zcli apps new` ausfĂŒhren. Die erste Aufforderung, die Sie sehen werden, ist die Eingabe eines Verzeichnisnamens fĂŒr die App-Dateien. Wenn Sie bereits eines erstellt haben, können Sie es hier eingeben. Andernfalls können Sie einen neuen Ordnername eingeben, der erstellt wird, um die App zu speichern. Wir werden einen neuen Ordner namens `ccli-example` erstellen. Als nĂ€chstes werden wir aufgefordert, den Namen des App-Autors, die E-Mail-Adresse und einen Namen fĂŒr die App einzugeben. Wir werden gleich sehen, wo diese Details aktualisiert werden können, aber fĂŒr jetzt können sie beliebig sein. Sie sollten eine Erfolgsmeldung sehen, die besagt, dass das Projekt erstellt wurde. Lassen Sie uns nun in das Projektverzeichnis `cd` und die Dateien in VS Code öffnen.

Lokales Testen der App

Mit zcli können wir einen lokalen Webserver starten, um eine Zendesk-App auf Ihrem Computer auszufĂŒhren. Dies erleichtert das Erstellen und Testen, da Sie nicht jedes Mal, wenn Sie Änderungen wĂ€hrend der Entwicklung Ihrer App vornehmen, eine Paket-Upload- und -Installation benötigen. Um den Server zu starten, fĂŒhren wir den Befehl `zcli apps server` im Terminal aus. Nach ein paar Sekunden sehen Sie, dass der App-Server jetzt auf `localhost:4567` lĂ€uft. Als nĂ€chstes mĂŒssen wir `zcli_apps=true` an das Ende unserer Zendesk-Instanz-URL anhĂ€ngen, Ă€hnlich wie Sie es in der Vergangenheit getan haben. Da die App standardmĂ€ĂŸig als Ticket-Sidebar-App angegeben ist, gehen wir jetzt zu einem Ticket und tun dies.

Bereitstellen der App auf Ihrer Zendesk-Instanz

Sobald Ihre App getestet und bereit ist, bereitzustellen, sind die nĂ€chsten Schritte das Validieren und Verpacken der App sowie das Hochladen und Installieren der App auf Ihrer Zendesk-Instanz. Dies wird mit einem einfachen Befehl, dem `zcli apps create`-Befehl, erreicht. Im Terminal fĂŒhren wir den Befehl `zcli apps create` aus, der den Prozess des Validierens, Verpackens und Hochladens der App auf Ihre Zendesk-Instanz startet. Wenn Sie wĂ€hrend des Installationsprozesses auf Fehler stoßen, mĂŒssen Sie die App wie in der Fehlermeldung beschrieben aktualisieren und den Befehl `zcli apps create` erneut ausfĂŒhren.

Aktualisieren einer App auf Ihrer Zendesk-Instanz

Sie haben also eine App auf Ihrer Zendesk-Instanz installiert, und seitdem haben Sie einige Änderungen und Verbesserungen vorgenommen, die Sie gerne zur Aktualisierung der App pushen möchten. Auch hier können wir mit nur einem einfachen Befehl die Änderungen live auf Ihre Zendesk-Instanz ĂŒbertragen. Wir tun dies mit dem Befehl `zcli apps update`.

📝 EinschrĂ€nkungen von zcli

Aktuelle EinschrÀnkungen

Da ccli derzeit in der offenen Beta ist, wird es einige EinschrĂ€nkungen bei der Verwendung von zcli geben, wĂ€hrend wir auf die allgemeine VerfĂŒgbarkeit hinarbeiten. Die lokale Vorschau des Zendesk Guide-Themas wird beispielsweise derzeit nicht unterstĂŒtzt, wenn Sie zcli verwenden. Wenn Sie die lokale Vorschau des Zendesk Guide-Themas verwenden, um benutzerdefinierte Themen fĂŒr Ihr Zendesk-Hilfecenter zu erstellen, sollten Sie weiterhin die Zendesk-Apps-Tools verwenden. Eine weitere EinschrĂ€nkung besteht darin, dass einige Befehle fehlschlagen, wenn Sie Linux auf Windows mit WSL ausfĂŒhren, es sei denn, Sie verwenden eine Version von WSL mit UnterstĂŒtzung fĂŒr grafische BenutzeroberflĂ€chen-Apps mit X11.

Mögliche Workarounds

Wir haben einen Link zu den relevanten Dokumenten in der Beschreibung unten hinzugefĂŒgt, der weitere Details zu diesen EinschrĂ€nkungen und möglichen Workarounds enthĂ€lt.

📝 Fortgeschrittene Themen und Befehle

ZukĂŒnftige Funktionen

WĂ€hrend zcli derzeit in der offenen Beta ist, werden wir weiterhin daran arbeiten, weitere Funktionen wie Guide zu integrieren.