Skip to content

README.ja.md

Latest commit

 

History

History
85 lines (62 loc) · 2.66 KB

README.ja.md

File metadata and controls

85 lines (62 loc) · 2.66 KB

EasyRemoteSSH

概要

VSCodeでのSSHを楽にするツールです。SSH先のリモート環境でcコマンドを実行すると、VSCode（またはCursorなど）の接続コマンドが自動的にクリップボードにコピーされます。これによりローカルマシンからリモート環境への接続が簡単に行えます。

前提条件

  • ローカルマシンにVSCode（またはVSCodeのフォーク）がインストールされていること
  • codeコマンド（またはcursorなど）へのパスが通っていること
  • Remote SSHプラグインが導入されていること
  • SSHでリモートサーバーに接続できる環境があること
    • .ssh/configの設定推奨

セットアップ手順

1. リポジトリのクローン

リモートサーバーにSSH接続し、以下のコマンドを実行します：

git clone https://github.com/yi7242/EasyRemoteSSH.git
cd EasyRemoteSSH

2. 変数の設定

設定ファイルを自分の環境に合わせて編集してください：

# 設定ファイルを開く
nano config.sh

# 以下の変数を編集
remote_host="" # .ssh/configのHost
editor="code" # ローカルで使用するエディタコマンド（code, cursorなど）

実行時に環境変数で上書きすることもできます：

env EASY_REMOTE_SSH_HOST=my-host EASY_REMOTE_SSH_EDITOR=code c

3. パスを通す

以下のいずれかの方法でパスを通します：

一時的に使用する場合

export PATH=$PATH:$(pwd)

永続的に使用する場合

echo 'export PATH=$PATH:'"$(pwd)" >> ~/.bashrc
source ~/.bashrc

Fish を使う場合

Fish では次のように PATH へ追加できます：

fish_add_path (pwd)

使用方法

基本的な使い方

リモートサーバー上で現在のディレクトリを開くには：

user@userserver:~/project$ c
code --remote ssh-remote+userserver /home/user/project
Copied to Clipboard!

この出力されたコマンドがクリップボードにコピーされるので、ローカルマシンで貼り付けて実行するだけです。

editor="code" または editor="code-insiders" の場合、OSC 8 ハイパーリンクとカスタム URI ハンドラに対応したターミナルではクリック可能なリンクも表示されます。

他のディレクトリを指定する場合

特定のディレクトリを指定するには：

user@userserver:~/project$ c ../
code --remote ssh-remote+userserver /home/user
Copied to Clipboard!