ガイド

プラグイン

tmuxプラグインとMacプラグインのインストール・設定方法

プラグイン

MTerm は、リモートサーバー上にプラグインをインストールすることで、ターミナルとの連携機能を強化できます。現在、2 つの公式プラグインが利用可能です。


mterm-tmux(tmuxプラグイン)

tmux と MTerm を連携させるプラグインです。コマンド完了通知、クリップボード連携、セッション管理などの機能が追加されます。

機能

機能説明
クリップボード連携tmux のコピーバッファを MTerm のクリップボード履歴と同期
コンテキスト共有現在のディレクトリ、Git ブランチなどの情報を MTerm に送信
コマンド完了通知長時間実行コマンドの完了をプッシュ通知で受け取り
セッション管理tmux セッション・ウィンドウの一覧表示と切り替え

インストール(TPM)

tmux Plugin Manager(TPM)を使用している場合、~/.tmux.conf に以下を追加します。

# ~/.tmux.conf
set -g @plugin 'mtermapp/mterm-tmux'

# prefix + I でインストール実行

TPM のインストールがまだの場合は、先に TPM をセットアップしてください。

シェルフックの設定

プラグインの機能をフルに活用するには、シェルの初期化ファイルにフックを追加します。

# ~/.zshrc または ~/.bashrc
[ -f ~/.tmux/plugins/mterm-tmux/scripts/init.sh ] \
  && source ~/.tmux/plugins/mterm-tmux/scripts/init.sh

これにより、コマンドの実行開始・終了を MTerm が検知できるようになります。

通知設定

プラグインをインストールすると、MTerm の設定画面(設定 → プラグイン)で通知の挙動を調整できます。

設定説明
通知モードON(通知を受け取る)/ OFF(通知を無効化)
しきい値(秒)指定した秒数以上かかったコマンドのみ通知(デフォルト: 5 秒、1〜120 秒で調整可能)

たとえばしきい値を 10 秒に設定すると、ls のような瞬時に終わるコマンドでは通知が来ず、ビルドやテストなど時間のかかるコマンドが終わったときだけ通知されます。

GitHub

mtermapp/mterm-tmux


mterm-shell(Macプラグイン)

Mac 上のシェルに直接インストールするプラグインです。tmux を使わない環境でも、コマンド完了通知やコンテキスト共有が利用できます。

機能

機能説明
セッション永続化abduco を使ったセッション永続化。SSH 切断後もプロセスが維持される
コンテキスト共有現在のディレクトリ、Git ブランチなどの情報を MTerm に送信
コマンド完了通知長時間実行コマンドの完了をプッシュ通知で受け取り

インストール

git clone https://github.com/mtermapp/mterm-shell \
  ~/.mterm/plugin

シェルフックの設定

# ~/.zshrc または ~/.bashrc
[ -f ~/.mterm/plugin/init.sh ] \
  && source ~/.mterm/plugin/init.sh

セッション永続化(オプション)

abduco をインストールすると、SSH 接続が切れてもシェルセッションを維持できます。再接続時に前回の状態から作業を再開できます。

# abduco のインストール(macOS)
brew install abduco

# 永続セッションの作成
mterm-session "my-project"

mterm-sessionabduco のラッパーコマンドで、セッション名を指定して永続シェルを作成します。SSH が切断されても、次回接続時に同じセッションにアタッチできます。

通知設定

mterm-tmux と同様に、設定画面(設定 → プラグイン)から通知モードとしきい値を設定できます。

GitHub

mtermapp/mterm-shell


どちらを使うべき?

条件おすすめ
tmux を普段使っているmterm-tmux
tmux を使っていない / Mac に直接 SSH 接続mterm-shell
両方使いたい(tmux + 直接接続)両方インストール可能(競合しません)

どちらのプラグインも、インストールしなくても MTerm の基本機能はすべて利用できます。プラグインは「あるとさらに便利」なオプション機能です。