Plugins

MTerm can be extended by installing plugins on your remote servers. Plugins add features like command completion notifications, clipboard sync, and session persistence. Two official plugins are available.

mterm-tmux (tmux plugin)

Integrates tmux with MTerm for clipboard sync, context sharing, notifications, and session management.

Features

Feature	Description
Clipboard Sync	Sync tmux copy buffers with MTerm’s clipboard history
Context Sharing	Send current directory, Git branch, and other context to MTerm
Command Notifications	Get push notifications when long-running commands finish
Session Management	List and switch between tmux sessions and windows

Installation (TPM)

If you use tmux Plugin Manager (TPM), add the following to your ~/.tmux.conf:

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

# Press prefix + I to install

If you do not have TPM yet, set up TPM first.

Shell Hook Setup

To enable full functionality (especially command completion detection), add the shell hook to your shell init file:

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

This lets MTerm detect when commands start and finish, which powers the notification system.

Notification Settings

Once the plugin is installed, configure notification behavior in MTerm’s settings (Settings → Plugins):

Setting	Description
Notify Mode	ON (receive notifications) / OFF (disable notifications)
Threshold (seconds)	Only notify for commands that take longer than this (default: 5 seconds, range: 1–120)

For example, setting the threshold to 10 seconds means quick commands like ls or cd will not trigger notifications, but builds, tests, and long-running scripts will notify you when they complete.

GitHub

mtermapp/mterm-tmux

mterm-shell (Mac plugin)

A shell plugin that installs directly on your Mac (or Linux server) without requiring tmux. Provides command notifications, context sharing, and optional session persistence.

Features

Feature	Description
Session Persistence	Keep shell sessions alive after SSH disconnects using `abduco`
Context Sharing	Send current directory, Git branch, and other context to MTerm
Command Notifications	Get push notifications when long-running commands finish

Installation

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

Shell Hook Setup

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

Session Persistence (Optional)

Install abduco to keep shell sessions alive even when your SSH connection drops. When you reconnect, you can reattach to the same session and pick up exactly where you left off.

# Install abduco (macOS)
brew install abduco

# Create a persistent session
mterm-session "my-project"

mterm-session is a wrapper around abduco that creates a named persistent shell. If your SSH connection drops, the shell keeps running. On your next connection, reattach to the same session.

Notification Settings

Same as mterm-tmux — configure notification mode and threshold in Settings → Plugins.

GitHub

mtermapp/mterm-shell

Which Plugin Should You Use?

Situation	Recommendation
You use tmux regularly	mterm-tmux
You do not use tmux / connect directly to Mac	mterm-shell
You want both (tmux + direct connections)	Install both — they do not conflict

Neither plugin is required. All of MTerm’s core features work without any server-side installation. Plugins are optional enhancements that add convenience features.