VS Code IDE

VS Code Remote SSH で Buda Agent ワークスペースに接続し、ローカル IDE からコードを編集します。

VS Code IDE は、Agent ワークスペースのコードをローカルマシンの IDE で編集したいときに使います。設定後は、Buda の VSCodeで開く から直接接続できます。

VS Code IDE を使う場面

ローカル IDE の機能を使いたい場合に適しています。

複数ファイルのプロジェクトを編集する
VS Code 拡張機能を使う
Git の変更を確認する
フロントエンドまたはバックエンドをデバッグする
Agent と人間の開発者が同じワークスペースで作業する

Web ページの表示確認だけなら、通常は WebPreview の方が簡単です。

基本の流れ

ローカルに VS Code をインストールし、VS Code Remote SSH 拡張機能を入れます。
ローカルに websocat をインストールし、ターミナルで実行できることを確認します。
Buda のダイアログにローカル SSH 公開鍵を貼り付けます。
ダイアログの SSH 設定をコピーし、ローカルの ~/.ssh/config に追記します。
VS Code を開く をクリックするか、VS Code Remote SSH で該当 Host を選択します。

websocat をインストール

macOS では Homebrew を使えます。

brew install websocat

Windows と Linux では Cargo を使えます。

cargo install websocat

websocat Releases から対応するバイナリをダウンロードし、ローカルの PATH に追加することもできます。

インストール後、ローカルで実行します。

websocat --version

コマンドが見つからない場合、websocat が PATH に入っていません。

SSH 公開鍵を確認する

一般的な公開鍵ファイルは次の場所にあります。

~/.ssh/id_ed25519.pub
~/.ssh/id_rsa.pub

ローカルで内容を確認します。

cat ~/.ssh/id_ed25519.pub

出力された 1 行全体をコピーし、Buda ダイアログの SSH 公開鍵を追加 に貼り付けます。

SSH key がまだない場合は作成します。

ssh-keygen -t ed25519 -C "your-email@example.com"

作成後、生成された .pub ファイルを開いてください。

VS Code Remote SSH を設定する

Buda ダイアログは Host buda-agent-... で始まる SSH 設定を生成します。これをローカルの次のファイルに追記します。

~/.ssh/config

保存後、VS Code で次を実行します。

Remote-SSH: Connect to Host

Buda ダイアログに表示された Host を選択します。

Q&A

VS Code が websocat を見つけられない場合は？

ローカルで websocat --version を実行してください。コマンドが存在しない場合は、websocat を再インストールするか、websocat のディレクトリを PATH に追加します。

Permission denied が表示されます。どうすればよいですか？

Buda に貼り付けた内容が公開鍵ファイル、つまり .pub ファイルの内容であることを確認してください。秘密鍵は貼り付けないでください。公開鍵は通常 ssh-ed25519 または ssh-rsa で始まります。

SSH key が複数あります。IdentityFile は必要ですか？

通常は不要です。Buda が生成する SSH 設定は IdentityFile を強制しません。VS Code はローカルの SSH agent またはデフォルト key を使えます。

複数の SSH key があり、VS Code が誤った key を選ぶ場合は、ダイアログが生成した Host 設定に次を追記します。

Host buda-agent-xxxx
  IdentityFile ~/.ssh/id_ed25519
  IdentitiesOnly yes

buda-agent-xxxx はダイアログで生成された Host に、~/.ssh/id_ed25519 は自分の秘密鍵パスに置き換えてください。

VS Code が接続中のままです。何を確認すべきですか？

まず次を確認してください。

Buda の SSH 設定がローカルの ~/.ssh/config に保存されている
websocat --version がローカルターミナルで動く
VS Code Remote SSH 拡張機能がインストールされている
Buda ワークスペースがまだ実行中である

それでも失敗する場合は、Buda の VS Code ダイアログを開き直し、最新の設定をコピーしてください。