@zohocrm/zdk-cli
v1.0.2-beta
Published
ZDK CLI (Zoho Development Kit CLI) is a set of CLI tools that you can use to interact with and manage your CRM org metadata in a developer-friendly way.
Downloads
25
Readme
- Initialise a project in local and logins to the crm account
- Create and manage the meta of the resources
- Deploy resources to the crm org
- Exports the resources
To get started with the zdk CLI, you can go through our documentation CLI documentation.
ZDK
ZDK command line interface that simplifies source-driven development and extension of Zoho products.
How do I install and use ZDK?
Prerequisite
Refer this link for installing Node.js platform.Once Node is installed, verify it by running the following command.
$ node -v
$ npm -v
NOTE
- Installing Node.js should install npm as well.
- The ZDK-CLI is compatible only with node version >= 14.17.6 and npm version >= 8.1.0 .
Installing ZDK CLI
Run the following command to install the ZDK cli node package.
$ npm install -g @zohocrm/zdk-cli
NOTE
If you need to setup the cli in current directory alone use the same command without
-g
option.Alternatively you can visit CLI Installation Documentation for installation instructions.
Commands
The command zdk --help
lists all the available commands and zdk <command> --help
shows more details for provided command (if exists).
List of the available commands
Command | Description ------- | ----------- init | Initializes the ZDK CLI project directory. auth:whoami | Displays the authorized user and the connected CRM org. auth:login | Initializes the ZDK CLI project directory. Require access to a web browser auth:logout | Logs out of Zoho CRM org. org:status | Displays the local changes made after the previous pull or push. org:pull | Pulls the metadata to the local ZDK CLI project directory. org:pull:resolve | Resolves the conflict file. org:pull:revert | Reverts the pull operation. org:pull:update | Updates the local directory with the pulled data. org:push | Pushes changes to org. org:push:result | Displays the result of the push process and updates local directory in case of success response. org:push:list | Displays the list of the recent push operations that happened in the org. org:list | Lists the authorized CRM orgs. org:export | Exports the ZDK CLI project in a zip file to share it with other developers. meta:create | Creates new metadata.