📝 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.
