Christian Klotz
25cc5c7bf4
* docs(coding-agent): improve getting started documentation * docs(coding-agent): correct getting started details * docs(coding-agent): clarify SDK entry point * docs(coding-agent): restructure guides and references * docs(coding-agent): improve getting started guides * docs(coding-agent): refresh integration guides * docs(coding-agent): improve terminal and CLI guides * docs(coding-agent): refresh customisation guides * docs(coding-agent): clarify project trust terminology * docs(coding-agent): simplify customisation guidance * docs(coding-agent): improve runtime and reference guidance * Fix settings reference * feat(coding-agent): add Crowdin documentation sync * docs(coding-agent): separate CLI and slash command references * docs(coding-agent): correct compaction reference * docs(coding-agent): streamline package documentation * docs(coding-agent): split RPC reference documentation * Update configuration docs * Shorten config docs * docs(coding-agent): refine configuration references * docs(coding-agent): streamline settings reference * docs(coding-agent): clarify configuration reference * docs(coding-agent): clarify project trust exception * docs(coding-agent): simplify keybindings reference * docs(coding-agent): remove Crowdin integration * docs(coding-agent): turn themes reference into guide * docs(coding-agent): consolidate model and authentication docs * docs(tui): require Component.invalidate() (fixes #9358) * docs(coding-agent): document offline catalog behavior (fixes #8684) * docs(coding-agent): preserve established documentation routes * docs(coding-agent): reorganize documentation navigation * docs(coding-agent): correct audited behavior Clarify provider, session, local-model, Termux, TUI, SDK, debug, and extension behavior. Simplify the documentation audit to report only clear user-visible contradictions. * docs(coding-agent): fix broken documentation links
1.8 KiB
Run Pi in tmux
Pi works inside tmux, but tmux can report Shift+Enter, Ctrl+Enter, and plain Enter as the same key. Enable extended keys so Pi can distinguish them.
Check your tmux version
tmux -V
For tmux 3.5 or newer, use the recommended CSI-u configuration below. For tmux 3.2 through 3.4, use the older-version configuration.
Enable extended keys in tmux 3.5 or newer
Add these lines to ~/.tmux.conf:
set -g extended-keys on
set -g extended-keys-format csi-u
Pi requests extended-key reporting when the terminal does not provide the Kitty keyboard protocol directly. CSI-u is the most reliable format for forwarding modified keys through tmux.
Restart tmux
The configuration applies to the tmux server. To guarantee that it is active, close your tmux sessions and start a new server.
If you choose to stop the server from the command line, save your work first. This command terminates every session managed by that server:
tmux kill-server
tmux
Verify modified keys
Start Pi inside the new tmux session and check that:
Shift+Enterinserts a new line in the editor.Entersubmits the prompt.Alt+Enterqueues a follow-up on macOS and Linux. Windows and WSL useCtrl+Qby default.
If these keys still behave like plain Enter, verify that the terminal outside tmux can report modified keys. See Configure your terminal.
Use tmux 3.2 through 3.4
These versions support extended keys but not extended-keys-format csi-u. Add only:
set -g extended-keys on
Pi supports the xterm modifyOtherKeys format used by these versions. Restart tmux and repeat the verification steps.
For older versions, upgrade tmux or use Pi outside tmux rather than relying on modified Enter shortcuts.