Setup and Preparation

Overview¶

This page explains the setup and preparation of Pleasanter Code Assist.

Outline of the Steps¶

1. Install Visual Studio Code
2. Install the Pleasanter Code Assist extension
3. Create the work folders
4. Create the server connection information file

1. Installing Visual Studio Code¶

Install Visual Studio Code on the client machine you use. Download Visual Studio Code from here.
https://code.visualstudio.com/Download
For how to install it, check the following official site.
https://code.visualstudio.com/docs/setup/setup-overview

2. Installing the Pleasanter Code Assist Extension¶

1. Start Visual Studio Code.
2. Click the extensions icon on the view bar in the left pane to open the extensions sidebar.
3. Search for Pleasanter Code Assist.
4. In the search results, click the Install button.
   
5. If a dialog like the following is displayed, click the "Trust Publisher & Install" button.
   

3. Creating the Work Folders¶

Run the command for creating the work folders to create them. For the steps, refer to the following page.
Pleasanter Code Assist: Creating a Work Folder by Command

If you create them by hand, take any folder on the machine you use as the "base folder" and create folders under it with the structure shown in the figure below. Create the "base folder" with any name you like. In the figure below, "sampleRoot" is the base folder.

With Pleasanter Code Assist 1.3.0 and later, you can create subfolders inside folders such as scripts and serverscripts, and organise and classify the scripts you create.

4. Creating the Server Connection Information File¶

Create a server connection information file in the connectionSettings folder. Create an API key in advance.

File name¶

Up to you. The extension is ".json". You can create several files.

Setting values¶

Configuration example¶

json¶

{
    "apiKey":"xxxxx...",
    "url":"https://servername"
}

Connecting via a proxy server¶

When you connect via a proxy server, note that how you configure it differs depending on the version.

Ver1.2.0 and later¶

Set http.proxy and http.proxyAuthorization, which are the default settings of Visual Studio Code.

Up to Ver1.1.0¶

// The proxy parameter is not valid in Ver 1.2.0 and later.
{
    "apiKey":"xxxxx...",
    "url":"https://servername",
    "proxy":{
        "protocol":"https",
        "host":"proxy.servername",
        "port":"8080"
    }
}

Related Information¶

• Pleasanter Code Assist: Creating a Work Folder by Command
• Developer Function: API: Create an API Key