TypeScript API

pane.Pane.pipeTo

TypeScript

Module: pane
Declared in: Pane
Package: libtmux
Source: packages/libtmux/src/pane.ts
Other languages: Python Ruby Lua Rust Go Java .NET C++Swift

pipeTo ( command : : string , options : : { readonly toggle?: boolean } ) → Promise<void> method [source] ¶ method [source] ¶ pipeTo

Send everything this pane writes to a shell command as well as its screen.

A pane keeps history-limit lines and a stream reader keeps a bounded buffer, so output larger than either is gone before anything asks for it. The command runs for as long as the pipe is open, which is how a long build is captured whole. Pass no command to stop one.

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

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

Examples

TypeScript Python

await pane.pipeTo("cat >> /tmp/build.log");

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

Stop piping:

>>> pane.pipe()

0 declared, 0 inherited