MCPconceptAPI Reference

Choose documentation 3

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.

mcp.src.TmuxTools.show_environment

#[tool_router(router = inspect_router, vis = "pub(super)")] impl TmuxTools #[tool( description = "List the variables tmux hands to processes it starts, for the server \ or for one session, and whether each is set or marked for removal. \ Values are withheld: a tmux server inherits the environment of the \ shell that started it, tokens and keys included. A value is returned \ only for a name the operator listed in LIBTMUX_ENVIRONMENT_VALUES at \ startup, and is then returned in clear. This is not the environment of \ anything already running: a pane started before a change keeps what it \ was given.", title = "Show tmux Environment", meta = crate::capability_meta!(Inspect, None, [Observe], [ProcessEnvironment], true, true, { "session" => [TmuxLookup] }) )] pub async fn show_environment( &self, Parameters(ShowEnvironmentArgs { session }): Parameters<ShowEnvironmentArgs>, ) -> Result<Json<Environment>, ToolError>

Read the names in a tmux environment, and the values the operator allowed.

Guides#

Pages that discuss show_environment.

Esc

Type to search.

Reference previewOpen reference