Core Library0.xAPI Reference

Choose documentation 3

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

English

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

Swift API

method libtmux-swift latest

Server.environmentValue(_:in:)

What one variable is set to, or nil when it is unset or marked for removal.

Source and package

Qualified name: Server.environmentValue(_:in:)
Declared in: Server
Package: libtmux-swift
Source: Sources/LibTmux/Environment.swift

environmentValue(name: String, in: EnvironmentScope) -> String? method async [source] ¶

Description#

Reads one value directly so embedded newlines remain part of that value. tmux's nonzero response for an unknown name becomes nil.

Parameters

name (String) #
in (EnvironmentScope) #

Raises

TmuxError

tmux command#

The tmux commands behind environmentValue(_:in:).

show-environment

tmux C API#

The C declarations in tmux that implement these commands.

cmd_show_environment_entry cmd_show_environment_exec

Reference preview