Install and configure the Freddy AI Copilot for Developers extension

You can install and configure Freddy AI Copilot for Developers to start building apps directly from Visual Studio Code (VS Code).

This section provides information on the setup process from installing prerequisites to configuring the extension.

Prerequisites

Before you begin, ensure the following prerequisites are met:

  • Visual Studio Code (version 1.73 or later)

  • Node.js version 18.x

  • Access to Freshworks Developer account

  • A valid Freddy API key

    Follow the steps to obtain the Freddy API key:
    1. Go to the Application Management Portal and click the "Settings" icon in the top-right corner.
    2. Under the API key for Freddy AI Copilot VS Code plugin section, click View API Key. The Freddy API key is displayed.

Install FDK

Install the Freshworks Developer Kit (FDK) to enable Freddy AI to generate and modify apps based on the Freshworks app framework.

Notes:
  • Use the npm version that ships with Node. Using a different npm version can affect CLI installation and dependency management.
  • If multiple versions of Node are installed on your system, use NVM to switch to Node v18.
  • To uninstall the previous CLI version, run the npm uninstall fdk -g command.
  • The Developer portal and SDK Terms of use apply to the use of the CLI.

  1. To install the latest CLI version, run the following command.

      npm install https://cdn.freshdev.io/fdk/latest.tgz -g

  2. Run the following command to verify the CLI installation.

    fdk version

    Ensure that the installed FDK version is 9.0.0 or later.

Install the extension

  1. Open Visual Studio Code.
  2. Go to the Extensions view.
  3. Search for Freddy AI Copilot for Developers.
  4. Select the extension published by Freshworks Marketplace.
  5. Click Install.

Alternatively, you can install the extension directly from the Visual Studio Marketplace.

Configure the extension

After the Freddy AI Copilot for Developers extension have been installed, follow the steps to configure it:

  1. In Visual Studio Code, go to the Extensions view.

  2. On the Freddy AI Copilot for Developers extension, click the Settings (⚙️) icon and select Settings.

    The Settings page opens.

  3. In the settings panel, set the following configuration values:

    • FDK Path: The path to your Freshworks Developer Kit installation.

      To get the FDK path,

      • For Windows: Open Command Prompt and run where fdk.
      • For Mac/Linux: Open Terminal and run which fdk.

    • Freddy API Key: Your personal API key for authenticating requests.

      To learn how to obtain the Freddy API key, see Prerequisites.

    • Context Settings: This setting determines how many previous responses (up to a maximum of 10) Freddy AI retains and references when generating a new answer within the same conversation.

      Available values are: None, 1, 2, 5, 7, and 10.

      Increase this value to maintain continuity across multi-step interactions. Higher values allow Freddy AI to use more prior context but may increase token consumption. Lower values reduce token usage and are better suited for isolated or single-step prompts.

      The default value is 5, which means Freddy AI retains up to five previous responses as context.

    • Enable Implicit Context Awareness: Enables Freddy AI to automatically include relevant code from your workspace when responding to prompts in Ask mode. When enabled, Freddy analyzes your project and adds related code snippets as context, even if you do not explicitly reference a file or code block in your prompt.

      This setting helps improve response accuracy for natural-language questions but may increase token consumption. It does not modify your files and applies only to Ask mode

    • Figma API Key (optional): A Figma API key that enables the Design to Code feature.

Once the configuration is complete, the Freddy AI Copilot for Developers extension is ready to use. You can now start generating, refining, and managing apps directly from Visual Studio Code. To learn about steps to build an app from scratch or to edit an existing app, see Build an app.

Previous
Get started
Next
Build an app