Installing the Freshworks CLI

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

Check the last section to uninstall the existing installed prerequisites or some of them.

To install FDK, 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 14
    
    Note: Support for Node 12.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 14
    
  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.

Installing Freshworks CLI on Mac, Linux

Now, you can install Freshworks CLI. Follow the CLI installation steps.

:arrow_right: Steps of installation on Windows


Uninstall the dev environment

For removing the existing environment to start afresh, proceed with the following steps.

Uninstall FDK

  • Run command, npm uninstall fdk -g
  • To remove FDK related files, run command, rm -rf ~/.fdk

Uninstall Node

  • If installed through NVM:
    • Uninstalling NVM will remove all the Node versions installed with it. Check out the next section to uninstall NVM.
  • If installed via directly using the source or another tool, remove the Node manually from the installed folder where it is installed and remove the Node path variable.
    • For Windows, it would be easy to uninstall Node on GUI provided by the OS.

Uninstall NVM

3 Likes

Node version 10.x.x does not work. So above mentioned version is wrong developers should not use it.

2 Likes

Hi @pavan-amplifli,

We have updated the Node version to replicate the official Documentation. The steps should work fine now.
Thanks for notifying us.