Using Zendesk Command Line (ZCLI)

ZCLI is in open beta. It is fully supported by Zendesk, but may change at any time.

ZCLI is the Zendesk command-line interface, and contains tools that simplify building and deploying Zendesk apps. The tools let you create, test, validate, and package your apps locally.

Installing and updating ZCLI

Before installing ZCLI, you must have NodeJS v12 or above installed. Download the NodeJS source code or package at https://nodejs.org/en/download/.

$ npm install @zendesk/zcli -g

To update your ZCLI to the latest version, run the same installation command. ZCLI will warn you if your installed version is out of date.

Authentication

To authenticate with your Zendesk account, run the following command and enter your details such as subdomain, email, and password:

$ zcli login -i

The following commands need access to your Zendesk account: apps:create, apps:update, apps:validate, and apps:package.

If password access is disabled for your account, you can use an API token instead of a password. If you do, the username must be in the format [email protected]/token. See API token in the REST API docs.

ZCLI saves your authentication information securely in the keystore of your operating system.

If you use an API token instead of password, you should enter your authentication details as below:

Subdomain: your_subdomain
Email: [email protected]/token
Password: [TOKEN]

To remove authentication credentials or the current profile you can run the following command:

$ zcli logout

Commands

For the full list of commands for ZCLI while in beta, see the documentation in the ZCLI source code repository.