Skip to content
tmux-ide

Getting started

Install tmux-ide 2.9 beta and open your first tmux session

Requirements

  • tmux 3.0 or newer; 3.2+ recommended
  • Node.js 20 or newer
  • macOS arm64/x64 or Linux arm64/x64

Installed releases use a compiled OpenTUI runtime and do not require Bun. Development checkouts use Bun to build the runtime and can opt into live source with TMUX_IDE_TUI_SOURCE=1.

Install

npm install -g tmux-ide@beta
tmux-ide app

If the exact-version runtime is not already installed, the first explicit app launch downloads it, verifies its release metadata and SHA-256 digest, and caches it under ~/.tmux-ide/bin. The daemon starts only after a runnable TUI has been selected.

If the download was interrupted:

tmux-ide update --tui-binary
tmux-ide app

Open a session

Home lists the tmux sessions you already own. Select one with the mouse or keyboard, or name it directly:

tmux new-session -s work
tmux-ide app work

If there are no sessions, press N on Home to create one. Closing tmux-ide does not kill the tmux session.

Controls

KeyAction
F1Home
F2Terminals
F3, F4, F6Files, Diff, Missions when those views are configured
F5, Ctrl+PCommands
F8, Ctrl+TabCycle focus inside a composite view
F12Performance HUD
Ctrl+OCycle panes
Ctrl+TCycle windows
Ctrl+GReturn to Home
Ctrl+EToggle the Files editor
Meta+ArrowResize the focused pane
Ctrl+QQuit, or detach a detachable viewer

Pane headers and window tabs also expose mouse controls for the supported actions.

Diagnose an install

tmux-ide doctor --json
tmux-ide inspect --json

When reporting an issue, include the output plus the shortest sequence that reproduces it.