Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

Other references pkg.go.dev

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

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. 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.

Go API

struct libtmux-go latest

SendKeysRequest

SendKeysRequest configures tmux key input. Pointer values are copied before I/O and must not be mutated concurrently.

Source and package

Qualified name: tmux.SendKeysRequest
Package: tmux
Distribution: github.com/libtmux/libtmux-go/tmux
Source: tmux/pane_input.go

struct tmux.SendKeysRequest struct [source] ¶: Description#

Command must be nonnil unless Reset, Repeat, or CopyModeCommand is set. A nonnil empty Command is an explicit key operand and is followed by Enter unless SkipEnter is set. CopyModeCommand takes precedence over Command and suppresses Enter. HexKeys takes precedence over Literal when both are set.

Fields11#

SendKeysRequest fields
Name	Type	Description
SkipEnter	`bool`	SkipEnter prevents the separate Enter key sent after Command.
Command	`*string`	Command is one tmux key operand. Nil selects a flag-only invocation; nonnil, including an empty string, supplies the operand.
Literal	`bool`	Literal disables tmux key-name lookup and treats Command as literal UTF-8. It does not bypass interpretation by the pane's application or shell.
CopyModeCommand	`*string`	CopyModeCommand sends a tmux copy-mode command instead of Command. A nonnil empty string remains an explicit operand.
ExpandFormats	`bool`	ExpandFormats asks tmux to expand format expressions in key operands.
HexKeys	`bool`	HexKeys interprets key operands as hexadecimal ASCII values and takes precedence over Literal.
KeyName	`bool`	KeyName routes keys through the selected client's key table rather than delivering them to the pane.
Repeat	`int`	Repeat repeats the key input a positive number of times. Zero omits the repeat count.
Reset	`bool`	Reset asks tmux to reset terminal state before processing key input.
SuppressHistory	`bool`	SuppressHistory prefixes Command with one space. Whether that excludes the text from history depends on the application or shell in the pane.
TargetClient	`ClientName`	TargetClient selects the client used by KeyName. Zero leaves client selection to tmux; without KeyName it does not redirect pane input.

Guides#

Pages that discuss SendKeysRequest.

Examples: Capture pane output
Guides: Sending keys

Reference preview