What are the prerequisites to install the Freshworks CLI

Freshworks CLI is required to develop an application in the Freshworks developer platform. Freshworks CLI depends on Node.js to run the application during development. The process of installing Node.js can be found in the following process.

The Node.js installation has two parts.

  1. Install NVM
  2. Install Node

Install NVM
It is recommended to use Node Version Manager (NVM) to install Node.js as it enables you to install and work with multiple versions of Node easily.

You can skip step 1 if you have already installed NVM.

  1. To install NVM:
  • For Mac/Linux, refer to the steps given here.
  • For Windows, click here to download and extract the installer from nvm-setup.zip listed under Assets.
  1. To verify the installed nvm version, run the following command.
    nvm --version

Install Node

To install Node.js, follow the given steps.

  1. To install Node using NVM, run the following command.

    nvm install 10.18

    Note: Support for Node 8.10.x has been deprecated.

  2. To verify the installed node version, type the following command.
    node --version

    Note: For Windows, if the node version is not displayed, you may need to enable nvm by running the command: nvm on

  3. To set the default node version with NVM, run the following command:
    nvm alias default 10.18

  4. For Windows, you need to install a few required tools and configurations by using the following command.
    npm install --global --production windows-build-tools
    For further reference, click here.

Now, Freshworks CLI can be installed. Click here to find steps to install it.

1 Like