<img src="logo.png" alt="Zendesk Logo" width="100"/
ZCLI
ZCLI is a Zendesk CLI which helps you build and manage your Zendesk apps and themes from the command line. ZCLI is built using the oclif framework.
Note: ZCLI is the successor to Zendesk App Tools (ZAT). If you're currently using ZAT, please migrate to ZCLI for the latest features and support.
<img src="demo.gif" alt="Zendesk Logo" /
For more about ZCLI see the full documentation.
Getting started
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js v20.17.0 or higher is required. Installation is done using the yarn install command:
$ yarn global add @zendesk/zcliInstallation prerequisites for Linux
Currently ZCLI has a dependency on libsecret to save authentication information securely in the operating system's keychain.
Depending on your distribution, you will need to run one of the following commands prior to installing ZCLI:
- Debian/Ubuntu: sudo apt install libsecret-1-dev
- Red Hat-based: sudo yum install libsecret-devel
- Arch Linux: sudo pacman -S libsecret
Note for environments without Linux window manager (X11) support
ZCLI's credential manager has a dependency on Linux's windowing manager (X11) which will cause some commands to fail to run on an environment without window manager support. These commands include: zcli login, zcli logout and zcli profiles.
For headless Linux in a Docker container
- Install gnome-keyring, dbus-x11 and the corresponding libsecret package listed above
- Launch dbus