GitHub

Source on GitHub 3

Core Library

libtmuxtmux-python/libtmux

MCP

libtmux-mcptmux-python/libtmux-mcp

Workspace Manager

tmuxptmux-python/tmuxp

Python · tmux-python/libtmux

Packages

Packages on PyPI 3

Core Library

MCP

libtmux-mcpPyPI

Workspace Manager

Python · PyPI

Auto Light Dark

Core LibrarystableAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references Upstream reference

stable Stable release on its package registry. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

pre-alpha Early development; expect breaking changes. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference Configuration Internals

stable Stable release on its package registry. Read more

stable

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

Pane.pipe

Pipe pane output to a shell command via $ tmux pipe-pane.

Source and package

Qualified name: libtmux.Pane.pipe
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py
Other languages: PowerShell Julia Ruby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala F#

pipe ( self, command: str | None = None, output_only: bool | None = None, input_only: bool | None = None, toggle: bool | None = None, ) → None method [source] ¶

Examples#

>>> pane.pipe('cat >> /tmp/output.txt')

Stop piping:

>>> pane.pipe()

Parameters

command (str | None) # – Shell command to pipe to. If None, stops piping.
output_only (bool | None) # – Only pipe output from the pane (-O flag).
input_only (bool | None) # – Only pipe input to the pane (-I flag).
toggle (bool | None) # – Toggle piping on/off (-o flag).

tmux command pipe-pane

In other ports Copy a pane's output to a shell command

PowerShell
No source-verified PowerShell equivalent is recorded for this operation.
Julia
No source-verified Julia equivalent is recorded for this operation.
Ruby
LibTmux::Pane#pipe
Lua
No source-verified Lua equivalent is recorded for this operation.
TypeScript
pane.Pane.pipeTo
Rust
pane.Pane.pipe
Go
tmux.Pane.Pipe
Java
io.github.libtmux.Pane.pipeTo
C#
LibTmux.Pane.PipeAsync
C++
libtmux::Pane::pipe_to
Swift
Server.pipe(_:to:)
Kotlin
No source-verified Kotlin equivalent is recorded for this operation.
Scala
No source-verified Scala equivalent is recorded for this operation.
F#
No source-verified F# equivalent is recorded for this operation.

Reference preview Open reference