Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

method libtmux-ts latest

Pane.pipeTo

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

Source and package
Qualified name
Pane.pipeTo
Module
pane
Declared in
Pane
Package
libtmux
Source
packages/libtmux/src/pane.ts
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua RustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
pipeTo( command?: string, options?: { readonly toggle?: boolean }, ): Promise<void>

Description#

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.

Examples#

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

tmux command#

The tmux commands behind pipeTo.

tmux C API#

The C declarations in tmux that implement these commands.

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
Python libtmux.Pane.pipe
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.
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#.

Esc

Type to search.

Reference previewOpen reference