Python

Choose a port 22

Scripting & web

LuaNo matching page

JuliaNo matching page

PerlNo matching page

Compiled & native

Common LispNo matching page

OCamlNo matching page

HaskellNo matching page

JVM

KotlinNo matching page

ScalaNo matching page

ClojureNo matching page

.NET

F#No matching page

PowerShellNo matching page

BEAM

ElixirNo matching page

tmux

Packages

Packages and source 10

Source

libtmuxtmux-python/libtmux pytest pluginplugin · src/libtmux/pytest_plugin.py libtmux.testmodule · src/libtmux/test libtmux-mcplibtmux-mcp/src/libtmux_mcp libtmux-mcptmux-python/libtmux-mcp tmuxptmuxp/src/tmuxp tmuxptmux-python/tmuxp

Packages

libtmux-mcpPyPI

Python · tmux-python/libtmux

Auto Light Dark

Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references Upstream reference

0.x Released; the API may change. 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

1.x Released; the API may change. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Python API

method libtmux latest

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: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

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#

The tmux commands behind pipe.

tmux C API#

The C declarations in tmux that implement these commands.

cmd_pipe_pane_entry cmd_pipe_pane_exec

In other ports#

Copy a pane's output to a shell command

Equivalents of Copy a pane's output to a shell command in other languages
Language	Equivalent
Ruby	`LibTmux::Pane#pipe`
Erlang	`tmux_pane:pipe/3`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
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:)`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Reference preview