テックブログ

Visual Studio Codeでサーバー上のファイルを直接編集してみよう

皆様こんにちは。tamです。

サーバー管理をしていると、リモートサーバー上のファイルを編集しなければならないケースがたびたび発生します。
そんな時に便利なのが Visual Studio Code(以下、VS Code)とRemote – SSH(拡張機能)の組み合わせです。

今回はとても便利なVS Codeを使ってリモートサーバー上のファイルを直接操作する方法をお伝えしたいと思います。

必要なもの

  • VS Code
  • Remote – SSH 拡張機能
  • SSHアクセス可能なリモートサーバー
  • サーバーのSSH情報(ユーザー名、ホスト名、秘密鍵など)

VS Codeは最新バージョンをインストールして下さい。公式サイトからダウンロード可能です。
日本語化しておくと便利です。
リモートサーバーの準備やSSHの設定などは完了している状態とします。

Remote – SSH 拡張機能をインストール

  • サイドバーの拡張機能アイコン(四角とひし形が4つ集まったアイコン)をクリック
  • 「remote ssh」で検索
  • 「Remote – SSH」を選択してインストール

SSH構成ファイルを編集する

  • サイドバーのリモートエクスプローラー(モニターのようなアイコン)をクリック
  • SSHの横の歯車アイコンをクリック
  • 上部に設定の保存先の選択肢が表示されるので適宜選択

以下は記載例です。

Host テストリモートサーバー
    HostName 10.0.2.123
    User ubuntu
    Port 22
    IdentityFile "C:\各種パス\example.pem"
    IdentitiesOnly yes
    PasswordAuthentication no


Host: VS Code上での接続名
HostName: 接続先サーバーのIPアドレスまたはホスト名
User: SSH接続のためのユーザー名
Port: ポート番号(22であればこの項目は記述しなくてもOK)
IdentityFile: 秘密鍵のフルパス
IdentitiesOnly: 複数設定する場合はyes
PasswordAuthentication: 公開鍵認証の場合はno

IdentityFile,IdentitiesOnly,PasswordAuthenticationについてはご自身の環境に合わせて設定して下さい。

VS Codeからサーバーに接続

  • VS Code左下の青色のアイコンをクリック
  • 「ホストに接続… Remote-SSH」を選択
  • 先ほど保存した接続名(例: テストリモートサーバー)を選択(ここで別ウィンドウが開きます)
  • 初回接続時は、OS選択やフィンガープリントの確認メッセージが出る場合があるので「続行」などを選択

数秒待つとサーバーに接続されます。

サーバー上のファイルを開く・編集する

接続に成功するとサイドバーのエクスプローラー(ファイルが2枚重なったアイコン)から、サーバー上のディレクトリを開いてファイルを編集できるようになります。
ローカルと同じように保存も可能です。

また上部メニューの三点リーダーにある「ターミナル」から「新しいターミナル」を選択することでターミナル接続を行い、各種コマンドを直接実行することもできます。

まとめ

VS CodeのRemote – SSH拡張機能を使えば、サーバー上のファイルを快適なエディタで直接操作できます。
これにより、ちょっとした設定変更やデバッグ作業が圧倒的に効率化されるはずです。

「vimで編集はやりづらい…」という方にもおすすめの方法です。
ぜひ一度試してみてください!

この記事をシェアする

  • facebook
  • twitter
  • hatena
  • line
URLとタイトルをコピーする

実績数30,000件!
サーバーやネットワークなど
ITインフラのことならネットアシストへ、
お気軽にご相談ください