📝 Table des matières
Introduction
- Qu'est-ce que zcli ?
Démarrage avec zcli
- Installation de zcli
- Ajout d'un profil
- Création de fichiers de démarrage pour une nouvelle application Zendesk
- Test de l'application en local
- Déploiement de l'application sur votre instance Zendesk
- Mise à jour d'une application dans votre instance Zendesk
Limitations de zcli
- Limitations actuelles
- Solutions de contournement possibles
Thèmes et commandes avancés
- Fonctionnalités futures
- Suggestions pour des sujets futurs
Conclusion
Introduction
Vous recherchez une interface en ligne de commande qui peut vous aider à créer et gérer vos applications Zendesk ? Ne cherchez pas plus loin que zcli ! Dans cet article, nous explorerons ce qu'est zcli, pourquoi il a été créé et certaines de ses limitations actuelles. Nous vous guiderons également dans la création d'une application simple en utilisant le framework d'application Zendesk avec zcli. Enfin, nous parlerons de certaines des choses passionnantes que nous avons prévues pour zcli dans le futur.
Qu'est-ce que zcli ?
Zcli est une interface en ligne de commande qui vous aide à créer et gérer vos applications Zendesk. Avec zcli, vous pouvez créer de nouvelles applications, les télécharger directement sur votre instance Zendesk et les mettre à jour selon vos besoins directement depuis le terminal. Zcli est développé avec Node.js en utilisant le framework OpenCLI, ce qui offre une expérience de développement beaucoup plus fluide et une prise en charge native de Windows. Cela signifie plus besoin d'installer Linux sur les machines Windows pour exécuter les anciens outils d'applications Zendesk, ainsi qu'une compatibilité totale avec M1 Max.
Démarrage avec zcli
Installation de zcli
Pour commencer avec zcli, vous devez d'abord l'installer. Node v12 ou une version supérieure est requise, vous pouvez donc vérifier votre version de Node en exécutant `node -v` dans le terminal. Vous verrez le numéro de version s'afficher, qui dans mon cas est la version 16.13. Si votre version est inférieure à v12, vous pouvez la mettre à jour en utilisant Node Version Manager ou en vous rendant sur le site Web de Node pour télécharger les mises à jour nécessaires.
Ensuite, vous pouvez installer zcli en exécutant la commande `npm install @zendesk/zcli -g` dans le terminal. C'est tout ! Vous pouvez ensuite confirmer la version installée en exécutant `zcli -v`.
Ajout d'un profil
Un profil dans zcli correspond à vos identifiants de connexion dans Zendesk, et zcli prend en charge un profil par sous-domaine. Vous serez invité à saisir votre adresse e-mail, votre mot de passe et le sous-domaine de votre instance Zendesk. Si vous avez désactivé l'accès par mot de passe, vous pouvez utiliser un jeton d'API au format `email/token`.
Pour ajouter un profil, exécutez la commande `zcli login -i` dans le terminal. Vous serez invité à saisir votre sous-domaine, votre adresse e-mail et votre mot de passe. En termes de sécurité, zcli enregistre vos informations d'identification de manière sécurisée dans le trousseau de votre système d'exploitation.
Création de fichiers de démarrage pour une nouvelle application Zendesk
Tout comme les outils d'applications Zendesk, il existe plusieurs façons de générer des fichiers de démarrage pour votre application avec zcli. Dans le cadre de cet article, nous nous limiterons aux fichiers de données d'applications de base.
Pour commencer, nous nous rendrons dans le dossier du bureau, car c'est là que nous voulons que le répertoire de l'application soit situé. Ensuite, nous exécuterons la commande `zcli apps new`. La première invite vous demandera de saisir un nom de répertoire pour les fichiers de l'application. Si vous en avez déjà créé un, vous pouvez le saisir ici. Sinon, vous pouvez entrer un nouveau nom de dossier qui sera créé pour stocker l'application. Nous allons créer un nouveau répertoire appelé `ccli-example`.
Ensuite, vous serez invité à saisir le nom de l'auteur de l'application, son adresse e-mail et un nom pour l'application. Nous verrons dans un instant où ces détails peuvent être mis à jour, mais pour l'instant, ils peuvent être ce que vous voulez. Vous devriez voir un message de réussite vous indiquant que le projet a été créé.
Allons-y et accédons au répertoire du projet et ouvrons les fichiers dans VS Code. Ici, nous avons notre dossier d'assets et de traductions, qui contient tout ce dont nous avons besoin pour lancer une application simple dans Zendesk. Nous avons également notre fichier `manifest.json`, qui contient les métadonnées de l'application, y compris le nom de l'application, le nom de l'auteur et l'adresse e-mail que nous avons saisie il y a quelques instants.
Test de l'application en local
Avec zcli, nous pouvons démarrer un serveur web local pour exécuter une application Zendesk sur votre ordinateur. Cela facilite la création et les tests, car vous n'avez pas besoin de télécharger et d'installer un package à chaque fois que vous apportez des modifications pendant le développement de votre application.
Pour démarrer le serveur, exécutez la commande `zcli apps server` dans le terminal. Après quelques secondes, vous verrez que le serveur de l'application est maintenant en cours d'exécution sur `localhost:4567`. Ensuite, nous devrons ajouter `zcli_apps=true` à la fin de l'URL de notre instance Zendesk, de la même manière que vous l'avez peut-être fait par le passé. Comme l'application est spécifiée par défaut comme une application de barre latérale de ticket, passons maintenant à un ticket et faisons cela.
Et voilà ! Notre application entièrement fonctionnelle apparaît maintenant dans la barre latérale des applications de ticket. Nous pouvons apporter une modification à l'application, revenir à notre ticket, actualiser la page et les modifications seront prises en compte.
Lorsque vous êtes prêt à mettre fin à la session du serveur, appuyez simplement sur `ctrl + c` dans la fenêtre du terminal et supprimez la section ajoutée de l'URL de votre Zendesk. Quelques limitations à prendre en compte lors du test d'une application en local sont que les paramètres sécurisés ne seront pas rendus lors de l'utilisation du serveur zcli. De plus, si vous avez des exigences dans un fichier de configuration d'applications zcli, elles ne seront pas installées lors de l'utilisation du serveur zcli. Dans ces deux cas, l'application devra être installée dans votre instance Zendesk, ce que nous verrons dans la section suivante.
Déploiement de l'application sur votre instance Zendesk
Une fois que votre application a été testée et est prête à être déployée, les étapes suivantes consistent à valider et à empaqueter l'application, puis à la télécharger et à l'installer sur votre instance Zendesk. Cela se fait à l'aide d'une seule commande simple, la commande `zcli apps create`.
Dans le terminal, exécutez la commande `zcli apps create`, qui lancera le processus de validation, d'empaquetage et de téléchargement de l'application sur votre instance Zendesk. Si vous rencontrez des erreurs lors du processus d'installation, vous devrez simplement mettre à jour l'application comme ou
