What are the prerequisites to install the Freshworks CLI

Freshworks CLI, which depends on Node.js, is required to develop an application in the Freshworks developer platform.

To install Node.js, you need to install:

  1. NVM
  2. Node

Installing NVM

Node Version Manager (NVM) enables you to install and work with multiple versions of Node.js easily.

  1. To install NVM:

  2. On Mac or Linux, follow the installation and upgrade steps.

  3. On Windows, navigate to the release channel > Assets, download the nvm-setup.zip file, extract the contents of the file, and use the installer in the extracted files.

  4. To verify the NVM installation, run the following command.
    nvm --version

Installing Node

  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 Node installation, run the following command.
    node --version
    Note: For Windows, if the Node version is not displayed, you should run the nvm on command to enable NVM.
  3. To set the default node version with NVM, run the following command:
    nvm alias default 10.18
  4. For Windows, to install the tools and configurations required to start using Node, using the following command.
    npm install --global --production windows-build-tools
    For more information, see the write-up on node-gyp.

Now, Freshworks CLI can be installed. Follow the CLI installation steps here.

1 Like