5.5.1. Requirements

The Axivion Visual Studio Code Plugin supports Visual Studio Code 1.95.0 and higher.

Note that using local analysis features (local build and single-file analysis) has additional requirements. These include the requirements for Analysis as well as those for the Dashboard Server in the respective version of the connected Axivion Suite.

5.5.2. Installation

The Axivion Visual Studio Code Plugin is distributed as a Visual Studio Code Axivion.VSCodePlugin-<version>.vsix package. You can download this file from the Axivion Dashboard Server. Alternatively, you can find this file in the directory doc/VSCodePlugin in the Axivion Suite installation folder.

|vscodeplugin| Download

Axivion Visual Studio Code Plugin Download

Please note that the Axivion.VSCodePlugin-<version>.vsix package cannot be installed via the Visual Studio Installer for Windows, as it is intended for Visual Studio Code.

The Axivion Visual Studio Code Plugin does not require Axivion Suite to be installed to view analysis results from the Axivion Dashboard Server.

Please refer to the official documentation for instructions on how to install the Axivion.VSCodePlugin-<version>.vsix package.

Caution

Installation does not require administrator permissions and installs the plugin for the current user account only.

After successful installation, a popup will appear in Visual Studio Code notifying you that the installation was successful.

Once the plugin is installed, you can open the Extensions sidebar panel and select the Axivion Suite extension to view the extension overview page shown in figure Axivion Visual Studio Code Plugin. There, you can inspect the currently installed version, as well as the available settings and commands. You will also notice the Ax icon in the Visual Studio Code status bar, which can be used to trigger the commands provided by the Axivion Visual Studio Code Plugin.

|vscodeplugin|

Axivion Visual Studio Code Plugin

To upgrade the plugin, simply install the .vsix file of the newer version. The previous version will be overwritten; it is not necessary to uninstall the old version before upgrading.

5.5.3. Installation for remote workspaces

To use the Axivion Visual Studio Code Plugin with VS Code remote workspaces, it must be installed on the remote extension host. This can be done in the extensions view by clicking the Install in SSH/Container/WSL: Workspace button next to the extension.

|vscodeplugin| Remote Extensions

Axivion Visual Studio Code Plugin Remote Extensions

A reload is required to start the extension on the remote host. Please note that features such as accessing the Axivion Dashboard Server will be executed on the remote workspace system. Keep this in mind when configuring path mappings, Local Build, Single File Analysis, and Axivion Suite in the Configuration section.

|vscodeplugin| Remote Extensions

Axivion Visual Studio Code Plugin Remote Extension installed

When using dev containers, it might be useful to have the Axivion Visual Studio Code Plugin already installed at container startup. To do this, add the Axivion Visual Studio Code Plugin to the devcontainer.json file.

Example for the Axivion Visual Studio Code Plugin installation in devcontainer.json.
{
   // devcontainer.json
   "customizations": {
      "vscode": {
         "extensions": [
            "/opt/bauhaus-suite/doc/VSCodePlugin/Axivion.VSCodePlugin-<version>.vsix",
         ]
      }
   }
}

The Axivion Visual Studio Code Plugin can be installed on either the UI or the workspace extension host. When using the devcontainer.json file, the extension is installed on both sides and requires an IDE reload to function. In a dev container environment, force the plugin to run only on the workspace host. This eliminates the need to reload the IDE and ensures the Axivion Visual Studio Code Plugin is functional upon startup.

Example for the Axivion Visual Studio Code Plugin running on the workspace extension host.
{
   // .vscode/settings.json
   "remote.extensionKind": {
      "Axivion.vscodeplugin": [ "workspace" ]
   }
}