Workspace ManagerconceptAPI Reference

Choose documentation 3

Home

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

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

latest

English

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

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Workspace Manager: API Reference

Up Root

`TmuxShellCommand`

struct TmuxShellCommand : struct TmuxShellCommand struct [source] ¶

Bases:

A command to put in a pane, and whether to run it.

Description#

tmuxp writes most commands as a bare string, and that is what a string literal here means — type it and press enter. The long form, {cmd:, enter:}, exists to leave a command sitting in the pane unrun, which is why enter is modelled rather than dropped.

Members9#

Common operations1#

enter: let enter: Bool property Whether to press enter after typing it. False leaves the line sitting at the prompt, ready but not run.

Other members8#

init(unicodeScalarLiteral:) method inherited
init(extendedGraphemeClusterLiteral:) method inherited
!=(_:_:) function inherited Returns a Boolean value indicating whether two values are not equal.
command: let command: String property The line to type into the pane.
init(_:enter:) method
init(stringLiteral:) method Creates an instance initialized to the given string value.
init(from:) method Creates a new instance by decoding from the given decoder.
encode(to:) method Written back the way it was most likely written: a bare string unless enter carries information a string cannot.

Reference preview

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`TmuxShellCommand`

Description#

Members9#

Common operations1#

Other members8#