tmux.ts - v0.1.3
    Preparing search index...

    Variable pipePaneConst

    pipePane: (
        ...args: [
            shellCommand: string,
            options?: {
                input?: boolean;
                onlyOpen?: boolean;
                output?: boolean;
                targetPane?: string;
            },
        ],
    ) => Effect<
        string,
        TmuxCommandOptionsError
        | TmuxProcessRunError,
        TmuxProcess,
    > = ...

    Pipe a tmux pane's output to (or input from) a shell command (tmux pipe-pane).

    Type Declaration

      • (
            ...args: [
                shellCommand: string,
                options?: {
                    input?: boolean;
                    onlyOpen?: boolean;
                    output?: boolean;
                    targetPane?: string;
                },
            ],
        ): Effect<
            string,
            TmuxCommandOptionsError
            | TmuxProcessRunError,
            TmuxProcess,
        >

      • Parameters

        • ...args: [
              shellCommand: string,
              options?: {
                  input?: boolean;
                  onlyOpen?: boolean;
                  output?: boolean;
                  targetPane?: string;
              },
          ]

        Returns Effect<string, TmuxCommandOptionsError | TmuxProcessRunError, TmuxProcess>

        An empty string on success.

    await tmux.pipePane("cat >> /tmp/log", { targetPane: "0" });

    // omit the command to close any existing pipe
    await tmux.pipePane();

    Settings
    Member Visibility