Skip to content

Installation

  • tmux 3.0+
  • TPM (for plugin installation)
  • GitHub CLI (optional, for displaying PR numbers in the Git tab)
  • Rust (only if building from source)

Add the plugin to your tmux.conf:

Terminal window
set -g @plugin 'hiroppy/tmux-agent-sidebar'

Reload tmux.conf, then press prefix + I to install:

Terminal window
tmux source ~/.tmux.conf

On 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.

  1. Clone the repository:

    Terminal window
    git clone https://github.com/hiroppy/tmux-agent-sidebar.git \
    ~/.tmux/plugins/tmux-agent-sidebar
  2. Add the plugin to your tmux.conf:

    Terminal window
    run-shell ~/.tmux/plugins/tmux-agent-sidebar/tmux-agent-sidebar.tmux
  3. 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-sidebar
    chmod +x ~/.tmux/plugins/tmux-agent-sidebar/bin/tmux-agent-sidebar

    Or build from source:

    Terminal window
    cd ~/.tmux/plugins/tmux-agent-sidebar
    cargo build --release

After editing tmux.conf, press prefix + r (or run tmux source ~/.tmux.conf) to reload.

The sidebar receives status updates through agent hooks — continue with the agent you use: