Installation
Requirements
Section titled “Requirements”- tmux 3.0+
- TPM (for plugin installation)
- GitHub CLI (optional, for displaying PR numbers in the Git tab)
- Rust (only if building from source)
Option A — TPM (recommended)
Section titled “Option A — TPM (recommended)”Add the plugin to your tmux.conf:
set -g @plugin 'hiroppy/tmux-agent-sidebar'Reload tmux.conf, then press prefix + I to install:
tmux source ~/.tmux.confOn the first run, an install wizard prompts you to download a pre-built binary or build from source.
To update later, press prefix + U in TPM’s plugin list and select tmux-agent-sidebar. The install wizard runs again if the bundled binary has changed.
Option B — Manual
Section titled “Option B — Manual”-
Clone the repository:
Terminal window git clone https://github.com/hiroppy/tmux-agent-sidebar.git \~/.tmux/plugins/tmux-agent-sidebar -
Add the plugin to your
tmux.conf:Terminal window run-shell ~/.tmux/plugins/tmux-agent-sidebar/tmux-agent-sidebar.tmux -
Install the binary — download a pre-built release, or build from source:
Terminal window # macOS (Apple Silicon)curl -fSL https://github.com/hiroppy/tmux-agent-sidebar/releases/latest/download/tmux-agent-sidebar-darwin-aarch64 \-o ~/.tmux/plugins/tmux-agent-sidebar/bin/tmux-agent-sidebarchmod +x ~/.tmux/plugins/tmux-agent-sidebar/bin/tmux-agent-sidebarOr build from source:
Terminal window cd ~/.tmux/plugins/tmux-agent-sidebarcargo build --release
Reload tmux config
Section titled “Reload tmux config”After editing tmux.conf, press prefix + r (or run tmux source ~/.tmux.conf) to reload.
Next steps
Section titled “Next steps”The sidebar receives status updates through agent hooks — continue with the agent you use: