Installing and Using Zet-CLI Tool

Zet is a command line interface that helps developers build and package widgets in Zoho CRM.

How can I .....

             1. Install
             2. Create Project
             3. Include Resources
             4. Start the Server
             5. Validate and Pack

1. Install

Installation involves installing Node.js and Zet-Cli.

To install Node.js, refer the help document Install Node.js. Once Node is installed, verify it by running the following command.

$ node -v

$ npm -v

Zet requires a minimum supported version of Node 6+ and NPM 

To install  Zet Cli execute the following command,

$ npm install -g zoho-extension-toolkit

To ensure Zet has been installed successfully, run the following command,

$ zet -v

This will return the version of zet installed on your computer.

2. Create Project

Navigate to the desired location in your computer and run the following command,

$ zet init

Select "Zoho CRM" from the list of services and provide a project name. This initializes your project directory and download all the dependencies.

3. Include Resources

All the files that are required for rendering your widget appears inside the "app" folder of your project.

4. Start the Server

To start a local HTTP server that allows to run your app locally and to test it in your sandbox instance, run the following command,

$ zet run

This will run the HTTP server in your local machine in the port number 5000. The port should not be occupied with any other process before starting the server. 

To verify whether the server has started successfully, open the following URL in your web browser: 
http://127.0.0.1:5000/app/widget.html

5. Validate and pack

To validate your application, run the following command,

$ zet validate

This will validate your app package and identify violations, if any. They should be corrected before updating the zip in our developer console.

To generate an uploadable zip of your application, run the following command,

$ zet pack

This will create a zip file under the "dist" folder of your project directory, which can be uploaded in our developer console under the ConnectedApp Section.