Creating extension using CLI | Online Help | Zoho Projects

Creating extension using CLI

Overview

Zoho Marketplace is an online store where you can upload the extensions you develop for any of the products of Zoho. You can also use the available extensions in our store for your business. This developer guide will help you build an extension and deploy it to our Marketplace.

Things to remember before you start

The manifest file

Every extension must have its own plugin-manifest.json file that defines its behavior. After defining this file, you can use client-side technologies like HTML, JavaScript, and CSS to build your extension. You can host the extension privately or declare it public.

Private and public extension

You will have to declare the extension as private or public when you submit it to us. However, learning their differences might help you to plan your work better:

BehaviorPrivate ExtensionPublic Extension
VisibilityWhoever has the installation URL will be able to access the extension.Everyone
Review after submission NAYes.
The extension will be reviewed and published by us to Zoho Marketplace.

Set up a runtime environment

  1. Install "Node.js" to set up a development environment for your extension.
  2. Download the file from the link below.
  3. Verify its version by executing the following command: $ node -v
File download link: https://nodejs.org/en/
Versions supported by the Zoho Extension Toolkit(ZET): 6.0 and above

Install the Zoho Extension Toolkit

The Zoho Extension Toolkit (ZET) is a command line interface tool. You will be using this tool to build, test, and pack your extension. Execute the command that's mapped to your OS to install the tool.

Your Operating SystemCommand
MacOS / Linuxsudo npm install -g zoho-extension-toolkit
Windowsnpm install -g zoho-extension-toolkit

-g denotes global installation. When ZET is installed globally, you will be able to execute the commands from anywhere in your machine. Otherwise, you will have to navigate to the path where ZET is installed and then execute the ZET commands. After installation, verify its version by executing the following command: zet -v

ZET options

  • -v, -version - shows the version number
  • -h, -help - shows the usage information

ZET commands

init

Usage: $zet init

This command creates a new project template directory. Execute steps 1 to 4 in this section to get the folder structure created for your extension.

run

Usage: $zet run

This command starts a local server with the current directory as the context. Execute steps 6 and 7 in this section to run your extension.

validate

Usage: $zet validate

This command validates the current extension. Execute step 8 in this section to validate your extension against the rules defined in the plugin-manifest.json file.

pack

Usage: $zet pack

This command packs the project into a zip file so that it can be uploaded to Zoho Marketplace. Execute step 9 in this section to pack your extension. This is the last step in the creation of an extension.

Create your first extension

How to create an extension

  1. Execute zet init
     
    • You'll see a prompt where you have to choose a Zoho service for which you are creating an extension.
  2. Choose Zoho Projects
  3. Give a name for your extension. A folder structure will be created.
  4. Execute cd [extension name]
    • This command will set the current path to the newly created extension's directory path.
  5. Navigate to the above directory in your machine and develop your extension using client-side technologies like HTML, JS, CSS, etc.
    • Points to remember:
      Define the manifest reference clearly.
    • Include this JS in your code before calling the JS SDK methods supported by us.
  6. Execute zet run
     
    • This command starts a local server and runs the extension locally.
    • Your extension will run on the port 5000. Ensure its availability before you execute this command.
  7. Hit http://127.0.0.1:5000/plugin-manifest.json or http://127.0.0.1:5000/app/index.html to confirm whether the server has started successfully. You can also test the extension in the developer mode before validating it.
  8. Execute zet validate
     
    • This command checks whether the extension meets the guidelines defined in the plugin-manifest.json file. Learn how to configure your plugin-manifest.json file here.
    • A success message will be displayed in green if the file passes validation. In case of failure, make changes accordingly and execute zet validate again.
  9. Execute zet pack
     
    • This command compresses the files and folders essential for running the extension and gives a ".zip" file as the output. The file will be present inside the path "/{extension's directory}/dist". 
      • Sample file path: "/myfirstextension/dist".
    • This zipped file should be submitted to ZApps irrespective of whether your extension is private or public.

