ZCLI is a Zendesk CLI which helps you build and manage your Zendesk apps from the command line. ZCLI is currently available in beta and is built using the oclif.
For more about ZCLI see the full documentation.
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 12.10 or higher is required. Installation is done using the npm install command:
$ npm install @zendesk/zcli -g
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-get install libsecret-1-dev - Red Hat-based:
sudo yum install libsecret-devel - Arch Linux:
sudo pacman -S libsecret
This is a monorepo project powered by lerna and yarn workspaces. It contains multiple packages:
- packages/zcli contains base cli logic and core commands.
- packages/zcli-core contains shared libraries and utilities.
- packages/zcli-apps contains all zendesk apps commands.
ZCLI supports numerous commands. Further documentation on available commands can be found here.
$ zcli apps- manage zendesk apps workflow.$ zcli profiles- manage zcli profiles.$ zcli login- login to zendesk account.$ zcli logout- logout and remove active profile.$ zcli autocomplete- display autocomplete installation instructions.$ zcli help- display help for zcli
This is a monorepo project built using yarn and lerna workspaces. In order to set this up locally, run yarn after cloning this repository.
Running yarn dev or ./packages/zcli/bin/run will run the cli locally. Alternatively, you can also run symlink your local CLI to global zcli binary by running yarn run link:bin.
This project contains multi product cli commands and contains packages per product. This is all powered using yarn workspaces and lerna. At the moment, this repo contains 3 packages.
- packages/zcli contains all the core CLI code.
- packages/zcli-apps contains all the apps specific cli bits and is used in the core package as a plugin.
- packages/zcli-themes contains all the themes specific cli bits and is used in the core package as a plugin.
For a full reference, see the documentation.
Running the following command will create release tags, generate change logs docs and publish to npm.
You can create an issue on Github, report the issue in the Zendesk Developers Slack group, or for other problems, contact Zendesk Customer Support.
Copyright 2021 Zendesk, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.