目次
1. イントロダクション
2. zcliとは？
3. zcliのインストール
4. プロファイルの作成
5. スターターファイルの生成
6. ローカルでのアプリのテスト
7. アプリのデプロイ
8. アプリの更新
9. 高度なトピックと将来の機能
10. 結論
イントロダクション
この記事では、Zendeskアプリの構築と管理に役立つ新しいZendeskコマンドラインインターフェース（zcli）とその機能について探求します。インストールからデプロイまで、さらにはいくつかの高度なトピックや将来の機能にも触れます。zcliがあなたのアプリ開発プロセスをスムーズにする方法を発見しましょう。
zcliとは？
zcliは、開発者がZendeskアプリを構築および管理するためのコマンドラインインターフェースです。zcliを使用すると、ターミナルから新しいアプリを作成し、直接Zendeskインスタンスにアップロードし、必要に応じて更新することができます。OpenCLIフレームワークを使用したNode.jsで構築されたzcliは、よりスムーズな開発者体験とネイティブのWindowsサポートを提供し、WindowsマシンでのLinuxインストールの必要性を排除します。また、M1 Maxなどの最新のハードウェアとの互換性も確保しています。
zcliのインストール
zcliを使用する前に、インストールする必要があります。システムにNode.jsバージョン12以上がインストールされていることを確認してください。ターミナルで`node -v`を実行してNode.jsバージョンを確認できます。バージョンが12未満の場合は、Node Version Managerを使用するか、Node.jsのWebサイトから必要な更新をダウンロードして更新できます。
zcliをインストールするには、ターミナルで次のコマンドを実行します。
```
npm install -g @zendesk/zcli
```
インストールが完了したら、`zcli -v`を実行してバージョンを確認できます。すべてがスムーズに進んだ場合、zcliを使用する準備ができています。
プロファイルの作成
zcliを使用してZendeskインスタンスとやり取りするには、プロファイルを作成する必要があります。zcliのプロファイルは、Zendeskでのログイン資格情報に対応します。各サブドメインには別々のプロファイルが必要です。プロファイルを作成するには、次の手順に従ってください。
1. ターミナルで`zcli login -i`コマンドを実行します。
2. プロンプトが表示されたら、Zendeskインスタンスのサブドメインを入力します。
3. プロンプトが表示されたら、メールアドレスとパスワードを入力します。パスワードアクセスを無効にしている場合は、メールアドレスの後にスラッシュとAPIトークンを入力して代わりに使用できます。
zcliは、オペレーティングシステムのキーストアにログイン情報を安全に保存し、ログイン情報の安全性を確保します。
スターターファイルの生成
zcliをインストールし、プロファイルを設定したら、Zendeskアプリのスターターファイルを作成できます。これらのファイルを生成するための複数の方法がありますが、ここでは基本的なアプリデータファイルに焦点を当てます。
1. アプリファイルを作成するディレクトリに移動します。
2. ターミナルで`zcli apps new`コマンドを実行します。
3. アプリファイルを保存するためのディレクトリ名を入力します。すでにディレクトリがある場合は、その名前を入力できます。そうでない場合は、アプリを保存するために新しいフォルダ名を指定します。
このコマンドを実行すると、zcliは、アプリ名、著者名、メールアドレスなどのメタデータを含む`manifest.json`ファイルを含む、アプリの必要なファイルとフォルダを生成します。
ローカルでのアプリのテスト
スターターファイルが用意されたら、zcliを使用してアプリをローカルでテストできます。これにより、パッケージのアップロードやインストールの必要なしに変更を加えて結果を確認できます。コンピューターでローカルWebサーバーを起動し、Zendeskアプリを実行するには、次の手順に従ってください。
1. ターミナルで`zcli apps server`コマンドを実行します。
2. 数秒後、`localhost:4567`でアプリサーバーが実行されていることが表示されます。
3. ZendeskインスタンスのURLに`?zcli_apps=true`を追加して、アプリをチケットサイドバーアプリとして指定します。
4. Zendeskインスタンスのチケットに移動して、チケットサイドバーにアプリが表示されることを確認します。
チケットを更新することで、アプリに加えた変更を確認できます。テストが終了したら、ターミナルで`Ctrl + C`を押してサーバーセッションを終了し、Zendesk URLから追加されたセクションを削除します。
アプリのデプロイ
アプリをローカルでテストし、デプロイする準備ができたら、zcliを使用してアプリを検証、パッケージ化、Zendeskインスタンスにアップロードできます。次のコマンドを使用してこれを実行できます。
```
zcli apps create
```
このコマンドを実行すると、zcliはアプリを検証、パッケージ化、Zendeskインスタンスにアップロードするプロセスを開始します。インストールプロセス中にエラーが発生した場合は、エラーメッセージと問題を解決するための手順が表示されます。アプリが正常にアップロードおよびデプロイされたら、「アプリと統合」のZendesk管理センターでそのインストールを確認できます。
アプリの更新
Zendeskインスタンスにすでにインストールされているアプリに変更や改善を加えた場合は、zcliを使用して簡単に更新できます。1つのコマンドで、変更をライブでZendeskインスタンスにプッシュできます。
```
zcli apps update
```
このコマンドを実行すると、zcliは最新の変更でアプリを更新します。アプリがインストールされているチケットを更新することで、更新を確認できます。
高度なトピックと将来の機能
この記事では、zcliの基本的な使用方法について説明しましたが、将来のビデオでより高度なトピックやコマンドを探求します。将来的に追加されるガイドテーマプレビューなどの追加機能の更新についてのアップデートにご期待ください。私たちは、より良い開発者体験を提供するためにzcliを改良するために常に取り組んでいます。
結論
この記事では、Zendeskアプリの構築と管理に役立つ新しいZendeskコマンドラインインターフェース（zcli）とその機能について紹介し、インストールプロセス、プロファイルの作成、スターターファイルの生成、ローカルでのアプリのテスト、アプリのデプロイ、および更新について説明しました。zcliを使用することで、アプリ開発ワークフローをスムーズにし、よりスムーズな開発者体験を享受できます。より高度なトピックについては、お楽しみに。
