{ "name": "libtmux for Python", "url": "https://libtmux.org/en/py/stable/", "description": "Guides, examples and API reference for libtmux.", "sourceRepository": "https://github.com/tmux-python/libtmux", "agentEntrypoints": { "manifest": "/en/py/stable/docs.json", "llms": "/en/py/stable/llms.txt", "llmsFull": "/en/py/stable/llms-full.txt", "inventory": "/en/objects.inv" }, "ports": [ { "slug": "py", "name": "Python", "language": "Python", "referenceKind": "model", "package": "libtmux", "reference": "/en/py/stable/reference/", "products": [ { "slug": "workspace", "name": "Workspace Manager", "availability": "available", "inDevelopment": false, "cli": "tmuxp load", "cliAvailability": "released", "url": "/en/py/stable/workspace/", "reference": "/en/py/stable/workspace/reference/", "source": { "product": "workspace", "package": "tmuxp", "repo": "tmux-python/tmuxp", "revision": "153acdf6ff1268b14d3d03ed488f545a7123c8f1", "extractedRevision": "153acdf6ff1268b14d3d03ed488f545a7123c8f1", "version": "1.74.0" } }, { "slug": "mcp", "name": "MCP", "availability": "available", "inDevelopment": true, "url": "/en/py/stable/mcp/", "reference": "/en/py/stable/mcp/reference/", "protocol": "/en/py/stable/mcp/tools.json", "source": { "product": "mcp", "package": "libtmux-mcp", "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "version": "0.1.0a22" } } ], "extracted": { "symbols": 2539, "extractor": "@libtmux/api-model@0.0.1", "inventory": "/en/py/stable/reference/objects.inv" }, "documentation": [ { "id": "core", "name": "Core library", "kind": "core", "availability": "available", "url": "/en/py/stable/" }, { "id": "workspace", "name": "Workspace Manager", "kind": "product", "availability": "available", "url": "/en/py/stable/workspace/" }, { "id": "mcp", "name": "MCP", "kind": "product", "availability": "available", "url": "/en/py/stable/mcp/" } ] } ], "pages": [ { "title": "Third-party notices", "description": "Thanks to tmux's creator and contributors, with licences and attribution for the software behind libtmux.org.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/meta/third-party-notices/", "markdownUrl": "https://libtmux.org/en/py/stable/meta/third-party-notices.md", "headings": [ { "id": "tmux", "level": 2, "text": "tmux" }, { "id": "tmux-artwork", "level": 3, "text": "tmux artwork" }, { "id": "programming-language-artwork", "level": 2, "text": "Programming-language artwork" }, { "id": "terminal-artwork", "level": 2, "text": "Terminal artwork" }, { "id": "documentation-toolchain", "level": 2, "text": "Documentation toolchain" }, { "id": "a-note-on-doxygen", "level": 3, "text": "A note on Doxygen" }, { "id": "reference-hosting", "level": 2, "text": "Reference hosting" }, { "id": "libtmux-itself", "level": 2, "text": "libtmux itself" } ] }, { "title": "Concepts", "description": "tmux objects, command transports, queries, and workspaces.", "section": "Concepts", "url": "https://libtmux.org/en/py/stable/concepts/", "markdownUrl": "https://libtmux.org/en/py/stable/concepts/index.md", "headings": [] }, { "title": "Filtering and queries", "description": "How you get from every session on the server to the one pane you mean, and what happens when zero or several match.", "section": "Concepts", "url": "https://libtmux.org/en/py/stable/concepts/queries/", "markdownUrl": "https://libtmux.org/en/py/stable/concepts/queries.md", "headings": [ { "id": "filter-collections-and-select-one-object", "level": 2, "text": "Filter collections and select one object" }, { "id": "result-counts", "level": 2, "text": "Result counts" } ] }, { "title": "Server, session, window, pane", "description": "How tmux servers, sessions, windows, panes and attached clients relate to each other.", "section": "Concepts", "url": "https://libtmux.org/en/py/stable/concepts/server-session-window-pane/", "markdownUrl": "https://libtmux.org/en/py/stable/concepts/server-session-window-pane.md", "headings": [ { "id": "stable-identity-not-name-or-index", "level": 2, "text": "Stable identity, not name or index" }, { "id": "client-a-view-not-a-child", "level": 2, "text": "Client: a view, not a child" } ] }, { "title": "Control mode vs one-shot", "description": "Choose subprocesses, command batches, or persistent connections to send commands and receive events.", "section": "Concepts", "url": "https://libtmux.org/en/py/stable/concepts/transports/", "markdownUrl": "https://libtmux.org/en/py/stable/concepts/transports.md", "headings": [ { "id": "available-transports", "level": 2, "text": "Available transports" }, { "id": "a-control-client-is-a-real-client", "level": 2, "text": "A control client is a real client" }, { "id": "why-fold-several-commands-into-one-invocation", "level": 2, "text": "Why fold several commands into one invocation" }, { "id": "what-this-costs-in-practice", "level": 2, "text": "What this costs in practice" }, { "id": "sending-a-command", "level": 2, "text": "Sending a command" } ] }, { "title": "Workspaces", "description": "Build pane layouts with the object API or a workspace configuration file.", "section": "Concepts", "url": "https://libtmux.org/en/py/stable/concepts/workspaces/", "markdownUrl": "https://libtmux.org/en/py/stable/concepts/workspaces.md", "headings": [ { "id": "building-one-imperatively", "level": 2, "text": "Building one imperatively" }, { "id": "building-one-declaratively", "level": 2, "text": "Building one declaratively" }, { "id": "cleaning-up", "level": 2, "text": "Cleaning up" } ] }, { "title": "Examples", "description": "Programs for sending input, capturing output, and building workspaces.", "section": "Examples", "url": "https://libtmux.org/en/py/stable/examples/", "markdownUrl": "https://libtmux.org/en/py/stable/examples/index.md", "headings": [ { "id": "source-and-verification", "level": 2, "text": "Source and verification" } ] }, { "title": "Attach and send keys", "description": "Get a session handle, send a command to a pane, and capture output.", "section": "Examples", "url": "https://libtmux.org/en/py/stable/examples/attach-and-send-keys/", "markdownUrl": "https://libtmux.org/en/py/stable/examples/attach-and-send-keys.md", "headings": [ { "id": "finding-an-existing-session-instead", "level": 2, "text": "Finding an existing session instead" }, { "id": "where-this-comes-from", "level": 2, "text": "Where this comes from" }, { "id": "source-inclusion", "level": 3, "text": "Source inclusion" } ] }, { "title": "Capture pane output", "description": "Run a complete program that captures a pane and waits for a complete output line.", "section": "Examples", "url": "https://libtmux.org/en/py/stable/examples/capture-pane-output/", "markdownUrl": "https://libtmux.org/en/py/stable/examples/capture-pane-output.md", "headings": [ { "id": "read-whats-on-screen", "level": 2, "text": "Read what’s on screen" }, { "id": "wait-for-output-or-completion", "level": 2, "text": "Wait for output or completion" }, { "id": "setup-and-run", "level": 2, "text": "Setup and run" }, { "id": "where-this-comes-from", "level": 2, "text": "Where this comes from" } ] }, { "title": "Guides", "description": "Task-oriented walkthroughs that sit between the concepts and each port's own API reference.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/index.md", "headings": [] }, { "title": "Attaching to tmux", "description": "Connect to an existing tmux server and find a session with Python.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/attaching-to-tmux/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/attaching-to-tmux.md", "headings": [ { "id": "connect-to-an-existing-server", "level": 2, "text": "Connect to an existing server" }, { "id": "setup-and-run", "level": 2, "text": "Setup and run" }, { "id": "find-or-create-a-session", "level": 2, "text": "Find or create a session" } ] }, { "title": "Capturing output", "description": "Read pane output with an explicit completion condition.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/capturing-output/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/capturing-output.md", "headings": [ { "id": "run-the-complete-program", "level": 2, "text": "Run the complete program" }, { "id": "visible-pane-vs-scrollback", "level": 2, "text": "Visible pane vs. scrollback" }, { "id": "wait-for-the-expected-text", "level": 2, "text": "Wait for the expected text" }, { "id": "wait-for-a-completion-signal", "level": 2, "text": "Wait for a completion signal" } ] }, { "title": "Getting started", "description": "Run a complete program with this language library.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/getting-started/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/getting-started.md", "headings": [ { "id": "run-the-smallest-thing-that-proves-it-works", "level": 2, "text": "Run the smallest thing that proves it works" }, { "id": "what-just-happened", "level": 2, "text": "What just happened" }, { "id": "connect-to-an-existing-server", "level": 2, "text": "Connect to an existing server" }, { "id": "where-to-go-next", "level": 2, "text": "Where to go next" } ] }, { "title": "Querying and filtering", "description": "Choose a target and handle missing or ambiguous results.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/querying-and-filtering/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/querying-and-filtering.md", "headings": [ { "id": "require-exactly-one-match", "level": 2, "text": "Require exactly one match" }, { "id": "declarative-filters", "level": 2, "text": "Declarative filters" }, { "id": "case-insensitive-matching", "level": 2, "text": "Case-insensitive matching" }, { "id": "push-the-filter-into-tmux-or-read-once-and-filter-locally", "level": 2, "text": "Push the filter into tmux, or read once and filter locally" } ] }, { "title": "Sending keys", "description": "Send text and named keys, then wait for the result.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/sending-keys/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/sending-keys.md", "headings": [ { "id": "run-the-complete-program", "level": 2, "text": "Run the complete program" }, { "id": "literal-text-key-names-and-whether-enter-follows", "level": 2, "text": "Literal text, key names, and whether Enter follows" }, { "id": "the-race-you-cant-see-from-the-call-site", "level": 2, "text": "The race you can’t see from the call site" }, { "id": "where-to-go-next", "level": 2, "text": "Where to go next" } ] }, { "title": "Testing with libtmux", "description": "Use an isolated server and check cleanup failures.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/guides/testing-with-libtmux/", "markdownUrl": "https://libtmux.org/en/py/stable/guides/testing-with-libtmux.md", "headings": [ { "id": "run-a-complete-example", "level": 2, "text": "Run a complete example" }, { "id": "keep-server-ownership-explicit", "level": 2, "text": "Keep server ownership explicit" }, { "id": "wait-for-the-state-you-assert", "level": 2, "text": "Wait for the state you assert" } ] }, { "title": "tmux MCP for Python", "description": "Expose tmux tools, resources, and prompts through Python's libtmux-mcp server.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/mcp/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/index.md", "headings": [ { "id": "start-here", "level": 2, "text": "Start here" } ] }, { "title": "Python MCP examples", "description": "List sessions through the Python MCP server and inspect implementation examples.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/mcp/examples/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/examples.md", "headings": [ { "id": "list-sessions", "level": 2, "text": "List sessions" }, { "id": "internals", "level": 2, "text": "Internals" }, { "id": "inspect-the-catalog-in-python", "level": 3, "text": "Inspect the catalog in Python" }, { "id": "run-and-observe-through-a-client", "level": 3, "text": "Run and observe through a client" } ] }, { "title": "Connect a Python MCP client", "description": "Launch libtmux-mcp on a chosen socket and verify the tools your client receives.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/mcp/guides/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/guides.md", "equivalence": "mcp-client-setup", "headings": [ { "id": "launch-the-server", "level": 2, "text": "Launch the server" }, { "id": "verify-the-connection", "level": 2, "text": "Verify the connection" }, { "id": "diagnose-a-mismatch", "level": 2, "text": "Diagnose a mismatch" } ] }, { "title": "Python MCP API", "description": "Find Python server entry points, typed models, and the separate MCP wire contract.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/mcp/reference/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/reference.md", "headings": [ { "id": "mcp-operations", "level": 2, "text": "MCP operations" }, { "id": "python-entry-points", "level": 2, "text": "Python entry points" } ] }, { "title": "Python MCP topics", "description": "Understand Python toolsets, socket overrides, terminal output, and command completion.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/mcp/topics/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/topics.md", "headings": [ { "id": "select-independent-toolsets", "level": 2, "text": "Select independent toolsets" }, { "id": "know-the-endpoint-and-caller", "level": 2, "text": "Know the endpoint and caller" }, { "id": "choose-the-completion-signal", "level": 2, "text": "Choose the completion signal" }, { "id": "treat-terminal-output-as-data", "level": 2, "text": "Treat terminal output as data" } ] }, { "title": "Topics", "description": "Object traversal, cleanup, pane I/O, configuration, and failure handling.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/index.md", "headings": [] }, { "title": "Architecture", "description": "Locate operations, distinguish snapshots from live commands, and find their implementation.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/architecture/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/architecture.md", "headings": [ { "id": "calling-operations", "level": 2, "text": "Calling operations" }, { "id": "reading-tmux-fields", "level": 2, "text": "Reading tmux fields" }, { "id": "source-layout", "level": 2, "text": "Source layout" } ] }, { "title": "Ownership and cleanup", "description": "Scope-based cleanup for tmux objects, and when your program must kill them explicitly.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/context-managers/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/context-managers.md", "headings": [ { "id": "nested-context-managers", "level": 2, "text": "Nested context managers" }, { "id": "testing-cleanup", "level": 2, "text": "Testing cleanup" } ] }, { "title": "Environment", "description": "Locate tmux objects from process variables and manage the environment inherited by new panes.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/environment/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/environment.md", "headings": [ { "id": "locating-yourself-from-inside-a-pane", "level": 2, "text": "Locating yourself from inside a pane" }, { "id": "examples", "level": 3, "text": "Examples" }, { "id": "tmuxs-own-environment-variable-store", "level": 2, "text": "tmux’s own environment variable store" }, { "id": "examples-1", "level": 3, "text": "Examples" } ] }, { "title": "Errors and exceptions", "description": "Handle command failures, inspect delivery status, and decide when a retry is safe.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/errors-and-exceptions/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/errors-and-exceptions.md", "headings": [ { "id": "a-failed-command-as-a-value", "level": 2, "text": "A failed command, as a value" }, { "id": "is-it-safe-to-retry", "level": 2, "text": "Is it safe to retry?" } ] }, { "title": "Format-token fields", "description": "The typed fields every object exposes, mirroring tmux's own format tokens, and why a field is sometimes absent.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/format-tokens/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/format-tokens.md", "headings": [ { "id": "handling-an-absent-field", "level": 2, "text": "Handling an absent field" }, { "id": "field-availability", "level": 2, "text": "Field availability" }, { "id": "fields-promoted-from-the-active-child", "level": 2, "text": "Fields promoted from the active child" } ] }, { "title": "Options and hooks", "description": "Read and update tmux options, and register commands for tmux events.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/options-and-hooks/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/options-and-hooks.md", "headings": [ { "id": "reading-and-writing-options", "level": 2, "text": "Reading and writing options" }, { "id": "examples", "level": 3, "text": "Examples" }, { "id": "hooks", "level": 2, "text": "Hooks" }, { "id": "examples-1", "level": 3, "text": "Examples" }, { "id": "supported-hook-scopes", "level": 2, "text": "Supported hook scopes" }, { "id": "tmux-version-compatibility", "level": 2, "text": "tmux version compatibility" } ] }, { "title": "Pane interaction", "description": "Input defaults, screen capture, and waiting for a command to finish.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/pane-interaction/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/pane-interaction.md", "headings": [ { "id": "typing-into-a-pane", "level": 2, "text": "Typing into a pane" }, { "id": "examples", "level": 3, "text": "Examples" }, { "id": "reading-a-pane-back", "level": 2, "text": "Reading a pane back" }, { "id": "waiting-for-something-to-finish", "level": 2, "text": "Waiting for something to finish" } ] }, { "title": "Socket and servers", "description": "Select a server socket, check liveness, and detect a replacement daemon.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/socket-and-servers/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/socket-and-servers.md", "headings": [ { "id": "naming-a-server", "level": 2, "text": "Naming a server" }, { "id": "is-the-server-actually-there", "level": 2, "text": "Is the server actually there?" }, { "id": "killing-a-server-and-telling-two-apart", "level": 2, "text": "Killing a server, and telling two apart" } ] }, { "title": "Traversal", "description": "Moving up and down the server/session/window/pane tree, and the two questions that come up once you have more than one object.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/traversal/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/traversal.md", "headings": [ { "id": "down-the-hierarchy", "level": 2, "text": "Down the hierarchy" }, { "id": "all-panes-in-a-session", "level": 2, "text": "All panes in a session" }, { "id": "up-the-hierarchy", "level": 2, "text": "Up the hierarchy" }, { "id": "one-walk-down-and-back-up", "level": 2, "text": "One walk, down and back up" }, { "id": "the-active-child", "level": 2, "text": "The active child" }, { "id": "is-it-in-that-collection", "level": 2, "text": "Is it in that collection?" }, { "id": "is-this-the-same-object", "level": 2, "text": "Is this the same object?" } ] }, { "title": "Waiting and retrying", "description": "Polling a condition instead of guessing a sleep, and tmux's own wait-for signal channel as the alternative to polling.", "section": "Topics", "url": "https://libtmux.org/en/py/stable/topics/waiting-and-retry/", "markdownUrl": "https://libtmux.org/en/py/stable/topics/waiting-and-retry.md", "headings": [ { "id": "polling-a-condition", "level": 2, "text": "Polling a condition" }, { "id": "examples", "level": 3, "text": "Examples" }, { "id": "tmuxs-own-wait-for-channel", "level": 2, "text": "tmux’s own wait-for channel" } ] }, { "title": "Python workspace manager", "description": "Describe a tmux session in a file, then load, inspect and capture it.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/workspace/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/index.md", "headings": [ { "id": "start-here", "level": 2, "text": "Start here" } ] }, { "title": "tmuxp CLI manual", "description": "Use tmuxp to load, inspect and save workspace configurations.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/index.md", "headings": [ { "id": "sessions", "level": 2, "text": "Sessions" }, { "id": "workspace-files", "level": 2, "text": "Workspace files" }, { "id": "diagnostics-and-shell", "level": 2, "text": "Diagnostics and shell" }, { "id": "command-options", "level": 2, "text": "Command options" } ] }, { "title": "Shell completion", "description": "Generate completion for the installed workspace command.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/completion/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/completion.md", "headings": [] }, { "title": "Convert workspace files", "description": "Convert a complete workspace document between YAML and JSON.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/convert/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/convert.md", "headings": [ { "id": "change-the-file-format", "level": 2, "text": "Change the file format" } ] }, { "title": "Inspect runtime diagnostics", "description": "Collect the workspace CLI runtime, configuration and tmux diagnostics..", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/debug-info/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/debug-info.md", "headings": [ { "id": "collect-a-report", "level": 2, "text": "Collect a report" } ] }, { "title": "Edit a workspace", "description": "Resolve a workspace file or saved name and open it in an editor.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/edit/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/edit.md", "headings": [ { "id": "open-a-workspace", "level": 2, "text": "Open a workspace" } ] }, { "title": "Capture a workspace", "description": "Capture a running tmux session as a starting point for a workspace file.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/freeze/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/freeze.md", "headings": [ { "id": "export-a-named-session", "level": 2, "text": "Export a named session" } ] }, { "title": "Import a workspace", "description": "Choose a source format and translate it into a workspace document.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/import/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/import.md", "headings": [] }, { "title": "Import from Teamocil", "description": "Translate Teamocil windows and pane commands into a workspace document.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/import-teamocil/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/import-teamocil.md", "headings": [ { "id": "select-an-existing-source", "level": 2, "text": "Select an existing source" }, { "id": "arguments-and-flags", "level": 2, "text": "Arguments and flags" } ] }, { "title": "Import from tmuxinator", "description": "Translate a tmuxinator project into a workspace document.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/import-tmuxinator/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/import-tmuxinator.md", "headings": [ { "id": "select-an-existing-source", "level": 2, "text": "Select an existing source" }, { "id": "arguments-and-flags", "level": 2, "text": "Arguments and flags" } ] }, { "title": "Load a workspace", "description": "Create or reuse a session from a workspace file, with explicit attachment and output choices.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/load/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/load.md", "headings": [ { "id": "loading-and-attachment", "level": 2, "text": "Loading and attachment" }, { "id": "progress-and-script-output", "level": 2, "text": "Progress and script output" }, { "id": "arguments-and-flags", "level": 2, "text": "Arguments and flags" } ] }, { "title": "List saved workspaces", "description": "List the workspace files found in project and global configuration locations.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/ls/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/ls.md", "headings": [ { "id": "list-records", "level": 2, "text": "List records" } ] }, { "title": "Search workspaces", "description": "Search the fields of discovered workspace documents.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/search/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/search.md", "headings": [ { "id": "find-a-session-name", "level": 2, "text": "Find a session name" }, { "id": "empty-and-invalid-queries", "level": 2, "text": "Empty and invalid queries" } ] }, { "title": "Evaluate in a workspace", "description": "Use the optional Python runtime to inspect a workspace through the native command.", "section": "CLI reference", "url": "https://libtmux.org/en/py/stable/workspace/cli/shell/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/cli/shell.md", "headings": [] }, { "title": "Workspace configuration", "description": "Define the session, windows, panes and commands loaded by the workspace CLI.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/index.md", "headings": [ { "id": "how-configuration-becomes-a-session", "level": 2, "text": "How configuration becomes a session" }, { "id": "configuration-reference", "level": 2, "text": "Configuration reference" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Workspace commands", "description": "Order pane setup and command delivery, Enter handling and delays.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/commands/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/commands.md", "headings": [ { "id": "forms-and-order", "level": 2, "text": "Forms and order" }, { "id": "enter-and-delays", "level": 2, "text": "Enter and delays" }, { "id": "history-and-prompt-readiness", "level": 2, "text": "History and prompt readiness" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Files and directories", "description": "Resolve saved workspace files and the working directories used by panes.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/directories/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/directories.md", "headings": [ { "id": "global-and-local-discovery", "level": 2, "text": "Global and local discovery" }, { "id": "start-directories", "level": 2, "text": "Start directories" }, { "id": "missing-directories-and-bootstrap", "level": 2, "text": "Missing directories and bootstrap" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Workspace environment", "description": "Configure the loader process and the variables available to pane commands.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/environment/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/environment.md", "headings": [ { "id": "expansion-before-launch", "level": 2, "text": "Expansion before launch" }, { "id": "cli-and-runtime-variables", "level": 2, "text": "CLI and runtime variables" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Bootstrap scripts and extensions", "description": "Run a checked bootstrap process before workspace commands.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/hooks/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/hooks.md", "headings": [ { "id": "bootstrap-with-before_script", "level": 2, "text": "Bootstrap with before_script" }, { "id": "python-plugins", "level": 2, "text": "Python plugins" }, { "id": "select-a-workspace-builder", "level": 2, "text": "Select a workspace builder" }, { "id": "pane-readiness", "level": 2, "text": "Pane readiness" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Window layouts", "description": "Arrange panes with tmux layout names or a saved layout.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/layouts/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/layouts.md", "headings": [ { "id": "layout-names-and-options", "level": 2, "text": "Layout names and options" }, { "id": "terminal-dimensions", "level": 2, "text": "Terminal dimensions" }, { "id": "focus-and-indexes", "level": 2, "text": "Focus and indexes" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Pane configuration", "description": "Choose pane commands, launch settings and focus.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/panes/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/panes.md", "headings": [ { "id": "blank-forms", "level": 2, "text": "Blank forms" }, { "id": "pane-keys", "level": 2, "text": "Pane keys" }, { "id": "launch-a-shell-or-type-commands", "level": 2, "text": "Launch a shell or type commands" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Session configuration", "description": "Name a workspace and apply session options and environment.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/session/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/session.md", "headings": [ { "id": "root-keys", "level": 2, "text": "Root keys" }, { "id": "construction-order", "level": 2, "text": "Construction order" }, { "id": "inherited-defaults", "level": 2, "text": "Inherited defaults" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Window configuration", "description": "Set window names, indexes, layouts, options and focus.", "section": "Configuration", "url": "https://libtmux.org/en/py/stable/workspace/configuration/windows/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/configuration/windows.md", "headings": [ { "id": "window-keys", "level": 2, "text": "Window keys" }, { "id": "first-pane-and-later-panes", "level": 2, "text": "First pane and later panes" }, { "id": "index-layout-and-focus", "level": 2, "text": "Index, layout, and focus" }, { "id": "reference-source", "level": 2, "text": "Reference source" } ] }, { "title": "Python workspace examples", "description": "Load tmux workspaces from YAML or JSON with the tmuxp CLI.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/workspace/examples/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/examples.md", "headings": [ { "id": "load-yaml", "level": 2, "text": "Load YAML" }, { "id": "load-json-without-attaching", "level": 2, "text": "Load JSON without attaching" }, { "id": "more-configurations", "level": 2, "text": "More configurations" } ] }, { "title": "Workspace examples", "description": "Start from complete configurations for pane layout, commands and environment.", "section": "Examples", "url": "https://libtmux.org/en/py/stable/workspace/examples/gallery/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/examples/gallery.md", "headings": [ { "id": "2-pane-synchronized", "level": 2, "text": "2-pane-synchronized" }, { "id": "2-pane-vertical", "level": 2, "text": "2-pane-vertical" }, { "id": "3-pane", "level": 2, "text": "3-pane" }, { "id": "4-pane", "level": 2, "text": "4-pane" }, { "id": "blank-panes", "level": 2, "text": "blank-panes" }, { "id": "env-variables", "level": 2, "text": "env-variables" }, { "id": "focus-window-and-panes", "level": 2, "text": "focus-window-and-panes" }, { "id": "main-pane-height-percentage", "level": 2, "text": "main-pane-height-percentage" }, { "id": "main-pane-height", "level": 2, "text": "main-pane-height" }, { "id": "minimal", "level": 2, "text": "minimal" }, { "id": "options", "level": 2, "text": "options" }, { "id": "pane-shell", "level": 2, "text": "pane-shell" }, { "id": "plugin-system", "level": 2, "text": "plugin-system" }, { "id": "session-environment", "level": 2, "text": "session-environment" }, { "id": "shorthands", "level": 2, "text": "shorthands" }, { "id": "skip-send-pane-level", "level": 2, "text": "skip-send-pane-level" }, { "id": "skip-send", "level": 2, "text": "skip-send" }, { "id": "sleep-pane-level", "level": 2, "text": "sleep-pane-level" }, { "id": "sleep-virtualenv", "level": 2, "text": "sleep-virtualenv" }, { "id": "sleep", "level": 2, "text": "sleep" }, { "id": "start-directory", "level": 2, "text": "start-directory" }, { "id": "suppress-history", "level": 2, "text": "suppress-history" }, { "id": "window-index", "level": 2, "text": "window-index" }, { "id": "prerequisites-and-portability", "level": 2, "text": "Prerequisites and portability" } ] }, { "title": "Load a Python workspace", "description": "Install tmuxp, load YAML on a dedicated socket, and inspect the session.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/workspace/guides/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/guides.md", "headings": [ { "id": "describe-the-workspace", "level": 2, "text": "Describe the workspace" }, { "id": "saved-workspaces-and-export", "level": 2, "text": "Saved workspaces and export" } ] }, { "title": "Automate workspace operations", "description": "Run detached commands with explicit inputs and machine-readable results.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/workspace/guides/automation/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/guides/automation.md", "headings": [] }, { "title": "Find saved workspaces", "description": "Resolve explicit files, project directories and saved workspace names.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/workspace/guides/discovery/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/guides/discovery.md", "headings": [ { "id": "global-directories", "level": 2, "text": "Global directories" }, { "id": "project-files", "level": 2, "text": "Project files" } ] }, { "title": "Export and reload a session", "description": "Capture a running session, inspect the document and load a second copy.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/workspace/guides/export-session/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/guides/export-session.md", "headings": [] }, { "title": "Install and load a workspace", "description": "Build the workspace command and load a session on a private tmux socket.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/workspace/guides/installation/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/guides/installation.md", "headings": [ { "id": "create-the-input", "level": 2, "text": "Create the input" }, { "id": "continue", "level": 2, "text": "Continue" } ] }, { "title": "Troubleshoot a workspace", "description": "Find the failed stage before retrying a workspace operation.", "section": "Guides", "url": "https://libtmux.org/en/py/stable/workspace/guides/troubleshooting/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/guides/troubleshooting.md", "headings": [ { "id": "arguments-and-files", "level": 2, "text": "Arguments and files" }, { "id": "configuration-and-commands", "level": 2, "text": "Configuration and commands" }, { "id": "diagnostics-and-remaining-state", "level": 2, "text": "Diagnostics and remaining state" } ] }, { "title": "Python workspace internals", "description": "How tmuxp loads configuration and builds sessions through libtmux.", "section": "Internals", "url": "https://libtmux.org/en/py/stable/workspace/internals/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/internals/index.md", "headings": [ { "id": "builder-pipeline", "level": 2, "text": "Builder pipeline" } ] }, { "title": "Workspace reference generation", "description": "Generate command references from the parser and verify task examples against the CLI.", "section": "Internals", "url": "https://libtmux.org/en/py/stable/workspace/internals/documentation/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/internals/documentation.md", "headings": [ { "id": "keep-syntax-and-behavior-aligned", "level": 2, "text": "Keep syntax and behavior aligned" } ] }, { "title": "Python workspace builder example", "description": "An isolated example of tmuxp internal configuration expansion and session building.", "section": "Internals", "url": "https://libtmux.org/en/py/stable/workspace/internals/examples/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/internals/examples.md", "headings": [ { "id": "build-from-python-data", "level": 2, "text": "Build from Python data" }, { "id": "further-reading", "level": 2, "text": "Further reading" } ] }, { "title": "Python workspace builder behavior", "description": "tmuxp's internal configuration pipeline, builder selection, and session handling.", "section": "Internals", "url": "https://libtmux.org/en/py/stable/workspace/internals/topics/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/internals/topics.md", "headings": [ { "id": "expand-before-building", "level": 2, "text": "Expand before building" }, { "id": "select-a-builder", "level": 2, "text": "Select a builder" } ] }, { "title": "Python workspace internal API", "description": "tmuxp APIs for expanding configuration, building sessions, and exporting layouts.", "section": "Internals", "url": "https://libtmux.org/en/py/stable/workspace/reference/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/reference.md", "headings": [ { "id": "load-and-validate", "level": 2, "text": "Load and validate" }, { "id": "build-and-extend", "level": 2, "text": "Build and extend" }, { "id": "export-and-cli", "level": 2, "text": "Export and CLI" } ] }, { "title": "Runtime and configuration support", "description": "Runtime, configuration and extension requirements for tmuxp.", "section": "Reference", "url": "https://libtmux.org/en/py/stable/workspace/reference/compatibility/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/reference/compatibility.md", "headings": [ { "id": "configuration-and-extensions", "level": 2, "text": "Configuration and extensions" }, { "id": "output-and-errors", "level": 2, "text": "Output and errors" } ] }, { "title": "Exit codes and errors", "description": "Use process status and structured error codes to handle workspace failures.", "section": "Reference", "url": "https://libtmux.org/en/py/stable/workspace/reference/exit-codes/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/reference/exit-codes.md", "headings": [ { "id": "exceptions-to-check", "level": 2, "text": "Exceptions to check" } ] }, { "title": "Output formats", "description": "Read JSON results, NDJSON events and diagnostics from the workspace command.", "section": "Reference", "url": "https://libtmux.org/en/py/stable/workspace/reference/output/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/reference/output.md", "headings": [] }, { "title": "Python workspace topics", "description": "Understand workspace configuration, existing sessions, and tmuxp freeze.", "section": "Documentation", "url": "https://libtmux.org/en/py/stable/workspace/topics/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/topics.md", "headings": [ { "id": "configuration-and-commands", "level": 2, "text": "Configuration and commands" }, { "id": "existing-sessions", "level": 2, "text": "Existing sessions" }, { "id": "export-a-session", "level": 2, "text": "Export a session" } ] }, { "title": "API glossary", "description": "Kinds, modifiers and package labels in the Python API reference.", "section": "API reference", "url": "https://libtmux.org/en/py/stable/reference/glossary/", "markdownUrl": "https://libtmux.org/en/py/stable/reference/glossary.md", "jsonUrl": "https://libtmux.org/en/py/stable/reference/glossary.json", "headings": [ { "id": "symbol-kinds", "level": 2, "text": "Symbol kinds" }, { "id": "class", "level": 3, "text": "class" }, { "id": "function", "level": 3, "text": "function" }, { "id": "method", "level": 3, "text": "method" }, { "id": "property", "level": 3, "text": "property" }, { "id": "attribute", "level": 3, "text": "attribute" }, { "id": "constant", "level": 3, "text": "constant" }, { "id": "exception", "level": 3, "text": "exception" }, { "id": "modifiers", "level": 2, "text": "Modifiers" }, { "id": "classmethod", "level": 3, "text": "classmethod" }, { "id": "async", "level": 3, "text": "async" }, { "id": "inherited", "level": 3, "text": "inherited" }, { "id": "package-context", "level": 2, "text": "Package context" }, { "id": "package", "level": 3, "text": "package" } ] }, { "title": "MCP API glossary", "description": "What MCP tool annotations tell clients about a tool.", "section": "API reference", "url": "https://libtmux.org/en/py/stable/mcp/reference/glossary/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/reference/glossary.md", "jsonUrl": "https://libtmux.org/en/py/stable/mcp/reference/glossary.json", "headings": [ { "id": "mcp-tool-annotations", "level": 2, "text": "MCP tool annotations" }, { "id": "readOnlyHint", "level": 3, "text": "readOnlyHint" }, { "id": "destructiveHint", "level": 3, "text": "destructiveHint" }, { "id": "idempotentHint", "level": 3, "text": "idempotentHint" }, { "id": "openWorldHint", "level": 3, "text": "openWorldHint" }, { "id": "title", "level": 3, "text": "title" }, { "id": "symbol-kinds", "level": 2, "text": "Symbol kinds" }, { "id": "class", "level": 3, "text": "class" }, { "id": "function", "level": 3, "text": "function" }, { "id": "method", "level": 3, "text": "method" }, { "id": "property", "level": 3, "text": "property" }, { "id": "attribute", "level": 3, "text": "attribute" }, { "id": "constant", "level": 3, "text": "constant" }, { "id": "exception", "level": 3, "text": "exception" }, { "id": "modifiers", "level": 2, "text": "Modifiers" }, { "id": "classmethod", "level": 3, "text": "classmethod" }, { "id": "async", "level": 3, "text": "async" }, { "id": "inherited", "level": 3, "text": "inherited" }, { "id": "package-context", "level": 2, "text": "Package context" }, { "id": "package", "level": 3, "text": "package" } ] }, { "title": "API glossary", "description": "Kinds, modifiers and package labels in the Python API reference.", "section": "API reference", "url": "https://libtmux.org/en/py/stable/workspace/reference/glossary/", "markdownUrl": "https://libtmux.org/en/py/stable/workspace/reference/glossary.md", "jsonUrl": "https://libtmux.org/en/py/stable/workspace/reference/glossary.json", "headings": [ { "id": "symbol-kinds", "level": 2, "text": "Symbol kinds" }, { "id": "class", "level": 3, "text": "class" }, { "id": "function", "level": 3, "text": "function" }, { "id": "method", "level": 3, "text": "method" }, { "id": "property", "level": 3, "text": "property" }, { "id": "attribute", "level": 3, "text": "attribute" }, { "id": "constant", "level": 3, "text": "constant" }, { "id": "exception", "level": 3, "text": "exception" }, { "id": "modifiers", "level": 2, "text": "Modifiers" }, { "id": "classmethod", "level": 3, "text": "classmethod" }, { "id": "async", "level": 3, "text": "async" }, { "id": "inherited", "level": 3, "text": "inherited" }, { "id": "package-context", "level": 2, "text": "Package context" }, { "id": "package", "level": 3, "text": "package" } ] }, { "title": "API reference", "description": "190 declarations in the Python reference index. The symbol index also includes their members.", "section": "API reference", "url": "https://libtmux.org/en/py/stable/reference/", "markdownUrl": "https://libtmux.org/en/py/stable/reference/index.md", "symbolIndexUrl": "https://libtmux.org/en/py/stable/reference/tree.json", "headings": [ { "id": "section-server", "level": 2, "text": "Server" }, { "id": "section-session", "level": 2, "text": "Session" }, { "id": "section-window", "level": 2, "text": "Window" }, { "id": "section-pane", "level": 2, "text": "Pane" }, { "id": "section-client", "level": 2, "text": "Client" }, { "id": "section-hooks", "level": 2, "text": "Hooks" }, { "id": "section-options", "level": 2, "text": "Options" }, { "id": "section-options-functions", "level": 2, "text": "Options — Functions" }, { "id": "section-options-constants", "level": 2, "text": "Options — Constants and variables" }, { "id": "section-layout", "level": 2, "text": "Layout and geometry" }, { "id": "section-environment", "level": 2, "text": "Environment" }, { "id": "section-version", "level": 2, "text": "Versions" }, { "id": "section-commands", "level": 2, "text": "Commands" }, { "id": "section-formats", "level": 2, "text": "Formats" }, { "id": "section-queries", "level": 2, "text": "Queries" }, { "id": "section-errors", "level": 2, "text": "Errors" }, { "id": "section-errors-session", "level": 2, "text": "Errors — Session" }, { "id": "section-errors-window", "level": 2, "text": "Errors — Window" }, { "id": "section-errors-pane", "level": 2, "text": "Errors — Pane" }, { "id": "section-testing", "level": 2, "text": "Testing utilities" }, { "id": "section-internal", "level": 2, "text": "Internal" }, { "id": "section-internal-options", "level": 2, "text": "Internal — Options" }, { "id": "section-__unplaced", "level": 2, "text": "Other" } ], "symbols": [ { "id": "libtmux.Server", "name": "Server", "kind": "class", "qualifiedName": "libtmux.Server", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-server/" }, { "id": "libtmux.server._fetch_or_empty", "name": "_fetch_or_empty", "kind": "function", "qualifiedName": "libtmux.server._fetch_or_empty", "namespace": "libtmux.server", "url": "https://libtmux.org/en/py/stable/reference/libtmux-server-_fetch_or_empty/" }, { "id": "libtmux.server._is_daemon_not_up_error", "name": "_is_daemon_not_up_error", "kind": "function", "qualifiedName": "libtmux.server._is_daemon_not_up_error", "namespace": "libtmux.server", "url": "https://libtmux.org/en/py/stable/reference/libtmux-server-_is_daemon_not_up_error/" }, { "id": "libtmux.Session", "name": "Session", "kind": "class", "qualifiedName": "libtmux.Session", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-session/" }, { "id": "libtmux.common.SessionDict", "name": "SessionDict", "kind": "constant", "qualifiedName": "libtmux.common.SessionDict", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-sessiondict/" }, { "id": "libtmux.common.session_check_name", "name": "session_check_name", "kind": "function", "qualifiedName": "libtmux.common.session_check_name", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-session_check_name/" }, { "id": "libtmux.Window", "name": "Window", "kind": "class", "qualifiedName": "libtmux.Window", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-window/" }, { "id": "libtmux.constants.WindowDirection", "name": "WindowDirection", "kind": "class", "qualifiedName": "libtmux.constants.WindowDirection", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-windowdirection/" }, { "id": "libtmux.constants.WINDOW_DIRECTION_FLAG_MAP", "name": "WINDOW_DIRECTION_FLAG_MAP", "kind": "constant", "qualifiedName": "libtmux.constants.WINDOW_DIRECTION_FLAG_MAP", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-window_direction_flag_map/" }, { "id": "libtmux.common.WindowDict", "name": "WindowDict", "kind": "constant", "qualifiedName": "libtmux.common.WindowDict", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-windowdict/" }, { "id": "libtmux.common.WindowOptionDict", "name": "WindowOptionDict", "kind": "constant", "qualifiedName": "libtmux.common.WindowOptionDict", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-windowoptiondict/" }, { "id": "libtmux.Pane", "name": "Pane", "kind": "class", "qualifiedName": "libtmux.Pane", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pane/" }, { "id": "libtmux.constants.PaneDirection", "name": "PaneDirection", "kind": "class", "qualifiedName": "libtmux.constants.PaneDirection", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-panedirection/" }, { "id": "libtmux.constants.PANE_DIRECTION_FLAG_MAP", "name": "PANE_DIRECTION_FLAG_MAP", "kind": "constant", "qualifiedName": "libtmux.constants.PANE_DIRECTION_FLAG_MAP", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-pane_direction_flag_map/" }, { "id": "libtmux.common.PaneDict", "name": "PaneDict", "kind": "constant", "qualifiedName": "libtmux.common.PaneDict", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-panedict/" }, { "id": "libtmux.Client", "name": "Client", "kind": "class", "qualifiedName": "libtmux.Client", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-client/" }, { "id": "libtmux.hooks.HooksMixin", "name": "HooksMixin", "kind": "class", "qualifiedName": "libtmux.hooks.HooksMixin", "namespace": "libtmux.hooks", "url": "https://libtmux.org/en/py/stable/reference/libtmux-hooks-hooksmixin/" }, { "id": "libtmux.constants.HOOK_SCOPE_FLAG_MAP", "name": "HOOK_SCOPE_FLAG_MAP", "kind": "constant", "qualifiedName": "libtmux.constants.HOOK_SCOPE_FLAG_MAP", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-hook_scope_flag_map/" }, { "id": "libtmux.hooks.HookDict", "name": "HookDict", "kind": "constant", "qualifiedName": "libtmux.hooks.HookDict", "namespace": "libtmux.hooks", "url": "https://libtmux.org/en/py/stable/reference/libtmux-hooks-hookdict/" }, { "id": "libtmux.hooks.HookValues", "name": "HookValues", "kind": "constant", "qualifiedName": "libtmux.hooks.HookValues", "namespace": "libtmux.hooks", "url": "https://libtmux.org/en/py/stable/reference/libtmux-hooks-hookvalues/" }, { "id": "libtmux.constants.OptionScope", "name": "OptionScope", "kind": "class", "qualifiedName": "libtmux.constants.OptionScope", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-optionscope/" }, { "id": "libtmux.options.OptionsMixin", "name": "OptionsMixin", "kind": "class", "qualifiedName": "libtmux.options.OptionsMixin", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-optionsmixin/" }, { "id": "libtmux.options.convert_value", "name": "convert_value", "kind": "function", "qualifiedName": "libtmux.options.convert_value", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-convert_value/" }, { "id": "libtmux.options.convert_values", "name": "convert_values", "kind": "function", "qualifiedName": "libtmux.options.convert_values", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-convert_values/" }, { "id": "libtmux.options.explode_arrays", "name": "explode_arrays", "kind": "function", "qualifiedName": "libtmux.options.explode_arrays", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-explode_arrays/" }, { "id": "libtmux.options.explode_complex", "name": "explode_complex", "kind": "function", "qualifiedName": "libtmux.options.explode_complex", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-explode_complex/" }, { "id": "libtmux.options.handle_option_error", "name": "handle_option_error", "kind": "function", "qualifiedName": "libtmux.options.handle_option_error", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-handle_option_error/" }, { "id": "libtmux.options.parse_options_to_dict", "name": "parse_options_to_dict", "kind": "function", "qualifiedName": "libtmux.options.parse_options_to_dict", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-parse_options_to_dict/" }, { "id": "libtmux.options._V", "name": "_V", "kind": "constant", "qualifiedName": "libtmux.options._V", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-_v/" }, { "id": "libtmux.options.CommandAliases", "name": "CommandAliases", "kind": "constant", "qualifiedName": "libtmux.options.CommandAliases", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-commandaliases/" }, { "id": "libtmux.options.ConvertedValue", "name": "ConvertedValue", "kind": "constant", "qualifiedName": "libtmux.options.ConvertedValue", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-convertedvalue/" }, { "id": "libtmux.options.ConvertedValues", "name": "ConvertedValues", "kind": "constant", "qualifiedName": "libtmux.options.ConvertedValues", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-convertedvalues/" }, { "id": "libtmux.options.ExplodedComplexUntypedOptionsDict", "name": "ExplodedComplexUntypedOptionsDict", "kind": "constant", "qualifiedName": "libtmux.options.ExplodedComplexUntypedOptionsDict", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-explodedcomplexuntypedoptionsdict/" }, { "id": "libtmux.options.ExplodedUntypedOptionsDict", "name": "ExplodedUntypedOptionsDict", "kind": "constant", "qualifiedName": "libtmux.options.ExplodedUntypedOptionsDict", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-explodeduntypedoptionsdict/" }, { "id": "libtmux.constants.OPTION_SCOPE_FLAG_MAP", "name": "OPTION_SCOPE_FLAG_MAP", "kind": "constant", "qualifiedName": "libtmux.constants.OPTION_SCOPE_FLAG_MAP", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-option_scope_flag_map/" }, { "id": "libtmux.options.OptionDict", "name": "OptionDict", "kind": "constant", "qualifiedName": "libtmux.options.OptionDict", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-optiondict/" }, { "id": "libtmux.options.TerminalOverride", "name": "TerminalOverride", "kind": "constant", "qualifiedName": "libtmux.options.TerminalOverride", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-terminaloverride/" }, { "id": "libtmux.options.TerminalOverrides", "name": "TerminalOverrides", "kind": "constant", "qualifiedName": "libtmux.options.TerminalOverrides", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-terminaloverrides/" }, { "id": "libtmux.options.UntypedOptionsDict", "name": "UntypedOptionsDict", "kind": "constant", "qualifiedName": "libtmux.options.UntypedOptionsDict", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-untypedoptionsdict/" }, { "id": "libtmux.constants.ResizeAdjustmentDirection", "name": "ResizeAdjustmentDirection", "kind": "class", "qualifiedName": "libtmux.constants.ResizeAdjustmentDirection", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-resizeadjustmentdirection/" }, { "id": "libtmux.constants.RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP", "name": "RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP", "kind": "constant", "qualifiedName": "libtmux.constants.RESIZE_ADJUSTMENT_DIRECTION_FLAG_MAP", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-resize_adjustment_direction_flag_map/" }, { "id": "libtmux.common.EnvironmentMixin", "name": "EnvironmentMixin", "kind": "class", "qualifiedName": "libtmux.common.EnvironmentMixin", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-environmentmixin/" }, { "id": "libtmux.__version__", "name": "__version__", "kind": "constant", "qualifiedName": "libtmux.__version__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__version__/" }, { "id": "libtmux.common.TMUX_MAX_VERSION", "name": "TMUX_MAX_VERSION", "kind": "constant", "qualifiedName": "libtmux.common.TMUX_MAX_VERSION", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_max_version/" }, { "id": "libtmux.common.TMUX_MIN_VERSION", "name": "TMUX_MIN_VERSION", "kind": "constant", "qualifiedName": "libtmux.common.TMUX_MIN_VERSION", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_min_version/" }, { "id": "libtmux.common._no_version_flag_fallback", "name": "_no_version_flag_fallback", "kind": "function", "qualifiedName": "libtmux.common._no_version_flag_fallback", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-_no_version_flag_fallback/" }, { "id": "libtmux.common.get_libtmux_version", "name": "get_libtmux_version", "kind": "function", "qualifiedName": "libtmux.common.get_libtmux_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-get_libtmux_version/" }, { "id": "libtmux.common.get_version", "name": "get_version", "kind": "function", "qualifiedName": "libtmux.common.get_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-get_version/" }, { "id": "libtmux.common.get_version_str", "name": "get_version_str", "kind": "function", "qualifiedName": "libtmux.common.get_version_str", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-get_version_str/" }, { "id": "libtmux.common.has_gt_version", "name": "has_gt_version", "kind": "function", "qualifiedName": "libtmux.common.has_gt_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-has_gt_version/" }, { "id": "libtmux.common.has_gte_version", "name": "has_gte_version", "kind": "function", "qualifiedName": "libtmux.common.has_gte_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-has_gte_version/" }, { "id": "libtmux.common.has_lt_version", "name": "has_lt_version", "kind": "function", "qualifiedName": "libtmux.common.has_lt_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-has_lt_version/" }, { "id": "libtmux.common.has_lte_version", "name": "has_lte_version", "kind": "function", "qualifiedName": "libtmux.common.has_lte_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-has_lte_version/" }, { "id": "libtmux.common.has_minimum_version", "name": "has_minimum_version", "kind": "function", "qualifiedName": "libtmux.common.has_minimum_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-has_minimum_version/" }, { "id": "libtmux.common.has_version", "name": "has_version", "kind": "function", "qualifiedName": "libtmux.common.has_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-has_version/" }, { "id": "libtmux.common.CmdProtocol", "name": "CmdProtocol", "kind": "class", "qualifiedName": "libtmux.common.CmdProtocol", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-cmdprotocol/" }, { "id": "libtmux.common.CmdMixin", "name": "CmdMixin", "kind": "class", "qualifiedName": "libtmux.common.CmdMixin", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-cmdmixin/" }, { "id": "libtmux.common.tmux_cmd", "name": "tmux_cmd", "kind": "class", "qualifiedName": "libtmux.common.tmux_cmd", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-tmux_cmd/" }, { "id": "libtmux.neo._CONTEXT_ONLY_TOKENS", "name": "_CONTEXT_ONLY_TOKENS", "kind": "constant", "qualifiedName": "libtmux.neo._CONTEXT_ONLY_TOKENS", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_context_only_tokens/" }, { "id": "libtmux.neo._SCOPE_OVERRIDES", "name": "_SCOPE_OVERRIDES", "kind": "constant", "qualifiedName": "libtmux.neo._SCOPE_OVERRIDES", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_scope_overrides/" }, { "id": "libtmux.neo._SCOPE_PREFIXES", "name": "_SCOPE_PREFIXES", "kind": "constant", "qualifiedName": "libtmux.neo._SCOPE_PREFIXES", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_scope_prefixes/" }, { "id": "libtmux.neo._UNIVERSAL_TOKENS", "name": "_UNIVERSAL_TOKENS", "kind": "constant", "qualifiedName": "libtmux.neo._UNIVERSAL_TOKENS", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_universal_tokens/" }, { "id": "libtmux.formats.CLIENT_FORMATS", "name": "CLIENT_FORMATS", "kind": "constant", "qualifiedName": "libtmux.formats.CLIENT_FORMATS", "namespace": "libtmux.formats", "url": "https://libtmux.org/en/py/stable/reference/libtmux-formats-client_formats/" }, { "id": "libtmux.neo.FIELD_VERSION", "name": "FIELD_VERSION", "kind": "constant", "qualifiedName": "libtmux.neo.FIELD_VERSION", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-field_version/" }, { "id": "libtmux.formats.FORMAT_SEPARATOR", "name": "FORMAT_SEPARATOR", "kind": "constant", "qualifiedName": "libtmux.formats.FORMAT_SEPARATOR", "namespace": "libtmux.formats", "url": "https://libtmux.org/en/py/stable/reference/libtmux-formats-format_separator/" }, { "id": "libtmux.neo.OutputRaw", "name": "OutputRaw", "kind": "constant", "qualifiedName": "libtmux.neo.OutputRaw", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-outputraw/" }, { "id": "libtmux.neo.OutputsRaw", "name": "OutputsRaw", "kind": "constant", "qualifiedName": "libtmux.neo.OutputsRaw", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-outputsraw/" }, { "id": "libtmux.formats.PANE_FORMATS", "name": "PANE_FORMATS", "kind": "constant", "qualifiedName": "libtmux.formats.PANE_FORMATS", "namespace": "libtmux.formats", "url": "https://libtmux.org/en/py/stable/reference/libtmux-formats-pane_formats/" }, { "id": "libtmux.neo.SCOPES_BY_LIST_CMD", "name": "SCOPES_BY_LIST_CMD", "kind": "constant", "qualifiedName": "libtmux.neo.SCOPES_BY_LIST_CMD", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-scopes_by_list_cmd/" }, { "id": "libtmux.formats.SESSION_FORMATS", "name": "SESSION_FORMATS", "kind": "constant", "qualifiedName": "libtmux.formats.SESSION_FORMATS", "namespace": "libtmux.formats", "url": "https://libtmux.org/en/py/stable/reference/libtmux-formats-session_formats/" }, { "id": "libtmux.formats.WINDOW_FORMATS", "name": "WINDOW_FORMATS", "kind": "constant", "qualifiedName": "libtmux.formats.WINDOW_FORMATS", "namespace": "libtmux.formats", "url": "https://libtmux.org/en/py/stable/reference/libtmux-formats-window_formats/" }, { "id": "libtmux.neo._best_winlink", "name": "_best_winlink", "kind": "function", "qualifiedName": "libtmux.neo._best_winlink", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_best_winlink/" }, { "id": "libtmux.neo._is_target_not_found_error", "name": "_is_target_not_found_error", "kind": "function", "qualifiedName": "libtmux.neo._is_target_not_found_error", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_is_target_not_found_error/" }, { "id": "libtmux.neo._normalize_tmux_version", "name": "_normalize_tmux_version", "kind": "function", "qualifiedName": "libtmux.neo._normalize_tmux_version", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_normalize_tmux_version/" }, { "id": "libtmux.neo._token_scope", "name": "_token_scope", "kind": "function", "qualifiedName": "libtmux.neo._token_scope", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-_token_scope/" }, { "id": "libtmux.neo.fetch_obj", "name": "fetch_obj", "kind": "function", "qualifiedName": "libtmux.neo.fetch_obj", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_obj/" }, { "id": "libtmux.neo.fetch_objs", "name": "fetch_objs", "kind": "function", "qualifiedName": "libtmux.neo.fetch_objs", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-fetch_objs/" }, { "id": "libtmux.neo.get_output_format", "name": "get_output_format", "kind": "function", "qualifiedName": "libtmux.neo.get_output_format", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-get_output_format/" }, { "id": "libtmux.neo.parse_output", "name": "parse_output", "kind": "function", "qualifiedName": "libtmux.neo.parse_output", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-parse_output/" }, { "id": "libtmux.common._query_version", "name": "_query_version", "kind": "function", "qualifiedName": "libtmux.common._query_version", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-_query_version/" }, { "id": "libtmux.common._TmuxVersionUnavailable", "name": "_TmuxVersionUnavailable", "kind": "exception", "qualifiedName": "libtmux.common._TmuxVersionUnavailable", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-_tmuxversionunavailable/" }, { "id": "libtmux.exc.LibTmuxException", "name": "LibTmuxException", "kind": "exception", "qualifiedName": "libtmux.exc.LibTmuxException", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-libtmuxexception/" }, { "id": "libtmux.exc.DeprecatedError", "name": "DeprecatedError", "kind": "exception", "qualifiedName": "libtmux.exc.DeprecatedError", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-deprecatederror/" }, { "id": "libtmux.exc.TmuxCommandNotFound", "name": "TmuxCommandNotFound", "kind": "exception", "qualifiedName": "libtmux.exc.TmuxCommandNotFound", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxcommandnotfound/" }, { "id": "libtmux.exc.NotInsideTmux", "name": "NotInsideTmux", "kind": "exception", "qualifiedName": "libtmux.exc.NotInsideTmux", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-notinsidetmux/" }, { "id": "libtmux.exc.ObjectDoesNotExist", "name": "ObjectDoesNotExist", "kind": "exception", "qualifiedName": "libtmux.exc.ObjectDoesNotExist", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-objectdoesnotexist/" }, { "id": "libtmux.exc.MultipleObjectsReturned", "name": "MultipleObjectsReturned", "kind": "exception", "qualifiedName": "libtmux.exc.MultipleObjectsReturned", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-multipleobjectsreturned/" }, { "id": "libtmux.exc.TmuxObjectDoesNotExist", "name": "TmuxObjectDoesNotExist", "kind": "class", "qualifiedName": "libtmux.exc.TmuxObjectDoesNotExist", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxobjectdoesnotexist/" }, { "id": "libtmux.exc.VersionTooLow", "name": "VersionTooLow", "kind": "exception", "qualifiedName": "libtmux.exc.VersionTooLow", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-versiontoolow/" }, { "id": "libtmux.exc.OptionError", "name": "OptionError", "kind": "exception", "qualifiedName": "libtmux.exc.OptionError", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-optionerror/" }, { "id": "libtmux.exc.UnknownOption", "name": "UnknownOption", "kind": "exception", "qualifiedName": "libtmux.exc.UnknownOption", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-unknownoption/" }, { "id": "libtmux.exc.UnknownColorOption", "name": "UnknownColorOption", "kind": "class", "qualifiedName": "libtmux.exc.UnknownColorOption", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-unknowncoloroption/" }, { "id": "libtmux.exc.InvalidOption", "name": "InvalidOption", "kind": "exception", "qualifiedName": "libtmux.exc.InvalidOption", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-invalidoption/" }, { "id": "libtmux.exc.AmbiguousOption", "name": "AmbiguousOption", "kind": "exception", "qualifiedName": "libtmux.exc.AmbiguousOption", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-ambiguousoption/" }, { "id": "libtmux.exc.WaitTimeout", "name": "WaitTimeout", "kind": "exception", "qualifiedName": "libtmux.exc.WaitTimeout", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-waittimeout/" }, { "id": "libtmux.exc.VariableUnpackingError", "name": "VariableUnpackingError", "kind": "exception", "qualifiedName": "libtmux.exc.VariableUnpackingError", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-variableunpackingerror/" }, { "id": "libtmux.exc.AdjustmentDirectionRequiresAdjustment", "name": "AdjustmentDirectionRequiresAdjustment", "kind": "exception", "qualifiedName": "libtmux.exc.AdjustmentDirectionRequiresAdjustment", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-adjustmentdirectionrequiresadjustment/" }, { "id": "libtmux.exc.RequiresDigitOrPercentage", "name": "RequiresDigitOrPercentage", "kind": "exception", "qualifiedName": "libtmux.exc.RequiresDigitOrPercentage", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-requiresdigitorpercentage/" }, { "id": "libtmux.exc._format_query", "name": "_format_query", "kind": "function", "qualifiedName": "libtmux.exc._format_query", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-_format_query/" }, { "id": "libtmux.common.raise_if_stderr", "name": "raise_if_stderr", "kind": "function", "qualifiedName": "libtmux.common.raise_if_stderr", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-raise_if_stderr/" }, { "id": "libtmux.exc.TmuxSessionExists", "name": "TmuxSessionExists", "kind": "exception", "qualifiedName": "libtmux.exc.TmuxSessionExists", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-tmuxsessionexists/" }, { "id": "libtmux.exc.BadSessionName", "name": "BadSessionName", "kind": "exception", "qualifiedName": "libtmux.exc.BadSessionName", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-badsessionname/" }, { "id": "libtmux.exc.WindowError", "name": "WindowError", "kind": "exception", "qualifiedName": "libtmux.exc.WindowError", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-windowerror/" }, { "id": "libtmux.exc.MultipleActiveWindows", "name": "MultipleActiveWindows", "kind": "exception", "qualifiedName": "libtmux.exc.MultipleActiveWindows", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-multipleactivewindows/" }, { "id": "libtmux.exc.NoActiveWindow", "name": "NoActiveWindow", "kind": "exception", "qualifiedName": "libtmux.exc.NoActiveWindow", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-noactivewindow/" }, { "id": "libtmux.exc.NoWindowsExist", "name": "NoWindowsExist", "kind": "exception", "qualifiedName": "libtmux.exc.NoWindowsExist", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-nowindowsexist/" }, { "id": "libtmux.exc.WindowAdjustmentDirectionRequiresAdjustment", "name": "WindowAdjustmentDirectionRequiresAdjustment", "kind": "exception", "qualifiedName": "libtmux.exc.WindowAdjustmentDirectionRequiresAdjustment", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-windowadjustmentdirectionrequiresadjustment/" }, { "id": "libtmux.exc.PaneError", "name": "PaneError", "kind": "exception", "qualifiedName": "libtmux.exc.PaneError", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-paneerror/" }, { "id": "libtmux.exc.PaneNotFound", "name": "PaneNotFound", "kind": "exception", "qualifiedName": "libtmux.exc.PaneNotFound", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-panenotfound/" }, { "id": "libtmux.exc.PaneAdjustmentDirectionRequiresAdjustment", "name": "PaneAdjustmentDirectionRequiresAdjustment", "kind": "exception", "qualifiedName": "libtmux.exc.PaneAdjustmentDirectionRequiresAdjustment", "namespace": "libtmux.exc", "url": "https://libtmux.org/en/py/stable/reference/libtmux-exc-paneadjustmentdirectionrequiresadjustment/" }, { "id": "libtmux.pytest_plugin.USING_ZSH", "name": "USING_ZSH", "kind": "constant", "qualifiedName": "libtmux.pytest_plugin.USING_ZSH", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-using_zsh/" }, { "id": "libtmux.pytest_plugin._reap_test_server", "name": "_reap_test_server", "kind": "function", "qualifiedName": "libtmux.pytest_plugin._reap_test_server", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-_reap_test_server/" }, { "id": "libtmux.pytest_plugin.clear_env", "name": "clear_env", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.clear_env", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-clear_env/" }, { "id": "libtmux.pytest_plugin.config_file", "name": "config_file", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.config_file", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-config_file/" }, { "id": "libtmux.pytest_plugin.control_mode", "name": "control_mode", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.control_mode", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-control_mode/" }, { "id": "libtmux.pytest_plugin.home_path", "name": "home_path", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.home_path", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-home_path/" }, { "id": "libtmux.pytest_plugin.home_user_name", "name": "home_user_name", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.home_user_name", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-home_user_name/" }, { "id": "libtmux.pytest_plugin.server", "name": "server", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.server", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-server/" }, { "id": "libtmux.pytest_plugin.session", "name": "session", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.session", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-session/" }, { "id": "libtmux.pytest_plugin.session_params", "name": "session_params", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.session_params", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-session_params/" }, { "id": "libtmux.pytest_plugin.TestServer", "name": "TestServer", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.TestServer", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-testserver/" }, { "id": "libtmux.pytest_plugin.user_path", "name": "user_path", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.user_path", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-user_path/" }, { "id": "libtmux.pytest_plugin.zshrc", "name": "zshrc", "kind": "function", "qualifiedName": "libtmux.pytest_plugin.zshrc", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-zshrc/" }, { "id": "libtmux._internal.constants.Hooks", "name": "Hooks", "kind": "class", "qualifiedName": "libtmux._internal.constants.Hooks", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-hooks/" }, { "id": "libtmux._internal.control_mode.ControlMode", "name": "ControlMode", "kind": "class", "qualifiedName": "libtmux._internal.control_mode.ControlMode", "namespace": "libtmux._internal.control_mode", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-control_mode-controlmode/" }, { "id": "libtmux._internal.dataclasses.SkipDefaultFieldsReprMixin", "name": "SkipDefaultFieldsReprMixin", "kind": "class", "qualifiedName": "libtmux._internal.dataclasses.SkipDefaultFieldsReprMixin", "namespace": "libtmux._internal.dataclasses", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-dataclasses-skipdefaultfieldsreprmixin/" }, { "id": "libtmux._internal.query_list.PKRequiredException", "name": "PKRequiredException", "kind": "exception", "qualifiedName": "libtmux._internal.query_list.PKRequiredException", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-pkrequiredexception/" }, { "id": "libtmux._internal.query_list.OpNotFound", "name": "OpNotFound", "kind": "exception", "qualifiedName": "libtmux._internal.query_list.OpNotFound", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-opnotfound/" }, { "id": "libtmux._internal.query_list.QueryList", "name": "QueryList", "kind": "class", "qualifiedName": "libtmux._internal.query_list.QueryList", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-querylist/" }, { "id": "libtmux._internal.sparse_array.SparseArray", "name": "SparseArray", "kind": "class", "qualifiedName": "libtmux._internal.sparse_array.SparseArray", "namespace": "libtmux._internal.sparse_array", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-sparsearray/" }, { "id": "libtmux.__author__", "name": "__author__", "kind": "constant", "qualifiedName": "libtmux.__author__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__author__/" }, { "id": "libtmux.__copyright__", "name": "__copyright__", "kind": "constant", "qualifiedName": "libtmux.__copyright__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__copyright__/" }, { "id": "libtmux.__description__", "name": "__description__", "kind": "constant", "qualifiedName": "libtmux.__description__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__description__/" }, { "id": "libtmux.__about__.__docs__", "name": "__docs__", "kind": "constant", "qualifiedName": "libtmux.__about__.__docs__", "namespace": "libtmux.__about__", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__about__-__docs__/" }, { "id": "libtmux.__email__", "name": "__email__", "kind": "constant", "qualifiedName": "libtmux.__email__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__email__/" }, { "id": "libtmux.__about__.__github__", "name": "__github__", "kind": "constant", "qualifiedName": "libtmux.__about__.__github__", "namespace": "libtmux.__about__", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__about__-__github__/" }, { "id": "libtmux.__license__", "name": "__license__", "kind": "constant", "qualifiedName": "libtmux.__license__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__license__/" }, { "id": "libtmux.__package_name__", "name": "__package_name__", "kind": "constant", "qualifiedName": "libtmux.__package_name__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__package_name__/" }, { "id": "libtmux.__about__.__pypi__", "name": "__pypi__", "kind": "constant", "qualifiedName": "libtmux.__about__.__pypi__", "namespace": "libtmux.__about__", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__about__-__pypi__/" }, { "id": "libtmux.__title__", "name": "__title__", "kind": "constant", "qualifiedName": "libtmux.__title__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__title__/" }, { "id": "libtmux.__about__.__tracker__", "name": "__tracker__", "kind": "constant", "qualifiedName": "libtmux.__about__.__tracker__", "namespace": "libtmux.__about__", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__about__-__tracker__/" }, { "id": "libtmux._internal.constants.HookArray", "name": "HookArray", "kind": "constant", "qualifiedName": "libtmux._internal.constants.HookArray", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-hookarray/" }, { "id": "libtmux._internal.sparse_array.HookArray", "name": "HookArray", "kind": "constant", "qualifiedName": "libtmux._internal.sparse_array.HookArray", "namespace": "libtmux._internal.sparse_array", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-hookarray/" }, { "id": "libtmux._internal.query_list.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux._internal.query_list.logger", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-logger/" }, { "id": "libtmux.client.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.client.logger", "namespace": "libtmux.client", "url": "https://libtmux.org/en/py/stable/reference/libtmux-client-logger/" }, { "id": "libtmux.common.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.common.logger", "namespace": "libtmux.common", "url": "https://libtmux.org/en/py/stable/reference/libtmux-common-logger/" }, { "id": "libtmux.hooks.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.hooks.logger", "namespace": "libtmux.hooks", "url": "https://libtmux.org/en/py/stable/reference/libtmux-hooks-logger/" }, { "id": "libtmux.neo.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.neo.logger", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-logger/" }, { "id": "libtmux.options.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.options.logger", "namespace": "libtmux.options", "url": "https://libtmux.org/en/py/stable/reference/libtmux-options-logger/" }, { "id": "libtmux.pane.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.pane.logger", "namespace": "libtmux.pane", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pane-logger/" }, { "id": "libtmux.pytest_plugin.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.pytest_plugin.logger", "namespace": "libtmux.pytest_plugin", "url": "https://libtmux.org/en/py/stable/reference/libtmux-pytest_plugin-logger/" }, { "id": "libtmux.server.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.server.logger", "namespace": "libtmux.server", "url": "https://libtmux.org/en/py/stable/reference/libtmux-server-logger/" }, { "id": "libtmux.session.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.session.logger", "namespace": "libtmux.session", "url": "https://libtmux.org/en/py/stable/reference/libtmux-session-logger/" }, { "id": "libtmux.window.logger", "name": "logger", "kind": "constant", "qualifiedName": "libtmux.window.logger", "namespace": "libtmux.window", "url": "https://libtmux.org/en/py/stable/reference/libtmux-window-logger/" }, { "id": "libtmux._internal.query_list.LOOKUP_NAME_MAP", "name": "LOOKUP_NAME_MAP", "kind": "constant", "qualifiedName": "libtmux._internal.query_list.LOOKUP_NAME_MAP", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_name_map/" }, { "id": "libtmux._internal.query_list.no_arg", "name": "no_arg", "kind": "constant", "qualifiedName": "libtmux._internal.query_list.no_arg", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-no_arg/" }, { "id": "libtmux._internal.types.StrPath", "name": "StrPath", "kind": "constant", "qualifiedName": "libtmux._internal.types.StrPath", "namespace": "libtmux._internal.types", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-types-strpath/" }, { "id": "libtmux._internal.constants.T", "name": "T", "kind": "constant", "qualifiedName": "libtmux._internal.constants.T", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-t/" }, { "id": "libtmux._internal.query_list.T", "name": "T", "kind": "constant", "qualifiedName": "libtmux._internal.query_list.T", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-t/" }, { "id": "libtmux._internal.sparse_array.T", "name": "T", "kind": "constant", "qualifiedName": "libtmux._internal.sparse_array.T", "namespace": "libtmux._internal.sparse_array", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-t/" }, { "id": "libtmux._internal.constants.TerminalFeatures", "name": "TerminalFeatures", "kind": "constant", "qualifiedName": "libtmux._internal.constants.TerminalFeatures", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-terminalfeatures/" }, { "id": "libtmux._internal.env.TMUX", "name": "TMUX", "kind": "constant", "qualifiedName": "libtmux._internal.env.TMUX", "namespace": "libtmux._internal.env", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-tmux/" }, { "id": "libtmux._internal.env.TMUX_PANE", "name": "TMUX_PANE", "kind": "constant", "qualifiedName": "libtmux._internal.env.TMUX_PANE", "namespace": "libtmux._internal.env", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-tmux_pane/" }, { "id": "libtmux._internal.sparse_array.is_sparse_array_list", "name": "is_sparse_array_list", "kind": "function", "qualifiedName": "libtmux._internal.sparse_array.is_sparse_array_list", "namespace": "libtmux._internal.sparse_array", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-sparse_array-is_sparse_array_list/" }, { "id": "libtmux._internal.query_list.keygetter", "name": "keygetter", "kind": "function", "qualifiedName": "libtmux._internal.query_list.keygetter", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-keygetter/" }, { "id": "libtmux._internal.query_list.lookup_contains", "name": "lookup_contains", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_contains", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_contains/" }, { "id": "libtmux._internal.query_list.lookup_endswith", "name": "lookup_endswith", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_endswith", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_endswith/" }, { "id": "libtmux._internal.query_list.lookup_exact", "name": "lookup_exact", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_exact", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_exact/" }, { "id": "libtmux._internal.query_list.lookup_icontains", "name": "lookup_icontains", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_icontains", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_icontains/" }, { "id": "libtmux._internal.query_list.lookup_iendswith", "name": "lookup_iendswith", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_iendswith", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iendswith/" }, { "id": "libtmux._internal.query_list.lookup_iexact", "name": "lookup_iexact", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_iexact", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iexact/" }, { "id": "libtmux._internal.query_list.lookup_in", "name": "lookup_in", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_in", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_in/" }, { "id": "libtmux._internal.query_list.lookup_iregex", "name": "lookup_iregex", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_iregex", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_iregex/" }, { "id": "libtmux._internal.query_list.lookup_istartswith", "name": "lookup_istartswith", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_istartswith", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_istartswith/" }, { "id": "libtmux._internal.query_list.lookup_nin", "name": "lookup_nin", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_nin", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_nin/" }, { "id": "libtmux._internal.query_list.lookup_regex", "name": "lookup_regex", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_regex", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_regex/" }, { "id": "libtmux._internal.query_list.lookup_startswith", "name": "lookup_startswith", "kind": "function", "qualifiedName": "libtmux._internal.query_list.lookup_startswith", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-lookup_startswith/" }, { "id": "libtmux._internal.env.pane_id_from_env", "name": "pane_id_from_env", "kind": "function", "qualifiedName": "libtmux._internal.env.pane_id_from_env", "namespace": "libtmux._internal.env", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-pane_id_from_env/" }, { "id": "libtmux._internal.query_list.parse_lookup", "name": "parse_lookup", "kind": "function", "qualifiedName": "libtmux._internal.query_list.parse_lookup", "namespace": "libtmux._internal.query_list", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-query_list-parse_lookup/" }, { "id": "libtmux._internal.env.resolve_env", "name": "resolve_env", "kind": "function", "qualifiedName": "libtmux._internal.env.resolve_env", "namespace": "libtmux._internal.env", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-resolve_env/" }, { "id": "libtmux._internal.env.socket_path_from_env", "name": "socket_path_from_env", "kind": "function", "qualifiedName": "libtmux._internal.env.socket_path_from_env", "namespace": "libtmux._internal.env", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-env-socket_path_from_env/" }, { "id": "libtmux._internal.constants.ServerOptions", "name": "ServerOptions", "kind": "class", "qualifiedName": "libtmux._internal.constants.ServerOptions", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-serveroptions/" }, { "id": "libtmux._internal.constants.SessionOptions", "name": "SessionOptions", "kind": "class", "qualifiedName": "libtmux._internal.constants.SessionOptions", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-sessionoptions/" }, { "id": "libtmux._internal.constants.WindowOptions", "name": "WindowOptions", "kind": "class", "qualifiedName": "libtmux._internal.constants.WindowOptions", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-windowoptions/" }, { "id": "libtmux._internal.constants.PaneOptions", "name": "PaneOptions", "kind": "class", "qualifiedName": "libtmux._internal.constants.PaneOptions", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-paneoptions/" }, { "id": "libtmux._internal.constants.Options", "name": "Options", "kind": "class", "qualifiedName": "libtmux._internal.constants.Options", "namespace": "libtmux._internal.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-_internal-constants-options/" }, { "id": "libtmux.constants._DefaultOptionScope", "name": "_DefaultOptionScope", "kind": "class", "qualifiedName": "libtmux.constants._DefaultOptionScope", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-_defaultoptionscope/" }, { "id": "libtmux.neo.Obj", "name": "Obj", "kind": "class", "qualifiedName": "libtmux.neo.Obj", "namespace": "libtmux.neo", "url": "https://libtmux.org/en/py/stable/reference/libtmux-neo-obj/" }, { "id": "libtmux.__all__", "name": "__all__", "kind": "constant", "qualifiedName": "libtmux.__all__", "namespace": "libtmux", "url": "https://libtmux.org/en/py/stable/reference/libtmux-__all__/" }, { "id": "libtmux.constants.DEFAULT_OPTION_SCOPE", "name": "DEFAULT_OPTION_SCOPE", "kind": "constant", "qualifiedName": "libtmux.constants.DEFAULT_OPTION_SCOPE", "namespace": "libtmux.constants", "url": "https://libtmux.org/en/py/stable/reference/libtmux-constants-default_option_scope/" } ] }, { "title": "Tools", "description": "Browse the operations the server exposes to MCP clients. Use the registered name and arguments when sending a tools/call request.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools.md", "headings": [ { "id": "tools-server", "level": 2, "text": "Server5 tools" }, { "id": "tools-session", "level": 2, "text": "Session5 tools" }, { "id": "tools-window", "level": 2, "text": "Window9 tools" }, { "id": "tools-pane", "level": 2, "text": "Pane18 tools" }, { "id": "tools-buffers", "level": 2, "text": "Buffers4 tools" }, { "id": "tools-hooks", "level": 2, "text": "Hooks2 tools" }, { "id": "tools-options-and-environment", "level": 2, "text": "Options and environment4 tools" }, { "id": "tools-coordination", "level": 2, "text": "Coordination2 tools" }, { "id": "tools-other-tools", "level": 2, "text": "Other tools5 tools" }, { "id": "resources", "level": 2, "text": "rResources" }, { "id": "resource-templates", "level": 2, "text": "RResource templates" }, { "id": "prompts", "level": 2, "text": "PPrompts" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "call_read_tools_batch", "description": "Call several inspect tools serially and return per-tool results.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/call_read_tools_batch/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/call_read_tools_batch.md", "headings": [ { "id": "mcp.tool.call_read_tools_batch.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.call_read_tools_batch.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.call_read_tools_batch.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.call_read_tools_batch.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/batch_tools.py", "line": 277 } }, { "title": "capture_pane", "description": "Capture the visible contents of a tmux pane (terminal scrollback).", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/capture_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/capture_pane.md", "headings": [ { "id": "mcp.tool.capture_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.capture_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.capture_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.capture_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 101 } }, { "title": "capture_since", "description": "Capture new tmux terminal scrollback since the previous cursor.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/capture_since/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/capture_since.md", "headings": [ { "id": "mcp.tool.capture_since.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.capture_since.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.capture_since.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.capture_since.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 106 } }, { "title": "clear_pane", "description": "Clear the contents of a tmux pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/clear_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/clear_pane.md", "headings": [ { "id": "mcp.tool.clear_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.clear_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.clear_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.clear_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 141 } }, { "title": "create_session", "description": "Create a new tmux session.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/create_session/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/create_session.md", "headings": [ { "id": "mcp.tool.create_session.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.create_session.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.create_session.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.create_session.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/server_tools.py", "line": 372 } }, { "title": "create_window", "description": "Create a new window in a tmux session.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/create_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/create_window.md", "headings": [ { "id": "mcp.tool.create_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.create_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.create_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.create_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/session_tools.py", "line": 364 } }, { "title": "delete_buffer", "description": "Delete an MCP-owned buffer.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/delete_buffer/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/delete_buffer.md", "headings": [ { "id": "mcp.tool.delete_buffer.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.delete_buffer.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.delete_buffer.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.delete_buffer.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/buffer_tools.py", "line": 401 } }, { "title": "display_message", "description": "Read tmux variables against a target and return the substituted text.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/display_message/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/display_message.md", "headings": [ { "id": "mcp.tool.display_message.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.display_message.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.display_message.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.display_message.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 179 } }, { "title": "enter_copy_mode", "description": "Enter copy mode in a tmux pane, optionally scrolling up.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/enter_copy_mode/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/enter_copy_mode.md", "headings": [ { "id": "mcp.tool.enter_copy_mode.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.enter_copy_mode.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.enter_copy_mode.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.enter_copy_mode.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 184 } }, { "title": "exit_copy_mode", "description": "Exit copy mode in a tmux pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/exit_copy_mode/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/exit_copy_mode.md", "headings": [ { "id": "mcp.tool.exit_copy_mode.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.exit_copy_mode.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.exit_copy_mode.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.exit_copy_mode.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 189 } }, { "title": "find_pane_by_position", "description": "Find the pane occupying a corner of a tmux window.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/find_pane_by_position/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/find_pane_by_position.md", "headings": [ { "id": "mcp.tool.find_pane_by_position.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.find_pane_by_position.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.find_pane_by_position.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.find_pane_by_position.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 136 } }, { "title": "get_pane_info", "description": "Get detailed information about a tmux pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/get_pane_info/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/get_pane_info.md", "headings": [ { "id": "mcp.tool.get_pane_info.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.get_pane_info.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.get_pane_info.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.get_pane_info.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 131 } }, { "title": "get_server_info", "description": "Get information about the tmux server.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/get_server_info/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/get_server_info.md", "headings": [ { "id": "mcp.tool.get_server_info.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.get_server_info.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.get_server_info.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.get_server_info.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/server_tools.py", "line": 382 } }, { "title": "get_session_info", "description": "Return metadata for a single tmux session (ID, name, window count, activity).", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/get_session_info/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/get_session_info.md", "headings": [ { "id": "mcp.tool.get_session_info.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.get_session_info.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.get_session_info.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.get_session_info.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/session_tools.py", "line": 359 } }, { "title": "get_window_info", "description": "Return metadata for a single tmux window (ID, name, layout, dimensions).", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/get_window_info/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/get_window_info.md", "headings": [ { "id": "mcp.tool.get_window_info.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.get_window_info.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.get_window_info.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.get_window_info.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 507 } }, { "title": "kill_pane", "description": "Kill (close) a tmux pane. Requires exact pane_id (e.g. '%5').", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/kill_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/kill_pane.md", "headings": [ { "id": "mcp.tool.kill_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.kill_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.kill_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.kill_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 116 } }, { "title": "kill_server", "description": "Kill the tmux server and all its sessions.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/kill_server/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/kill_server.md", "headings": [ { "id": "mcp.tool.kill_server.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.kill_server.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.kill_server.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.kill_server.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/server_tools.py", "line": 377 } }, { "title": "kill_session", "description": "Kill a tmux session.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/kill_session/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/kill_session.md", "headings": [ { "id": "mcp.tool.kill_session.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.kill_session.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.kill_session.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.kill_session.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/session_tools.py", "line": 374 } }, { "title": "kill_window", "description": "Kill (close) a tmux window. Requires exact window_id (e.g. '@3').", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/kill_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/kill_window.md", "headings": [ { "id": "mcp.tool.kill_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.kill_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.kill_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.kill_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 522 } }, { "title": "list_panes", "description": "List tmux panes (terminal multiplexer splits) in a window, session, or server.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/list_panes/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/list_panes.md", "headings": [ { "id": "mcp.tool.list_panes.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.list_panes.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.list_panes.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.list_panes.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 501 } }, { "title": "list_servers", "description": "Discover live tmux servers under the current user's $TMUX_TMPDIR.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/list_servers/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/list_servers.md", "headings": [ { "id": "mcp.tool.list_servers.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.list_servers.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.list_servers.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.list_servers.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/server_tools.py", "line": 367 } }, { "title": "list_sessions", "description": "List tmux sessions (terminal workspaces) on a tmux server.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/list_sessions/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/list_sessions.md", "headings": [ { "id": "mcp.tool.list_sessions.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.list_sessions.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.list_sessions.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.list_sessions.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/server_tools.py", "line": 362 } }, { "title": "list_windows", "description": "List tmux windows (terminal tabs) in a session, or across the server.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/list_windows/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/list_windows.md", "headings": [ { "id": "mcp.tool.list_windows.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.list_windows.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.list_windows.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.list_windows.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/session_tools.py", "line": 353 } }, { "title": "load_buffer", "description": "Load text into a new agent-namespaced tmux paste buffer.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/load_buffer/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/load_buffer.md", "headings": [ { "id": "mcp.tool.load_buffer.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.load_buffer.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.load_buffer.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.load_buffer.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/buffer_tools.py", "line": 386 } }, { "title": "move_window", "description": "Move a window to a different index or session.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/move_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/move_window.md", "headings": [ { "id": "mcp.tool.move_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.move_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.move_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.move_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 537 } }, { "title": "paste_buffer", "description": "Paste an MCP-owned buffer into a pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/paste_buffer/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/paste_buffer.md", "headings": [ { "id": "mcp.tool.paste_buffer.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.paste_buffer.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.paste_buffer.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.paste_buffer.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/buffer_tools.py", "line": 391 } }, { "title": "paste_text", "description": "Paste multi-line text into a pane using tmux paste buffers.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/paste_text/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/paste_text.md", "headings": [ { "id": "mcp.tool.paste_text.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.paste_text.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.paste_text.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.paste_text.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 194 } }, { "title": "pipe_pane", "description": "Log a pane's live output to a file (or stop an active log).", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/pipe_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/pipe_pane.md", "headings": [ { "id": "mcp.tool.pipe_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.pipe_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.pipe_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.pipe_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 174 } }, { "title": "rename_session", "description": "Rename a tmux session.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/rename_session/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/rename_session.md", "headings": [ { "id": "mcp.tool.rename_session.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.rename_session.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.rename_session.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.rename_session.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/session_tools.py", "line": 369 } }, { "title": "rename_window", "description": "Rename a tmux window.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/rename_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/rename_window.md", "headings": [ { "id": "mcp.tool.rename_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.rename_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.rename_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.rename_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 517 } }, { "title": "resize_pane", "description": "Resize a tmux pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/resize_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/resize_pane.md", "headings": [ { "id": "mcp.tool.resize_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.resize_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.resize_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.resize_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 111 } }, { "title": "resize_window", "description": "Resize a tmux window.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/resize_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/resize_window.md", "headings": [ { "id": "mcp.tool.resize_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.resize_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.resize_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.resize_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 532 } }, { "title": "respawn_pane", "description": "Restart a pane's process in place, preserving pane_id and layout.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/respawn_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/respawn_pane.md", "headings": [ { "id": "mcp.tool.respawn_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.respawn_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.respawn_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.respawn_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 121 } }, { "title": "run_command", "description": "Run a shell command in a pane, wait for completion, and capture output.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/run_command/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/run_command.md", "headings": [ { "id": "mcp.tool.run_command.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.run_command.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.run_command.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.run_command.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 96 } }, { "title": "search_panes", "description": "Search visible terminal text across all tmux panes.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/search_panes/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/search_panes.md", "headings": [ { "id": "mcp.tool.search_panes.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.search_panes.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.search_panes.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.search_panes.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 146 } }, { "title": "select_layout", "description": "Set the layout of a tmux window.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/select_layout/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/select_layout.md", "headings": [ { "id": "mcp.tool.select_layout.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.select_layout.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.select_layout.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.select_layout.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 527 } }, { "title": "select_pane", "description": "Select (focus) a tmux pane by ID or direction.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/select_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/select_pane.md", "headings": [ { "id": "mcp.tool.select_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.select_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.select_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.select_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 164 } }, { "title": "select_window", "description": "Select (focus) a tmux window by ID, index, or direction.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/select_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/select_window.md", "headings": [ { "id": "mcp.tool.select_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.select_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.select_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.select_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/session_tools.py", "line": 379 } }, { "title": "send_keys", "description": "Send keys (commands or text) to a tmux pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/send_keys/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/send_keys.md", "headings": [ { "id": "mcp.tool.send_keys.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.send_keys.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.send_keys.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.send_keys.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 82 } }, { "title": "send_keys_batch", "description": "Send an ordered batch of raw key/text operations to tmux panes.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/send_keys_batch/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/send_keys_batch.md", "headings": [ { "id": "mcp.tool.send_keys_batch.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.send_keys_batch.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.send_keys_batch.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.send_keys_batch.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 87 } }, { "title": "set_environment", "description": "Set a tmux environment variable.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/set_environment/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/set_environment.md", "headings": [ { "id": "mcp.tool.set_environment.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.set_environment.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.set_environment.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.set_environment.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/env_tools.py", "line": 130 } }, { "title": "set_option", "description": "Set a tmux option value.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/set_option/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/set_option.md", "headings": [ { "id": "mcp.tool.set_option.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.set_option.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.set_option.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.set_option.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/option_tools.py", "line": 158 } }, { "title": "set_pane_title", "description": "Set the title of a tmux pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/set_pane_title/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/set_pane_title.md", "headings": [ { "id": "mcp.tool.set_pane_title.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.set_pane_title.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.set_pane_title.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.set_pane_title.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 126 } }, { "title": "show_buffer", "description": "Read back the contents of an MCP-owned buffer.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/show_buffer/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/show_buffer.md", "headings": [ { "id": "mcp.tool.show_buffer.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.show_buffer.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.show_buffer.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.show_buffer.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/buffer_tools.py", "line": 396 } }, { "title": "show_environment", "description": "Show tmux environment variables.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/show_environment/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/show_environment.md", "headings": [ { "id": "mcp.tool.show_environment.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.show_environment.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.show_environment.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.show_environment.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/env_tools.py", "line": 125 } }, { "title": "show_hook", "description": "Look up a specific tmux hook by name.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/show_hook/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/show_hook.md", "headings": [ { "id": "mcp.tool.show_hook.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.show_hook.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.show_hook.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.show_hook.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/hook_tools.py", "line": 248 } }, { "title": "show_hooks", "description": "List configured tmux hooks at the given scope.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/show_hooks/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/show_hooks.md", "headings": [ { "id": "mcp.tool.show_hooks.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.show_hooks.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.show_hooks.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.show_hooks.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/hook_tools.py", "line": 243 } }, { "title": "show_option", "description": "Show a tmux option value.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/show_option/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/show_option.md", "headings": [ { "id": "mcp.tool.show_option.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.show_option.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.show_option.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.show_option.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/option_tools.py", "line": 153 } }, { "title": "signal_channel", "description": "Signal a tmux wait-for channel, waking blocked waiters.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/signal_channel/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/signal_channel.md", "headings": [ { "id": "mcp.tool.signal_channel.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.signal_channel.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.signal_channel.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.signal_channel.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/wait_for_tools.py", "line": 327 } }, { "title": "snapshot_pane", "description": "Snapshot a tmux pane: visible terminal output, cursor, mode, scroll.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/snapshot_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/snapshot_pane.md", "headings": [ { "id": "mcp.tool.snapshot_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.snapshot_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.snapshot_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.snapshot_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 158 } }, { "title": "split_window", "description": "Split a tmux window to create a new pane.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/split_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/split_window.md", "headings": [ { "id": "mcp.tool.split_window.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.split_window.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.split_window.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.split_window.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/window_tools.py", "line": 512 } }, { "title": "swap_pane", "description": "Swap the positions of two panes.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/swap_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/swap_pane.md", "headings": [ { "id": "mcp.tool.swap_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.swap_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.swap_pane.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.swap_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 169 } }, { "title": "wait_for_channel", "description": "Block until a tmux wait-for channel is signalled.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/wait_for_channel/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/wait_for_channel.md", "headings": [ { "id": "mcp.tool.wait_for_channel.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.wait_for_channel.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.wait_for_channel.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.wait_for_channel.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/wait_for_tools.py", "line": 322 } }, { "title": "wait_for_text", "description": "Wait for NEW output in a tmux pane, then return.", "section": "Python MCP tools", "url": "https://libtmux.org/en/py/stable/mcp/tools/wait_for_text/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/tools/wait_for_text.md", "headings": [ { "id": "mcp.tool.wait_for_text.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.tool.wait_for_text.result", "level": 2, "text": "Result" }, { "id": "mcp.tool.wait_for_text.annotations", "level": 2, "text": "Annotations" }, { "id": "mcp.tool.wait_for_text.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760", "file": "src/libtmux_mcp/tools/pane_tools/__init__.py", "line": 153 } }, { "title": "Prompts", "description": "Browse the reusable workflows the server provides through prompts/get. Each prompt documents its arguments and the messages it returns.", "section": "Python MCP prompts", "url": "https://libtmux.org/en/py/stable/mcp/prompts/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/prompts.md", "headings": [ { "id": "prompts-workflows", "level": 2, "text": "Workflows4 prompts" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "build_dev_workspace", "description": "Construct a simple 3-pane development session.", "section": "Python MCP prompts", "url": "https://libtmux.org/en/py/stable/mcp/prompts/build_dev_workspace/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/prompts/build_dev_workspace.md", "headings": [ { "id": "mcp.prompt.build_dev_workspace.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.prompt.build_dev_workspace.result", "level": 2, "text": "Result" }, { "id": "mcp.prompt.build_dev_workspace.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "diagnose_failing_pane", "description": "Gather pane context and propose a root-cause hypothesis.", "section": "Python MCP prompts", "url": "https://libtmux.org/en/py/stable/mcp/prompts/diagnose_failing_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/prompts/diagnose_failing_pane.md", "headings": [ { "id": "mcp.prompt.diagnose_failing_pane.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.prompt.diagnose_failing_pane.result", "level": 2, "text": "Result" }, { "id": "mcp.prompt.diagnose_failing_pane.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "interrupt_gracefully", "description": "Interrupt a running command and verify the prompt returned.", "section": "Python MCP prompts", "url": "https://libtmux.org/en/py/stable/mcp/prompts/interrupt_gracefully/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/prompts/interrupt_gracefully.md", "headings": [ { "id": "mcp.prompt.interrupt_gracefully.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.prompt.interrupt_gracefully.result", "level": 2, "text": "Result" }, { "id": "mcp.prompt.interrupt_gracefully.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "run_and_wait", "description": "Run a shell command in a tmux pane and wait for completion.", "section": "Python MCP prompts", "url": "https://libtmux.org/en/py/stable/mcp/prompts/run_and_wait/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/prompts/run_and_wait.md", "headings": [ { "id": "mcp.prompt.run_and_wait.parameters", "level": 2, "text": "Arguments" }, { "id": "mcp.prompt.run_and_wait.result", "level": 2, "text": "Result" }, { "id": "mcp.prompt.run_and_wait.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "Resources", "description": "Browse the data the server exposes through resources/read. Resource templates describe URI patterns and the variables used to select a resource.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources.md", "headings": [ { "id": "resources-resource-templates", "level": 2, "text": "Resource templates6 objects" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "get_pane", "description": "Get details of a specific pane.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_pane/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_pane.md", "headings": [ { "id": "mcp.resource-template.tmux://panes/{pane_id}{?socket_name}.parameters", "level": 2, "text": "URI parameters" }, { "id": "mcp.resource-template.tmux://panes/{pane_id}{?socket_name}.result", "level": 2, "text": "Result" }, { "id": "mcp.resource-template.tmux://panes/{pane_id}{?socket_name}.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "get_pane_content", "description": "Capture and return the content of a pane.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_pane_content/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_pane_content.md", "headings": [ { "id": "mcp.resource-template.tmux://panes/{pane_id}/content{?socket_name}.parameters", "level": 2, "text": "URI parameters" }, { "id": "mcp.resource-template.tmux://panes/{pane_id}/content{?socket_name}.result", "level": 2, "text": "Result" }, { "id": "mcp.resource-template.tmux://panes/{pane_id}/content{?socket_name}.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "get_session", "description": "Get details of a specific tmux session.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_session/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_session.md", "headings": [ { "id": "mcp.resource-template.tmux://sessions/{session_name}{?socket_name}.parameters", "level": 2, "text": "URI parameters" }, { "id": "mcp.resource-template.tmux://sessions/{session_name}{?socket_name}.result", "level": 2, "text": "Result" }, { "id": "mcp.resource-template.tmux://sessions/{session_name}{?socket_name}.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "get_session_windows", "description": "List all windows in a tmux session.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_session_windows/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_session_windows.md", "headings": [ { "id": "mcp.resource-template.tmux://sessions/{session_name}/windows{?socket_name}.parameters", "level": 2, "text": "URI parameters" }, { "id": "mcp.resource-template.tmux://sessions/{session_name}/windows{?socket_name}.result", "level": 2, "text": "Result" }, { "id": "mcp.resource-template.tmux://sessions/{session_name}/windows{?socket_name}.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "get_sessions", "description": "List all tmux sessions.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_sessions/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_sessions.md", "headings": [ { "id": "mcp.resource-template.tmux://sessions{?socket_name}.parameters", "level": 2, "text": "URI parameters" }, { "id": "mcp.resource-template.tmux://sessions{?socket_name}.result", "level": 2, "text": "Result" }, { "id": "mcp.resource-template.tmux://sessions{?socket_name}.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } }, { "title": "get_window", "description": "Get details of a specific window in a session.", "section": "Python MCP resources", "url": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_window/", "markdownUrl": "https://libtmux.org/en/py/stable/mcp/resources/templates/get_window.md", "headings": [ { "id": "mcp.resource-template.tmux://sessions/{session_name}/windows/{window_index}{?socket_name}.parameters", "level": 2, "text": "URI parameters" }, { "id": "mcp.resource-template.tmux://sessions/{session_name}/windows/{window_index}{?socket_name}.result", "level": 2, "text": "Result" }, { "id": "mcp.resource-template.tmux://sessions/{session_name}/windows/{window_index}{?socket_name}.schemas", "level": 2, "text": "Protocol data" } ], "source": { "repo": "tmux-python/libtmux-mcp", "revision": "4daddc0dfca96c43bf521d818bf91564e1434760", "extractedRevision": "4daddc0dfca96c43bf521d818bf91564e1434760" } } ] }