Test extension in developer mode

Prerequisites

  • You must be logged into your Zoho Projects portal to test the extension in the developer mode. If you don’t have an account yet, sign up with us here and have an active session opened on your browser.
  • The extension should be running on the port 5000.
  1. Click   in the upper-right corner.
  2. Choose Developer Space under Integration and select Create Extension.
  3. Click Enable developer mode.
  4. The extension that’s running on the port 5000 will be rendered in all the predefined locations in Zoho Projects. You can navigate to the specified widget locations and test the extension.
  5. Only the extensions running on local will be rendered when developer mode is enabled and other extensions will be disabled.
  6. To exit from the developer mode, deselect the Enable developer mode button.
  • Installation is not needed to test the extension in developer mode. Hence the value parameter in the configuration should be provided along with the name in plugin-manifest.json file.
  • Do not authorize the connection once again since it was already done while creating plugin-manifest.json file.
  • The data of the extension running on local is not stored in Zoho Projects. Instead, it takes the local storage of the browser.
  • The extension that's running on the port 5000 will only be shown in the developer mode. 

Update an existing extension in the marketplace

Developers can update their extensions whenever they want. For every update, the extension's version keeps changing. Here's how an available extension can be updated in the marketplace:

  1. Go to https://sigma.zoho.com
  2. Click the Extension Details icon.
  3. Click    below the extension title.
  4. Upload the new zip file (the packaged version of the extension).
  5. Accept the terms and conditions.
  6. Click Save as Draft.
  7. Click Publish in the top right corner.

    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION






                          Quick Links Workflow Automation Data Collection
                          Web Forms Enterprise Begin Data Collection
                          Interactive Forms Workplace Data Collection App
                          Offline Forms Customer Service Accessible Forms
                          Digital Forms Marketing Forms for Small Business
                          HTML Forms Education Forms for Enterprise
                          Contact Forms E-commerce Forms for any business
                          Lead Generation Forms Healthcare Forms for Startups
                          Wordpress Forms Customer onboarding Order Forms for Small Business
                          No Code Forms Construction RSVP tool for holidays
                          Free Forms Travel
                          Prefill Forms Non-Profit

                          Intake Forms Legal

                          Form Designer HR

                          Card Forms Food
                          Assign Forms Photography

                          Translate Forms Real Estate
                          Electronic Forms

                          Notification Emails for Forms Alternatives
                          Holiday Forms Google Forms alternative 
                          Form to PDF Jotform alternative





                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • Create extensions using cloud editor

                                                                                                                Zoho Projects lets you build extensions using a cloud editor eliminating pre-setup and managing the entire development process online. Here is a webinar to help you navigate through the cloud editor. Overview Zoho Marketplace is an online store where ...
                                                                                                              • Checklist for Zoho Projects

                                                                                                                The Checklist for Zoho Projects extension lets you create a set of instantaneous to-do lists for your tasks and issues in Zoho Projects. With this extension, you can create both checklists and templates that can be used for any of your tasks and ...
                                                                                                              • Zoho Notebook extension for Zoho Project

                                                                                                                Create notes, checklists, and file cards with the Zoho Notebook extension from within Zoho Projects. Install Zoho Notebook extension Navigate to   > Marketplace > All.  Search for Zoho Notebook for Zoho Projects and click on it. Click Install. Verify ...
                                                                                                              • Generative AI Using ChatGPT

                                                                                                                Zia, powered by ChatGPT, allows users to generate new content or fine tune existing content based on keywords. The integration will help users write descriptions, rewrite existing text, create action plans, and events. Users can select full text or a ...
                                                                                                              • Chrome Extension

                                                                                                                Zoho Project's chrome extension, allows you to access all your portals and projects at one place. You can collaborate and concisely manage your project requirements such as posting a forum message, adding new projects, tasks, bugs, status, and ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources