This section will show you how to integrate the Kiuwan IDE Plug-In into Visual Studio Code.
The Kiuwan IDE Plug-In for Visual Studio Code is only available in Viewer Mode. It has been successfully tested with VS Code 1.33.1 |
Contents:
Before starting the installation, you must download k4d-vscode.vsix from https://www.kiuwan.com/pub/vscode/k4d-vscode.vsix |
After installation, you need to configure the Kiuwan IDE Plug-In to connect to Kiuwan. Please remember that you need to have a valid Kiuwan Account.
You can find the connection settings at User Settings > Extensions > Kiuwan
Please remember that you need to have a valid Kiuwan Account.
The Kiuwan server URL comes preconfigured (leave it with default value).
Fill in the User and Password fields with your Kiuwan account credentials.
If your Kiuwan account is configured to use Single Sign-On (SSO), enter your Domain ID (consult your Kiuwan admin and see How to integrate Kiuwan with SAML SSO)
To check the connection, you can use K4D: Check Connection With Current Settings to select the delivery. See Kiuwan VS Code commands
After the Kiuwan IDE Plug-In is installed, you are ready to map your VS Code workspace or folder to a Kiuwan application.
This action will allow synchronizing defects and vulnerabilities found by Kiuwan in your source code, getting them ready for fixing. All the following settings can be configured at User level (i.e. they will apply to all folders opened with the user currently logged in the machine), or at Workspace level (i.e. you can configure different values for different folders/workspaces); the later is recommended. |
To map your VS Code workspace to Kiuwan, type your Kiuwan app name at Remote Application: Name
Leaving it blank, you can use K4D: Pick Remote Application to select the app.
Once mapped, you can select the source of the defects that will be shown in VS Code.
Leaving it blank, you can use K4D: Pick Audit Delivery to select the delivery. See Kiuwan VS Code commands
For Audit Delivery and Delivery , you can select a range of defects.
Finally, you can limit how many defects to download from Kiuwan servers (Defects Limit), as well as filter the resulting set of defects by Characteristics, File Patterns, Language and Priority.
By selecting Command Palette..
you can use the following list of Kiuwan VS Code commands
For example, if you select Delivery as the source for defects, you can select the right delivery by running K4D: Pick Delivery and selecting among the available ones.
Once configured, just click on the Kiuwan icon to see the defects.
This 'tree of defects' is structured in two or three levels:
If you experience problems with the Kiuwan plugin for VS Code , you can read Kiuwan Documentation to find a solution, or if you prefer you can collect troubleshooting information and send it to us.
Important information for troubleshooting is located at log file. To make this process easier find log file at $USER_HOME/.optimyth/k4d-vscode.log and submit to technical support team. Visit Contact Kiuwan Technical Support on how to contact us. We will address your problem as soon as possible. |