セットアップ、事前準備

概要¶

Pleasanter Code Assistのセットアップおよび事前準備を説明します。

手順概要¶

1. Visual Studio Codeのインストール
2. 拡張機能Pleasanter Code Assistのインストール
3. 作業フォルダ作成
4. サーバ接続情報ファイル作成

1. Visual Studio Codeのインストール¶

ご利用のクライアント端末にVisual Studio Codeをインストールします。Visual Studio Codeはこちらからダウンロードしてください。
https://code.visualstudio.com/Download
インストール方法は以下公式サイトを確認してください。
https://code.visualstudio.com/docs/setup/setup-overview

2. 拡張機能Pleasanter Code Assistのインストール¶

1. Visual Studio Codeを起動します。
2. 左側ペインのビューバーより拡張機能アイコンをクリックし、拡張機能サイドバーを開きます。
3. Pleasanter Code Assistを検索します。
4. 検索結果で、インストール ボタンをクリックします。
   
5. 以下のようなダイアログが表示した場合は「Trust Publisher & Install」ボタン（日本語表示の場合は「発行元を信頼＆インストール」ボタン）をクリックします。
   

3. 作業フォルダ作成¶

作業フォルダ作成用のコマンドを実行して作業フォルダを作成します。手順は以下のページを参照してください。
Pleasanter Code Assist：コマンドによる作業フォルダ作成
手動で作成する場合は、ご利用の端末の任意のフォルダを「基準フォルダ」とし、その配下に下図の通りの構成でフォルダを作成します。「基準フォルダ」は任意の名称で作成してください。下図では「sampleRoot」が基準フォルダです。

Pleasanter Code Assist 1.3.0以降では、scriptsやserverscriptsなどのフォルダ内にサブフォルダを作成し、作成したスクリプトを整理・分類して保存できます。

3. サーバ接続情報ファイル作成¶

connectionSettingsフォルダにサーバ接続情報ファイルを作成します。あらかじめAPIキーを作成してください。

ファイル名¶

任意です。拡張子は".json"です。ファイルは複数作成することができます。

設定値¶

設定例¶

json¶

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

プロキシサーバ経由で接続する¶

プロキシサーバ経由で接続する場合はバージョンによって設定方法が異なりますのでご注意ください。

Ver1.2.0以降¶

Visual Studio Code のデフォルト設定である http.proxy 、http.proxyAuthorizationを設定してください。

Ver1.1.0まで¶

// proxy パラメータは、Ver 1.2.0 以降では無効です。
{
    "apiKey":"xxxxx...",
    "url":"https://servername",
    "proxy":{
        "protocol":"https",
        "host":"proxy.servername",
        "port":"8080"
    }
}

関連情報¶

• Pleasanter Code Assist：コマンドによる作業フォルダ作成
• 開発者向け機能：API：APIキーの作成