Visual Studio Codeでリモートサーバのファイルを編集する

MacにインストールされたVisual Studio Code(VSC)からリモートサーバ上のファイルを編集する方法です。

VSCにSSH FSをインストール

VCSの拡張機能検索でにSSH FSを検索し、インストールします。
有効化するためには、再読込が必要となりますので、再読み込みをします。

SSH FSの接続情報の設定

  1. インストールが完了すると、エクスプローラーの下の方に「SSH FILE SYSTENS」が表示されているのでクリックします。
  2. 右クリックをすると「Create a SSH FS Configuration」が表示されますので選択します。
  3. 接続先の名前を入力するポップアプが表示されるので、入力しEnterを押すと設定ファイルの雛形が表示されます。
    主な変更パラメータは下記のものになりますので、適宜変更して保存します。
     - label: 接続先の名前
     - root: 接続時のルートディレクトリ
     - host: 接続先のサーバのIP
     - username: sshで接続するユーザ
     - privateKeyPath: 秘密鍵の保存場所
     - passphrase: パズフレーズが設定している場合には「true」、なしの場合には「false」を指定
    ※公開鍵認証で接続する場合変更箇所になります。

設定例

{
    "label": "test-server", 
    "root": "/home/centos",
    "host": "xxx.xxx.xxx.xxx",
    "port": 22,
    "username": "centos",
    "privateKeyPath": "/Users/xxx/.ssh/private-key",
    "passphrase": false
}

サーバへの接続

  1. 「SSH FILE SYSTENS」に作成した接続先が表示されるので、右キリックをするとメニューが表示されますので、「Connect as Workspace folder」をクリックします。
  2. 接続が完了すると、接続先の横に緑色の○が表示され、ワークスペースにルートディレクトリに指定したディレクトリ配下のファイルやディレクトリが表示されます。

参考

SSH FS - Visual Studio Marketplace

コメント