Get Started

Documentation

Everything you need to install, configure, and get the most out of teru.

Basics

Getting Started

Install teru on Arch Linux (AUR) or build from source. First run, key concepts, and your first session.

Read →

Configuration

Config file reference for ~/.config/teru/teru.conf — all 14 keys, their defaults, and hook system.

Read →

Keybindings

Prefix key system, all keybindings, layout cycling, workspace switching, and custom prefix config.

Read →

Features

Multiplexer

Four tiling layouts, 9 workspaces, pane management, session persistence, and scrollback compression.

Read →

AI Integration

CustomPaneBackend protocol, MCP server (6 tools), OSC 9999 agent protocol, and Claude Code hook listener.

Read →

Advanced

Architecture

Source directory structure, module overview, build system, and 250+ inline test coverage.

Read →

Quick install

Arch Linux (AUR)
paru -S teru
Build from source
git clone https://codeberg.org/ng/teru.git
cd teru && make release
sudo make install