Skip to main content

Installing VS Code and Eggplant Studio

Information about installing Eggplant Studio and Microsoft Visual Studio Code (VS Code) is provided here, including requirements and recommendations for your system, as well as instructions for downloading and installing.

Important

Eggplant Studio is an extension for editing scripts in the Eggplant Test scripting language: SenseTalk. Eggplant Studio runs in VS Code, which is a free code editor created and maintained by Microsoft. Before you can install and use Eggplant Studio, you must install VS Code.

You can create suites and scripts with Eggplant Studio. However, run and debug scripts, you must also install Eggplant Functional (EPF).

Prerequisites​

Before you install Eggplant Studio, you need to verify that your system meets the minimum requirements and, for best results, the recommendations listed below.

  • Microsoft Visual Studio Code (VS Code) 1.88 or the latest stable version. (Note: the capability to drag a SUT to a new window is available in VS Code 1. 88). Before you can use Eggplant Studio, you will need to install VS Code.

  • To be able to run and debug your scripts in Eggplant Studio, you must install Eggplant Functional (EPF) 23.2.0 or later. See Getting Started with Eggplant Functional for more information about Eggplant Functional, including supported OS and system recommendations.

Download and Install VS Code​

VS Code is available for Windows, Mac and Linux, and the installation process is simple and quick. But if you want more information about using VS Code, please see Introduction to VS Code.

Please download the installer suited to your OS from here: download VS Code.

Download and Install Eggplant Studio​

After you install VS Code, you can focus on downloading Eggplant Studio, which is an extension available in the VS Code Marketplace. If you are unfamiliar with VS Code Marketplace, it is like an app store. The key difference is an extension extends the capability of VS Code, rather than providing stand-alone functionality like the apps on your mobile phone offer.

Downloading Eggplant Studio from VS Code Marketplace​

You can download the Eggplant Studio extension from VS Code Marketplace using either of two methods:

  • Using the Extension view within VS Code, which is described in the steps below.
  • Using the VS Code Marketplace site when you already have VS Code installed on your machine. For information about this method, please see the VS Code page Extension Marketplace, which describes the process in detail.

Installing Eggplant Studio from VS Code Marketplace​

You can install the Eggplant Studio extension from VS Code Marketplace from with in VS Code using the Extension view. To install Eggplant Studio, please follow these simple steps:

  1. Launch VS Code.
  2. Select the Extensions tab from the activity bar on the left-hand side of VS Code.
  3. In the search box in the top left corner, search for "Eggplant Studio".
  4. Click the Install button when you find it.

While the extension is installing, the right-hand side of the screen displays an overview of Eggplant Studio. This is the same page that you will see if you visit the VS Code Marketplace in a web browser and search for "Eggplant Studio".

Installing Eggplant Studio from a .VSIX File​

Alternatively, you can install Eggplant Studio from a .vsix file. This may be useful if the machine you want to install Eggplant Studio on is not connected to the public Internet.

To install Eggplant Studio from a .vsix file:

  1. Download and install VS Code for your machine if you have not already done so.
  2. Download the latest version of Eggplant Studio from either VS Code Marketplace or our download page from a machine that does have internet access and save it somewhere you can access it from your machine.
  3. Open VS Code.
  4. Click File > Preferences > Extensions to open the Extensions view.
  5. Click the Actions button (the three dots in the upper right section of the Extensions view) and click Install from VSIX....
  6. Select the .vsix file you just downloaded and click Open.

Next Steps​

Without Eggplant Functional (EPF) installed you will be able to create and/or open a Test Suite and edit your SenseTalk scripts. Before you can run any test scripts, you’ll need to install EPF which is the engine which drives Eggplant Studio under the hood.

Installing Eggplant Functional (EPF)​

Having Eggplant Functional (EPF) installed is a prerequisite for running test scripts because it provides the engine that runs scripts in Eggplant Studio.

Please follow these instructions to download and install EPF: Installing EPF

Eggplant Studio walkthrough​

Once you have installed EPF and Eggplant Studio, you can find Eggplant Studio commands and walkthroughs by navigating to the Command Palette (View > Command Palette) and typing "Eggplant Studio.". This documentation also contains a walkthrough.

Last updated on