Installing the Freshworks CLI

Freshworks CLI, 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 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 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.

Installing Freshworks CLI on Mac, Linux

:arrow_right: Steps of installation on Windows

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

To uninstall FDK (Freshworks CLI)

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

To 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.

To uninstall NVM (Node Version Manager)