Pipe pane

pipe_pane

pipe_pane
mutating tool

Log a pane’s live output to a file (or stop an active log).

Returns:

str

Use when you need to log pane output to a file — useful for monitoring long-running processes or capturing output that scrolls past the visible area.

Avoid when you only need a one-time capture — use capture_pane with start/end to read scrollback.

Side effects: Starts or stops piping output to a file. Call with output_path=null to stop.

Example:

{
  "tool": "pipe_pane",
  "arguments": {
    "pane_id": "%0",
    "output_path": "/tmp/build.log"
  }
}

Response (start):

Piping pane %0 to /tmp/build.log

Stopping the pipe:

{
  "tool": "pipe_pane",
  "arguments": {
    "pane_id": "%0",
    "output_path": null
  }
}

Response (stop):

Piping stopped for pane %0

Parameters

Parameter

Type

Required

Default

Description

pane_id

str

no

Pane ID (e.g. ‘%1’).

output_path

str

no

File path to write output to. None stops piping.

append

bool

no

True

Whether to append to the file. Default True. If False, overwrites.

session_name

str

no

Session name for pane resolution.

session_id

str

no

Session ID for pane resolution.

window_id

str

no

Window ID for pane resolution.

socket_name

str

no

tmux socket name.