Install command line interface | Zoho Creator Help

Install command line interface

This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version.
Zet is a command line interface that helps developers build and package widgets in Zoho Creator. The Command Line Interface, or CLI, is used to send commands to a software program as lines of texts in order to interact with it. This interaction includes typing commands into the interface and receiving responses to them. This text-based interface has its basis in the Graphical User Interface (GUI) but provides a mechanism that is easier to use. Developers use CLIs to create applications, software, and operating systems.

Zoho Creator enables you to create and integrate a widget using CLI.

Prerequisites to install CLI

Install CLI

  1. Run the following command to install the zapps cli node package:
    $ npm install -g zoho-extension-toolkit
     
  2. Run the following command to ensure that the installation is successful:
    $ zet // Help information about 'zet' command will be shown.
     

Create a project

  1. Run the following command to create new project:
    $ zet init

    The list of Zoho Services you need to create a project template for will appear.

  2. Select Zoho Creator and create a Project Folder.
  3. Include resources: All the files that are required for rendering your widget will appear inside the "app" folder of your project.

Start server

  1. Run the following command to start a local HTTP server that allows you to run your app locally and to test it in your sandbox instance:
    $ zet run

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

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

Validate and package the application

  1. Run the following command to validate your application:
    $ zet validate

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

  2. Run the following command to generate a zip of your application that can be uploaded:
    $ zet pack

    This will create a zip file of the application in the "dist" folder of your project directory. This zip file needs to be uploaded to the Zoho Creator.


      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        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
                              CRM 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
                              Mobile App
                              Form Designer HR
                              Mobile Forms
                              Card Forms Food Offline Forms
                              Assign Forms Photography
                              Mobile Forms Features
                              Translate Forms Real Estate Kiosk in Mobile Forms
                              Electronic Forms

                              Notification Emails for Forms Alternatives Security & Compliance
                              Holiday Forms Google Forms alternative  GDPR
                              Form to PDF Jotform alternative HIPAA Forms
                              Email Forms
                              Encrypted Forms
                              Embeddable Forms
                              Secure Forms
                              Drag & drop form builder
                              WCAG

                                    Create. Review. Publish.

                                    Write, edit, collaborate on, and publish documents to different content management platforms.

                                    Get Started Now




                                                      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


                                                            • Desk Community Learning Series


                                                            • Digest


                                                            • Functions


                                                            • Meetups


                                                            • Kbase


                                                            • Resources


                                                            • Glossary


                                                            • Desk Marketplace


                                                            • MVP Corner


                                                            • Word of the Day


                                                            • Ask the Experts


                                                              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 Demo

                                                                                                Get a personalized demo or POC

                                                                                                REGISTER NOW


                                                                                                  Design. Discuss. Deliver.

                                                                                                  Create visually engaging stories with Zoho Show.

                                                                                                  Get Started Now









                                                                                                                      • Related Articles

                                                                                                                      • Configuring line chart

                                                                                                                        Line charts are used to depict trends over periods of time such as analyzing long-term trends in sales, financial data, or marketing statistics. The vertical axis usually displays numeric values, while the X-axis indicates certain specific time ...
                                                                                                                      • Install custom app from Marketplace and customize

                                                                                                                        Requirement Customize the Point of Sale application installed from Marketplace to include a membership module. Use case A retail store requires a regular point of sale application with certain store-specific personalizations to ease their checkout ...
                                                                                                                      • Multi line

                                                                                                                        Understand multi line field The multi line field enables your users to enter plain text, i.e., letters from any language, numbers and special characters. Character limits The multi line field can accept any plain text that takes up to 64 Kilobytes ...
                                                                                                                      • Single line

                                                                                                                        Understand single line field The single line field enables your users to enter plain text, i.e., letters from any language, numbers and special characters. Below is an example of how a single line field looks on a form: When a user accesses from a ...
                                                                                                                      • Install and Manage Extensions

                                                                                                                        Install Extension Note: Extensions are only available in C6 paid plans. Extensions are software components that add additional functionality that is not provided out of the box by the Creator. You can install the desired extension from the Zoho ...
                                                                                                                        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