Installation and Setup

In this guide, you'll learn how to install and set up Freddy AI Copilot for Developers, including all prerequisites and configuration steps.

Freddy AI Copilot for Developers is your AI-powered companion for building Freshworks apps. It has complete knowledge of Developer Platform capabilities and provides intelligent code generation, helps in fixing errors, and provides AI-assisted app migration capabilities to speed up your app development process.

Prerequisites

Before installing Freddy AI Copilot, ensure you have the FDK set up :

Install Freshworks Development Kit (FDK)

The Freshworks Development Kit (FDK) is the core toolkit for building Freshworks apps. Here’s how to set it up :

  1. Follow FDK Installation Guide to :
    1. Install FDK prerequisites
    2. Install FDK + CLI
  2. Verify your installation:

Run the following command on Command Prompt to verify the output to be a valid FDK version (Example: 9.2.0)

fdk version

Install Visual Studio Code

Ensure you have the latest version of Visual Studio Code installed.

Installaton and Setup

Install Freddy Copilot VSCode Extension

You can install Freddy AI Copilot for Developer via Marketplace listing or by following these steps directly within VS Code:

  • Open VS Code editor on your local machine

  • Click the Extensions icon in the Activity Bar on the side of VS Code, or use the keyboard shortcut Cmd+Shift+X (macOS) or Ctrl+Shift+X (Windows/Linux)

  • Type “Freddy AI Copilot” in the search bar and click the Install button

    Install Freddy Copilot Extension from VS Code Marketplace

Setup & Configuration

Navigate to installed extensions, and select Freddy AI Copilot for Developers. Go to extension settings, and fill the following :

Configure Freddy API Key

  • Navigate to the Application Management Portal (AMP)

  • Click the "Settings" icon in the top-right corner

  • Select "View API Key" & copy the Freddy API key

  • In VS Code: Open Freddy AI Copilot extension settings & paste it under Freddy API key

    Configure API Key

Configure FDK Path

Ensure you have FDK installed as per the above steps. Follow the below steps to find the path and add it under Fdk Path in extension settings

Run the following command on Command Prompt, copy the output and add under Fdk Path

where fdk

Finally, restart or reload the VSCode window.

🎉 Congratulations! Your Freddy AI Copilot is now ready to use.

Need some help?

Need assistance? Ask questions in our Developer Community.