Skip to content

Overview ​

rozi is a tiling terminal multiplexer: it arranges terminal panes the way a tiling window manager arranges windows. It keeps named sessions running after you leave, reaches other machines over SSH, and shows which coding agents need you. You can change any of it live, from inside rozi.

Shells, editors, system monitors, test servers, and coding agents are all ordinary panes. The sidebar can additionally show which coding agents are working, finished, or waiting for your input, on this machine and on connected hosts.

Tiling behavior, animations, and keyboard flow take their cues from the Hyprland window manager.

New to rozi ​

GuideCovers
Getting startedA guided first session: create, split, detach, and reattach
InstallationInstalling, updating, and rolling back
Core conceptsSessions, panes, workspaces, layouts, and profiles
Feature mapWhat rozi can do, grouped by task
Platform supportSupported operating systems and their differences
TroubleshootingCommon problems by symptom, with causes and fixes

Daily use ​

GuideCovers
KeybindingsDefault keys, the prefix, modes, mouse controls, and rebinding
Panes and layoutsTiling layouts, focus, movement, floating panes, and fullscreen
Terminal featuresScrollback, search, copy mode, clipboard, links, images, and shell integration
SessionsNamed and temporary sessions, the session picker, and resurrection
WorktreesOpening each Git worktree in its own session
SidebarPane, session, file, Git, worktree, and agent views

Remote and collaboration ​

GuideCovers
Remote sessionsWorking in sessions on another machine over SSH
Shared sessionsSeveral clients in one session: following, layout control, and read-only access

Customize ​

GuideCovers
Customize roziA guided tour of themes, layouts, pane styles, bars, animations, and keys
ConfigurationThe config.toml reference and live reload
ThemesBuilt-in, system, and custom themes
ProfilesReusable launch recipes and saved layouts
Vim and Neovim navigatorOne set of navigation keys for editor splits and rozi panes

Coding agents ​

GuideCovers
Agent activityHow rozi shows working, blocked, and finished agents
Agent definitionsAdding or overriding coding-agent detection rules
Agent skillTeaching a coding agent to control rozi

Automate and extend ​

GuideCovers
Scripting quick startCommon automation tasks with the rozi command
Control CLIThe full reference for inspecting and controlling rozi from scripts
Control protocolThe raw transport, for clients that cannot run the CLI
Record a pane or the UIRecord a pane or the whole UI over time, then replay it or export frames, a GIF, or a cast
HooksRunning commands when rozi events happen
ExtensionsInstalling, writing, and managing extensions
Automation recipesComplete scripting and extension examples

Development ​

GuideCovers
ContributingSetup, checks, pull requests, and DCO sign-off
Extension testingTesting extension commands and lifecycle behavior
Release processPublishing and checking a release
Benchmarks and profilingRunning the benchmark and profiling tools
Performance audit archiveRecorded measurements and audit history
Performance audit playbookReproducing a full performance audit

To report a vulnerability, read the security policy first.

MPL-2.0