## 概要 Pleasanter Code Assistのセットアップおよび事前準備を説明します。 ## 手順概要 1. Visual Studio Codeのインストール 1. 拡張機能[Pleasanter Code Assist](/ja/manual/pleasanter-code-assist-overview)のインストール 1. 作業フォルダ作成 1. サーバ接続情報ファイル作成 ## 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](/ja/manual/pleasanter-code-assist-overview)のインストール 1. Visual Studio Codeを起動します。 1. 左側ペインのビューバーより拡張機能アイコンをクリックし、拡張機能サイドバーを開きます。 1. [Pleasanter Code Assist](/ja/manual/pleasanter-code-assist-overview)を検索します。 1. 検索結果で、インストール ボタンをクリックします。  ## 3. 作業フォルダ作成 作業フォルダ作成用のコマンドを実行して作業フォルダを作成します。手順は以下のページを参照してください。 [Pleasanter Code Assist：コマンドによる作業フォルダ作成](pleasanter-code-assist-create-workfolder) 手動で作成する場合は、ご利用の端末の任意のフォルダを「基準フォルダ」とし、その配下に下図の通りの構成でフォルダを作成します。「基準フォルダ」は任意の名称で作成してください。下図では「sampleRoot」が基準フォルダです。  |フォルダ名|説明| |---|---| |基準フォルダ（上図ではsampleRoot）|Pleasanter Code Assistを利用する際の基準となるフォルダ。場所、名称は任意。基準フォルダは複数作成することができます。| |connectionSetting|サーバ接続情報ファイルを格納| |extensions|拡張スクリプト、拡張サーバスクリプト、拡張SQL、拡張スタイルの各フォルダをまとめる| |　scripts|拡張スクリプトの定義ファイル、ソースコードファイルを格納| |　serverscripts|拡張サーバスクリプトの定義ファイル、ソースコードファイルを格納| |　sqls|拡張SQLの定義ファイル、ソースコードファイルを格納| |　styles|拡張スタイルの定義ファイル、ソースコードファイルを格納| |sites|HTML、スクリプト、サーバスクリプト、スタイルの各フォルダをまとめる| |　htmls|HTMLのソースコードを格納| |　scripts|スクリプトのソースコードを格納| |　serverscripts|サーバスクリプトのソースコードを格納| |　styles|スタイルのソースコードを格納| ## 3. サーバ接続情報ファイル作成 connectionSettingsフォルダにサーバ接続情報ファイルを作成します。あらかじめ[APIキー](/ja/manual/api-key)を作成してください。 ### ファイル名 任意です。拡張子は".json"です。ファイルは複数作成することができます。 ### 設定値 |パラメータ名|設定例|説明| |---|---|---| |apiKey|xxxxx...|対象テーブルに対してサイトの管理権限をもつユーザで作成したAPIキーを設定します| |url|https://servername|プリザンターのルートURLを設定します| |proxy|JSON|プロキシサーバ経由で接続する場合に設定します。プロキシサーバ未使用時は設定不要です| |protocol|https|プロキシサーバへ接続するプロトコルを設定します。httpまたはhttpsを設定します| |host|proxy.servername|プロキシサーバのサーバ名を設定します| |port|8080|プロキシサーバの接続ポートを設定します| ### 設定例１：プロキシサーバを利用しない ##### json ``` { "apiKey":"xxxxx...", "url":"https://servername" } ``` ### 設定例２：プロキシサーバ経由で接続する ##### json ``` { "apiKey":"xxxxx...", "url":"https://servername", "proxy":{ "protocol":"https", "host":"proxy.servername", "port":"8080" } } ``` ## 関連情報 <div id="ManualList"><ul><li><a href="/ja/manual/api-key">開発者向け機能：API：APIキーの作成</a><span>2024/06/21 up</span></li></ul></article> <ul><li><a href="/ja/manual/pleasanter-code-assist-overview">Pleasanter Code Assist：機能概要</a><span>2025/03/03 up</span></li> <li><a href="/ja/manual/pleasanter-code-assist-how-to-use-sites">Pleasanter Code Assist：使い方：サイト</a><span>2025/03/03 up</span></li> <li><a href="/ja/manual/pleasanter-code-assist-how-to-use-extensions">Pleasanter Code Assist：使い方：拡張機能</a><span>2025/03/03 up</span></li> <li><a href="/ja/manual/pleasanter-code-assist-feature">Pleasanter Code Assist：コマンドおよび設定項目</a><span>2025/03/03 up</span></li> <li><a href="/ja/manual/pleasanter-code-assist-create-workfolder">Pleasanter Code Assist：コマンドによる作業フォルダ作成</a><span>2025/03/03 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />