{ "name": "libtmux for PowerShell", "url": "https://libtmux.org/en/powershell/latest/", "description": "Guides, examples and API reference for LibTmux.", "sourceRepository": "https://github.com/libtmux/libtmux-powershell", "agentEntrypoints": { "manifest": "/en/powershell/latest/docs.json", "llms": "/en/powershell/latest/llms.txt", "llmsFull": "/en/powershell/latest/llms-full.txt", "inventory": "/en/powershell/latest/objects.inv", "inventoryFull": "/en/objects-full.inv", "targets": "/en/powershell/latest/targets.json" }, "ports": [ { "slug": "powershell", "name": "PowerShell", "language": "PowerShell", "referenceKind": "model", "package": "LibTmux", "reference": "/en/powershell/latest/reference/", "products": [ { "slug": "workspace", "name": "Workspace Manager", "availability": "available", "inDevelopment": true, "support": "concept", "supportDescription": "A working example of the core library. It can change without notice.", "cli": null, "cliAvailability": null, "url": "/en/powershell/latest/workspace/", "reference": "/en/powershell/latest/workspace/reference/", "source": { "product": "workspace", "package": "LibTmux.Workspace", "version": "0.1.0", "repo": "libtmux/libtmux-powershell", "revision": "06233d3c99b40a5bce966c9e1d358f346ff4de55", "extractedRevision": "fa5e60c48b312eb0d957d02aad9edcfc50cff359" } }, { "slug": "mcp", "name": "MCP", "availability": "unpublished", "inDevelopment": false, "url": "/en/powershell/latest/mcp/", "reference": null, "protocol": null } ], "extracted": { "symbols": 66, "extractor": "@libtmux/api-model@0.0.1 (PowerShell command metadata + Roslyn + PlatyPS + MAML v1)", "inventory": "/en/powershell/latest/objects.inv" }, "documentation": [ { "id": "core", "name": "Library", "kind": "core", "availability": "available", "url": "/en/powershell/latest/core/" }, { "id": "workspace", "name": "Workspace Manager", "kind": "product", "availability": "available", "url": "/en/powershell/latest/workspace/" } ] } ], "pages": [ { "title": "Guides", "description": "Guides for LibTmux.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/index.md", "headings": [] }, { "title": "Capture, refresh and raw commands", "description": "Capture, refresh and raw commands: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/capture/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/capture/index.md", "headings": [ { "id": "capture-text", "level": 2, "text": "Capture text" }, { "id": "refresh-captured-metadata", "level": 2, "text": "Refresh captured metadata" }, { "id": "run-literal-tmux-arguments", "level": 2, "text": "Run literal tmux arguments" } ] }, { "title": "Inspect attached clients", "description": "Inspect attached clients: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/clients/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/clients/index.md", "headings": [] }, { "title": "Commands and control clients", "description": "Commands and control clients: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/commands/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/commands/index.md", "headings": [ { "id": "execute-an-ordered-chain", "level": 2, "text": "Execute an ordered chain" }, { "id": "reuse-a-control-client", "level": 2, "text": "Reuse a control client" }, { "id": "collect-concurrent-command-results", "level": 2, "text": "Collect concurrent command results" } ] }, { "title": "Compatibility", "description": "Compatibility: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/compatibility/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/compatibility/index.md", "headings": [ { "id": "minimum-tmux-version", "level": 2, "text": "Minimum tmux version" }, { "id": "optional-features", "level": 2, "text": "Optional features" }, { "id": "evidence", "level": 3, "text": "Evidence" }, { "id": "what-the-checks-do-not-read", "level": 3, "text": "What the checks do not read" }, { "id": "how-the-check-works", "level": 2, "text": "How the check works" }, { "id": "install-with-powershellget", "level": 2, "text": "Install with PowerShellGet" } ] }, { "title": "Create sessions, windows and panes", "description": "Create sessions, windows and panes: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/create/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/create/index.md", "headings": [ { "id": "create-a-detached-session", "level": 2, "text": "Create a detached session" }, { "id": "create-a-window-or-split", "level": 2, "text": "Create a window or split" }, { "id": "commands-directories-and-environment", "level": 2, "text": "Commands, directories and environment" }, { "id": "failures-and-results", "level": 2, "text": "Failures and results" } ] }, { "title": "Set the environment for new panes", "description": "Set the environment for new panes: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/environment/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/environment/index.md", "headings": [] }, { "title": "Getting started", "description": "Getting started: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/getting-started/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/getting-started/index.md", "headings": [ { "id": "quick-start", "level": 2, "text": "Quick start" }, { "id": "find-sessions-windows-and-panes", "level": 2, "text": "Find sessions, windows, and panes" }, { "id": "get-tmuxsnapshot-what-tmux-holds-in-one-read", "level": 3, "text": "Get-TmuxSnapshot: what tmux holds, in one read" }, { "id": "filter-the-captured-graph", "level": 3, "text": "Filter the captured graph" }, { "id": "select-tmuxwindow-pick-windows-by-criteria", "level": 3, "text": "Select-TmuxWindow: pick windows by criteria" }, { "id": "wait-for-service-readiness", "level": 2, "text": "Wait for service readiness" }, { "id": "wait-tmuxpanetext-wait-for-a-readiness-line", "level": 3, "text": "Wait-TmuxPaneText: wait for a readiness line" }, { "id": "choose-how-to-run", "level": 2, "text": "Choose how to run" }, { "id": "connect-tmuxcontrol-one-client-for-repeated-commands", "level": 3, "text": "Connect-TmuxControl: one client for repeated commands" }, { "id": "build-a-workspace-from-a-file", "level": 2, "text": "Build a workspace from a file" }, { "id": "import-tmuxworkspace-read-a-declaration", "level": 3, "text": "Import-TmuxWorkspace: read a declaration" }, { "id": "get-tmuxworkspaceplan-review-before-anything-runs", "level": 3, "text": "Get-TmuxWorkspacePlan: review before anything runs" }, { "id": "invoke-tmuxworkspace-preview-then-apply", "level": 3, "text": "Invoke-TmuxWorkspace: preview, then apply" }, { "id": "packages", "level": 2, "text": "Packages" }, { "id": "libtmux-typed-cmdlets-for-tmux", "level": 3, "text": "LibTmux: typed cmdlets for tmux" }, { "id": "libtmuxworkspace-workspaces-from-yaml-or-json", "level": 3, "text": "LibTmux.Workspace: workspaces from YAML or JSON" }, { "id": "libtmuxmcp-tmux-tools-for-assistants", "level": 3, "text": "LibTmux.Mcp: tmux tools for assistants" }, { "id": "install-from-source", "level": 2, "text": "Install from source" }, { "id": "examplesquickstartps1-a-private-server-and-three-panes", "level": 3, "text": "examples/QuickStart.ps1: a private server and three panes" }, { "id": "what-it-leaves-out", "level": 2, "text": "What it leaves out" }, { "id": "support-and-status", "level": 2, "text": "Support and status" }, { "id": "documentation", "level": 2, "text": "Documentation" }, { "id": "license", "level": 2, "text": "License" } ] }, { "title": "Configure and run hooks", "description": "Configure and run hooks: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/hooks/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/hooks/index.md", "headings": [] }, { "title": "Send input to a pane", "description": "Send input to a pane: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/input/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/input/index.md", "headings": [ { "id": "run-a-command-to-completion", "level": 2, "text": "Run a command to completion" }, { "id": "wait-for-an-applications-readiness-line", "level": 2, "text": "Wait for an application’s readiness line" }, { "id": "send-a-command-and-wait-for-its-output", "level": 2, "text": "Send a command and wait for its output" } ] }, { "title": "Arrange panes and resize windows", "description": "Arrange panes and resize windows: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/layout/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/layout/index.md", "headings": [] }, { "title": "Using the .NET MCP server", "description": "Using the .NET MCP server: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/mcp/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/mcp/index.md", "headings": [ { "id": "install-and-select-a-server", "level": 2, "text": "Install and select a server" }, { "id": "discover-before-calling", "level": 2, "text": "Discover before calling" }, { "id": "inspect-a-pane-and-wait-for-readiness", "level": 2, "text": "Inspect a pane and wait for readiness" }, { "id": "check-the-client-workflow-from-this-checkout", "level": 2, "text": "Check the client workflow from this checkout" } ] }, { "title": "Read and change options", "description": "Read and change options: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/options/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/options/index.md", "headings": [] }, { "title": "Link and move windows between sessions", "description": "Link and move windows between sessions: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/placement/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/placement/index.md", "headings": [] }, { "title": "Filter and query tmux objects", "description": "Filter and query tmux objects: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/query/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/query/index.md", "headings": [ { "id": "start-with-powershell", "level": 2, "text": "Start with PowerShell" }, { "id": "criteria-vocabulary", "level": 2, "text": "Criteria vocabulary" }, { "id": "match-captured-relationships", "level": 2, "text": "Match captured relationships" }, { "id": "store-a-query-or-acquire-a-fresh-result", "level": 2, "text": "Store a query or acquire a fresh result" }, { "id": "require-exactly-one-match", "level": 2, "text": "Require exactly one match" } ] }, { "title": "Read tmux objects", "description": "Read tmux objects: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/read/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/read/index.md", "headings": [] }, { "title": "Remove sessions, windows and panes", "description": "Remove sessions, windows and panes: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/remove/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/remove/index.md", "headings": [ { "id": "linked-windows-and-cascading-removal", "level": 2, "text": "Linked windows and cascading removal" }, { "id": "errors-and-cancellation", "level": 2, "text": "Errors and cancellation" } ] }, { "title": "Troubleshooting", "description": "Troubleshooting: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/troubleshooting/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/troubleshooting/index.md", "headings": [] }, { "title": "Watch events and use runspaces", "description": "Watch events and use runspaces: LibTmux documentation.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/watch/", "markdownUrl": "https://libtmux.org/en/powershell/latest/guides/watch/index.md", "headings": [ { "id": "observe-one-owned-change", "level": 2, "text": "Observe one owned change" }, { "id": "bound-background-output", "level": 2, "text": "Bound background output" }, { "id": "run-independent-commands-concurrently", "level": 2, "text": "Run independent commands concurrently" } ] }, { "title": "Workspace guide", "description": "Workspace guide: LibTmux documentation.", "section": "Workspace Manager", "url": "https://libtmux.org/en/powershell/latest/workspace/source-guide/", "markdownUrl": "https://libtmux.org/en/powershell/latest/workspace/source-guide/index.md", "headings": [ { "id": "load-and-resolve-the-declaration", "level": 2, "text": "Load and resolve the declaration" }, { "id": "choose-when-options-apply", "level": 2, "text": "Choose when options apply" }, { "id": "validate-before-contacting-tmux", "level": 2, "text": "Validate before contacting tmux" }, { "id": "plan-and-review", "level": 2, "text": "Plan and review" }, { "id": "apply-the-reviewed-plan", "level": 2, "text": "Apply the reviewed plan" }, { "id": "export-a-starting-declaration", "level": 2, "text": "Export a starting declaration" }, { "id": "edit-the-declaration", "level": 2, "text": "Edit the declaration" }, { "id": "type-a-command-without-submitting-it", "level": 2, "text": "Type a command without submitting it" }, { "id": "startup-host-effects-and-failures", "level": 2, "text": "Startup, host effects and failures" } ] }, { "title": "AI policy", "description": "Use the libtmux packages with AI tools. When contributing, check what you submit and wait for a maintainer's invitation before preparing a pull request.", "section": "Documentation", "url": "https://libtmux.org/en/powershell/latest/meta/ai-policy/", "markdownUrl": "https://libtmux.org/en/powershell/latest/meta/ai-policy.md", "headings": [ { "id": "1-for-users-about-these-packages", "level": 2, "text": "1. For users: About these packages" }, { "id": "how-the-ports-are-made", "level": 3, "text": "How the ports are made" }, { "id": "stability", "level": 3, "text": "Stability" }, { "id": "2-for-contributors-how-to-report-issues-ideas-suggestions-and-security-issues", "level": 2, "text": "2. For contributors: How to report issues, ideas, suggestions, and security issues" }, { "id": "bugs", "level": 3, "text": "Bugs" }, { "id": "ideas-and-suggestions", "level": 3, "text": "Ideas and suggestions" }, { "id": "security-issues", "level": 3, "text": "Security issues" }, { "id": "writing-your-report", "level": 3, "text": "Writing your report" }, { "id": "using-ai-tools", "level": 3, "text": "Using AI tools" }, { "id": "pull-requests", "level": 3, "text": "Pull requests" } ] }, { "title": "Link to libtmux from Sphinx", "description": "Use Intersphinx inventories to reference libtmux APIs and documentation.", "section": "Linking and consuming our docs", "url": "https://libtmux.org/en/powershell/latest/meta/intersphinx/", "markdownUrl": "https://libtmux.org/en/powershell/latest/meta/intersphinx.md", "headings": [ { "id": "configure-intersphinx", "level": 2, "text": "Configure Intersphinx" }, { "id": "choose-a-reference", "level": 2, "text": "Choose a reference" }, { "id": "stable-labels", "level": 2, "text": "Stable labels" }, { "id": "preserve-published-links", "level": 3, "text": "Preserve published links" } ] }, { "title": "Intersphinx examples", "description": "Compare Sphinx and MyST references to APIs, tmux C declarations, hooks, format variables, CLI commands and schema fields.", "section": "Linking and consuming our docs", "url": "https://libtmux.org/en/powershell/latest/meta/intersphinx/examples/", "markdownUrl": "https://libtmux.org/en/powershell/latest/meta/intersphinx/examples.md", "headings": [ { "id": "configure-the-inventories", "level": 2, "text": "Configure the inventories" }, { "id": "native-python-roles", "level": 2, "text": "Native Python roles" }, { "id": "portable-labels", "level": 2, "text": "Portable labels" }, { "id": "myst-roles-and-inventory-urls", "level": 2, "text": "MyST roles and inventory URLs" }, { "id": "tmux-c-declarations", "level": 2, "text": "tmux C declarations" }, { "id": "tmux-hooks", "level": 2, "text": "tmux hooks" }, { "id": "tmux-formats", "level": 2, "text": "tmux formats" }, { "id": "tmux-cli-manual", "level": 2, "text": "tmux CLI manual" }, { "id": "command-options-environment-variables-and-terms", "level": 2, "text": "Command options, environment variables, and terms" }, { "id": "mcp-tools-and-schema-fields", "level": 2, "text": "MCP tools and schema fields" }, { "id": "shared-documentation-and-headings", "level": 2, "text": "Shared documentation and headings" }, { "id": "local-files-and-fallback-locations", "level": 2, "text": "Local files and fallback locations" } ] }, { "title": "Linking and consuming our docs", "description": "Find documentation exports for search engines, bots, LLMs and other documentation sites.", "section": "Linking and consuming our docs", "url": "https://libtmux.org/en/powershell/latest/meta/linking/", "markdownUrl": "https://libtmux.org/en/powershell/latest/meta/linking.md", "headings": [ { "id": "choose-an-export", "level": 2, "text": "Choose an export" }, { "id": "link-from-sphinx", "level": 2, "text": "Link from Sphinx" }, { "id": "discover-and-index-pages", "level": 2, "text": "Discover and index 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/powershell/latest/meta/third-party-notices/", "markdownUrl": "https://libtmux.org/en/powershell/latest/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": "Understand captured objects, stable identities, and local versus remote queries.", "section": "Concepts", "url": "https://libtmux.org/en/powershell/latest/concepts/", "markdownUrl": "https://libtmux.org/en/powershell/latest/concepts/index.md", "headings": [] }, { "title": "Captured state and I/O", "description": "Separate explicit reads from local object traversal and preserve snapshot boundaries.", "section": "Concepts", "url": "https://libtmux.org/en/powershell/latest/concepts/captured-state/", "markdownUrl": "https://libtmux.org/en/powershell/latest/concepts/captured-state.md", "headings": [ { "id": "choose-the-read-boundary", "level": 2, "text": "Choose the read boundary" }, { "id": "missing-capture-is-not-an-empty-collection", "level": 2, "text": "Missing capture is not an empty collection" }, { "id": "a-snapshot-is-a-bounded-observation", "level": 2, "text": "A snapshot is a bounded observation" } ] }, { "title": "Object identity and placement", "description": "Understand endpoint handles, daemon generations, physical windows, and session links.", "section": "Concepts", "url": "https://libtmux.org/en/powershell/latest/concepts/identity/", "markdownUrl": "https://libtmux.org/en/powershell/latest/concepts/identity.md", "headings": [ { "id": "endpoint-and-daemon-generation", "level": 2, "text": "Endpoint and daemon generation" }, { "id": "ids-and-names-serve-different-purposes", "level": 2, "text": "IDs and names serve different purposes" }, { "id": "a-window-can-appear-in-several-sessions", "level": 2, "text": "A window can appear in several sessions" } ] }, { "title": "Local selection and source queries", "description": "Choose ordinary pipelines, reusable criteria, or a fresh daemon-side query.", "section": "Concepts", "url": "https://libtmux.org/en/powershell/latest/concepts/queries/", "markdownUrl": "https://libtmux.org/en/powershell/latest/concepts/queries.md", "headings": [ { "id": "choose-the-simplest-useful-query", "level": 2, "text": "Choose the simplest useful query" }, { "id": "matching-has-explicit-semantics", "level": 2, "text": "Matching has explicit semantics" }, { "id": "inspect-before-dispatching", "level": 2, "text": "Inspect before dispatching" } ] }, { "title": "tmux client library for PowerShell", "description": "tmux client library for PowerShell. Control tmux, connect to and create servers, navigate sessions, windows, and panes, send keys, watch for changes via control mode, capture pane contents", "section": "Documentation", "url": "https://libtmux.org/en/powershell/latest/core/", "markdownUrl": "https://libtmux.org/en/powershell/latest/core/index.md", "headings": [] }, { "title": "Examples", "description": "Complete programs with setup, expected output, and owned-server cleanup.", "section": "Examples", "url": "https://libtmux.org/en/powershell/latest/examples/", "markdownUrl": "https://libtmux.org/en/powershell/latest/examples/index.md", "headings": [] }, { "title": "Check command completion", "description": "Run a shell command and verify its authenticated nonzero exit status.", "section": "Examples", "url": "https://libtmux.org/en/powershell/latest/examples/command-completion/", "markdownUrl": "https://libtmux.org/en/powershell/latest/examples/command-completion.md", "headings": [ { "id": "setup", "level": 2, "text": "Setup" }, { "id": "program", "level": 2, "text": "Program" }, { "id": "run", "level": 2, "text": "Run" }, { "id": "related-apis", "level": 2, "text": "Related APIs" }, { "id": "source-and-verification", "level": 2, "text": "Source and verification" } ] }, { "title": "Create windows and panes", "description": "Create a session with two windows, then query a captured snapshot.", "section": "Examples", "url": "https://libtmux.org/en/powershell/latest/examples/create-layout/", "markdownUrl": "https://libtmux.org/en/powershell/latest/examples/create-layout.md", "headings": [ { "id": "setup", "level": 2, "text": "Setup" }, { "id": "program", "level": 2, "text": "Program" }, { "id": "run", "level": 2, "text": "Run" }, { "id": "related-apis", "level": 2, "text": "Related APIs" }, { "id": "source-and-verification", "level": 2, "text": "Source and verification" } ] }, { "title": "Wait for a service", "description": "Wait for an HTTP readiness line and check the service responds.", "section": "Examples", "url": "https://libtmux.org/en/powershell/latest/examples/wait-for-service/", "markdownUrl": "https://libtmux.org/en/powershell/latest/examples/wait-for-service.md", "headings": [ { "id": "setup", "level": 2, "text": "Setup" }, { "id": "program", "level": 2, "text": "Program" }, { "id": "run", "level": 2, "text": "Run" }, { "id": "related-apis", "level": 2, "text": "Related APIs" }, { "id": "source-and-verification", "level": 2, "text": "Source and verification" } ] }, { "title": "Attaching to tmux", "description": "Connect to an existing tmux server and find a session with PowerShell.", "section": "Guides", "url": "https://libtmux.org/en/powershell/latest/guides/attaching-to-tmux/", "markdownUrl": "https://libtmux.org/en/powershell/latest/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": "Topics", "description": "Make deliberate choices about ownership, command completion, and event streams.", "section": "Topics", "url": "https://libtmux.org/en/powershell/latest/topics/", "markdownUrl": "https://libtmux.org/en/powershell/latest/topics/index.md", "headings": [] }, { "title": "Dispatch, completion, and failure", "description": "Distinguish accepted input, tmux replies, shell completion, and application readiness.", "section": "Topics", "url": "https://libtmux.org/en/powershell/latest/topics/execution/", "markdownUrl": "https://libtmux.org/en/powershell/latest/topics/execution.md", "headings": [ { "id": "what-a-result-proves", "level": 2, "text": "What a result proves" }, { "id": "commands-and-chains", "level": 2, "text": "Commands and chains" }, { "id": "stopping-the-caller-does-not-undo-dispatch", "level": 2, "text": "Stopping the caller does not undo dispatch" } ] }, { "title": "Watching output and state", "description": "Choose a screen capture or event stream and handle bounded delivery explicitly.", "section": "Topics", "url": "https://libtmux.org/en/powershell/latest/topics/observations/", "markdownUrl": "https://libtmux.org/en/powershell/latest/topics/observations.md", "headings": [ { "id": "start-observation-before-the-producer", "level": 2, "text": "Start observation before the producer" }, { "id": "bound-both-time-and-retained-output", "level": 2, "text": "Bound both time and retained output" }, { "id": "treat-loss-as-a-state-change", "level": 2, "text": "Treat loss as a state change" }, { "id": "keep-the-right-owner-alive", "level": 2, "text": "Keep the right owner alive" } ] }, { "title": "Ownership and cleanup", "description": "Keep daemon, client, session, and runspace lifetimes explicit.", "section": "Topics", "url": "https://libtmux.org/en/powershell/latest/topics/ownership/", "markdownUrl": "https://libtmux.org/en/powershell/latest/topics/ownership.md", "headings": [ { "id": "match-cleanup-to-what-you-created", "level": 2, "text": "Match cleanup to what you created" }, { "id": "use-an-isolated-endpoint-for-automation", "level": 2, "text": "Use an isolated endpoint for automation" }, { "id": "preserve-failures-during-cleanup", "level": 2, "text": "Preserve failures during cleanup" } ] }, { "title": "PowerShell-based tmux workspace manager", "description": "Validate, plan and load workspace files with the LibTmux.Workspace module.", "section": "Documentation", "url": "https://libtmux.org/en/powershell/latest/workspace/", "markdownUrl": "https://libtmux.org/en/powershell/latest/workspace/index.md", "headings": [] }, { "title": "LibTmux.Workspace API reference", "description": "Public LibTmux.Workspace declarations, parameters and source documentation.", "section": "Documentation", "url": "https://libtmux.org/en/powershell/latest/workspace/reference/", "markdownUrl": "https://libtmux.org/en/powershell/latest/workspace/reference.md", "headings": [] }, { "title": "API glossary", "description": "Kinds, modifiers and package labels in the PowerShell API reference.", "section": "API reference", "url": "https://libtmux.org/en/powershell/latest/reference/glossary/", "markdownUrl": "https://libtmux.org/en/powershell/latest/reference/glossary.md", "jsonUrl": "https://libtmux.org/en/powershell/latest/reference/glossary.json", "headings": [ { "id": "symbol-kinds", "level": 2, "text": "Symbol kinds" }, { "id": "module", "level": 3, "text": "module" }, { "id": "function", "level": 3, "text": "function" }, { "id": "cmdlet", "level": 3, "text": "cmdlet" }, { "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 PowerShell API reference.", "section": "API reference", "url": "https://libtmux.org/en/powershell/latest/workspace/reference/glossary/", "markdownUrl": "https://libtmux.org/en/powershell/latest/workspace/reference/glossary.md", "jsonUrl": "https://libtmux.org/en/powershell/latest/workspace/reference/glossary.json", "headings": [ { "id": "symbol-kinds", "level": 2, "text": "Symbol kinds" }, { "id": "module", "level": 3, "text": "module" }, { "id": "function", "level": 3, "text": "function" }, { "id": "cmdlet", "level": 3, "text": "cmdlet" }, { "id": "package-context", "level": 2, "text": "Package context" }, { "id": "package", "level": 3, "text": "package" } ] }, { "title": "API reference", "description": "56 declarations in the PowerShell reference index. The symbol index also includes their members.", "section": "API reference", "url": "https://libtmux.org/en/powershell/latest/reference/", "markdownUrl": "https://libtmux.org/en/powershell/latest/reference/index.md", "symbolIndexUrl": "https://libtmux.org/en/powershell/latest/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-functions", "level": 2, "text": "Options — Functions" }, { "id": "section-keys", "level": 2, "text": "Keys and bindings" }, { "id": "section-layout", "level": 2, "text": "Layout and geometry" }, { "id": "section-environment", "level": 2, "text": "Environment" }, { "id": "section-commands", "level": 2, "text": "Commands" }, { "id": "section-control", "level": 2, "text": "Control mode" }, { "id": "section-queries", "level": 2, "text": "Queries" }, { "id": "section-queries-fields", "level": 2, "text": "Queries — Fields" }, { "id": "section-snapshots", "level": 2, "text": "Snapshots" }, { "id": "section-__unplaced", "level": 2, "text": "Other" } ], "symbols": [ { "id": "LibTmux\\New-TmuxServer", "name": "New-TmuxServer", "kind": "function", "qualifiedName": "LibTmux\\New-TmuxServer", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxserver/" }, { "id": "LibTmux\\Get-TmuxServer", "name": "Get-TmuxServer", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxServer", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxserver/" }, { "id": "LibTmux\\Connect-TmuxServer", "name": "Connect-TmuxServer", "kind": "function", "qualifiedName": "LibTmux\\Connect-TmuxServer", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-connect-tmuxserver/" }, { "id": "LibTmux\\Get-TmuxSession", "name": "Get-TmuxSession", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxSession", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxsession/" }, { "id": "LibTmux\\Select-TmuxSession", "name": "Select-TmuxSession", "kind": "function", "qualifiedName": "LibTmux\\Select-TmuxSession", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-select-tmuxsession/" }, { "id": "LibTmux\\New-TmuxSession", "name": "New-TmuxSession", "kind": "function", "qualifiedName": "LibTmux\\New-TmuxSession", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxsession/" }, { "id": "LibTmux\\Enter-TmuxSession", "name": "Enter-TmuxSession", "kind": "function", "qualifiedName": "LibTmux\\Enter-TmuxSession", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-enter-tmuxsession/" }, { "id": "LibTmux\\Remove-TmuxSession", "name": "Remove-TmuxSession", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxSession", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxsession/" }, { "id": "LibTmux\\Get-TmuxWindow", "name": "Get-TmuxWindow", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxWindow", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxwindow/" }, { "id": "LibTmux\\Select-TmuxWindow", "name": "Select-TmuxWindow", "kind": "function", "qualifiedName": "LibTmux\\Select-TmuxWindow", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-select-tmuxwindow/" }, { "id": "LibTmux\\New-TmuxWindow", "name": "New-TmuxWindow", "kind": "function", "qualifiedName": "LibTmux\\New-TmuxWindow", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxwindow/" }, { "id": "LibTmux\\New-TmuxWindowLink", "name": "New-TmuxWindowLink", "kind": "function", "qualifiedName": "LibTmux\\New-TmuxWindowLink", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxwindowlink/" }, { "id": "LibTmux\\Set-TmuxWindowSize", "name": "Set-TmuxWindowSize", "kind": "function", "qualifiedName": "LibTmux\\Set-TmuxWindowSize", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxwindowsize/" }, { "id": "LibTmux\\Move-TmuxWindow", "name": "Move-TmuxWindow", "kind": "function", "qualifiedName": "LibTmux\\Move-TmuxWindow", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-move-tmuxwindow/" }, { "id": "LibTmux\\Remove-TmuxWindowLink", "name": "Remove-TmuxWindowLink", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxWindowLink", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxwindowlink/" }, { "id": "LibTmux\\Remove-TmuxWindow", "name": "Remove-TmuxWindow", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxWindow", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxwindow/" }, { "id": "LibTmux\\Get-TmuxPane", "name": "Get-TmuxPane", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxPane", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxpane/" }, { "id": "LibTmux\\Select-TmuxPane", "name": "Select-TmuxPane", "kind": "function", "qualifiedName": "LibTmux\\Select-TmuxPane", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-select-tmuxpane/" }, { "id": "LibTmux\\Get-TmuxPaneContent", "name": "Get-TmuxPaneContent", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxPaneContent", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxpanecontent/" }, { "id": "LibTmux\\Split-TmuxPane", "name": "Split-TmuxPane", "kind": "function", "qualifiedName": "LibTmux\\Split-TmuxPane", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-split-tmuxpane/" }, { "id": "LibTmux\\Send-TmuxText", "name": "Send-TmuxText", "kind": "function", "qualifiedName": "LibTmux\\Send-TmuxText", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-send-tmuxtext/" }, { "id": "LibTmux\\Invoke-TmuxPaneCommand", "name": "Invoke-TmuxPaneCommand", "kind": "function", "qualifiedName": "LibTmux\\Invoke-TmuxPaneCommand", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxpanecommand/" }, { "id": "LibTmux\\Wait-TmuxPaneText", "name": "Wait-TmuxPaneText", "kind": "function", "qualifiedName": "LibTmux\\Wait-TmuxPaneText", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-wait-tmuxpanetext/" }, { "id": "LibTmux\\Update-TmuxPane", "name": "Update-TmuxPane", "kind": "function", "qualifiedName": "LibTmux\\Update-TmuxPane", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-update-tmuxpane/" }, { "id": "LibTmux\\Set-TmuxPaneSize", "name": "Set-TmuxPaneSize", "kind": "function", "qualifiedName": "LibTmux\\Set-TmuxPaneSize", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxpanesize/" }, { "id": "LibTmux\\Remove-TmuxPane", "name": "Remove-TmuxPane", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxPane", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxpane/" }, { "id": "LibTmux\\Get-TmuxClient", "name": "Get-TmuxClient", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxClient", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxclient/" }, { "id": "LibTmux\\Get-TmuxClientAttachment", "name": "Get-TmuxClientAttachment", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxClientAttachment", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxclientattachment/" }, { "id": "LibTmux\\Update-TmuxClient", "name": "Update-TmuxClient", "kind": "function", "qualifiedName": "LibTmux\\Update-TmuxClient", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-update-tmuxclient/" }, { "id": "LibTmux\\Get-TmuxHook", "name": "Get-TmuxHook", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxHook", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxhook/" }, { "id": "LibTmux\\Set-TmuxHook", "name": "Set-TmuxHook", "kind": "function", "qualifiedName": "LibTmux\\Set-TmuxHook", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxhook/" }, { "id": "LibTmux\\Invoke-TmuxHook", "name": "Invoke-TmuxHook", "kind": "function", "qualifiedName": "LibTmux\\Invoke-TmuxHook", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxhook/" }, { "id": "LibTmux\\Remove-TmuxHook", "name": "Remove-TmuxHook", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxHook", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxhook/" }, { "id": "LibTmux\\Get-TmuxOption", "name": "Get-TmuxOption", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxOption", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxoption/" }, { "id": "LibTmux\\Set-TmuxOption", "name": "Set-TmuxOption", "kind": "function", "qualifiedName": "LibTmux\\Set-TmuxOption", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxoption/" }, { "id": "LibTmux\\Remove-TmuxOption", "name": "Remove-TmuxOption", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxOption", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxoption/" }, { "id": "LibTmux\\Send-TmuxKey", "name": "Send-TmuxKey", "kind": "function", "qualifiedName": "LibTmux\\Send-TmuxKey", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-send-tmuxkey/" }, { "id": "LibTmux\\Set-TmuxLayout", "name": "Set-TmuxLayout", "kind": "function", "qualifiedName": "LibTmux\\Set-TmuxLayout", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxlayout/" }, { "id": "LibTmux\\Get-TmuxEnvironment", "name": "Get-TmuxEnvironment", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxEnvironment", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxenvironment/" }, { "id": "LibTmux\\Set-TmuxEnvironment", "name": "Set-TmuxEnvironment", "kind": "function", "qualifiedName": "LibTmux\\Set-TmuxEnvironment", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxenvironment/" }, { "id": "LibTmux\\Remove-TmuxEnvironment", "name": "Remove-TmuxEnvironment", "kind": "function", "qualifiedName": "LibTmux\\Remove-TmuxEnvironment", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxenvironment/" }, { "id": "LibTmux\\New-TmuxCommand", "name": "New-TmuxCommand", "kind": "function", "qualifiedName": "LibTmux\\New-TmuxCommand", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxcommand/" }, { "id": "LibTmux\\Invoke-TmuxCommand", "name": "Invoke-TmuxCommand", "kind": "function", "qualifiedName": "LibTmux\\Invoke-TmuxCommand", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxcommand/" }, { "id": "LibTmux\\Invoke-TmuxChain", "name": "Invoke-TmuxChain", "kind": "function", "qualifiedName": "LibTmux\\Invoke-TmuxChain", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxchain/" }, { "id": "LibTmux\\Connect-TmuxControl", "name": "Connect-TmuxControl", "kind": "function", "qualifiedName": "LibTmux\\Connect-TmuxControl", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-connect-tmuxcontrol/" }, { "id": "LibTmux\\Watch-TmuxEvent", "name": "Watch-TmuxEvent", "kind": "function", "qualifiedName": "LibTmux\\Watch-TmuxEvent", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-watch-tmuxevent/" }, { "id": "LibTmux\\Wait-TmuxChannel", "name": "Wait-TmuxChannel", "kind": "function", "qualifiedName": "LibTmux\\Wait-TmuxChannel", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-wait-tmuxchannel/" }, { "id": "LibTmux\\Invoke-TmuxControlCommand", "name": "Invoke-TmuxControlCommand", "kind": "function", "qualifiedName": "LibTmux\\Invoke-TmuxControlCommand", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxcontrolcommand/" }, { "id": "LibTmux\\Disconnect-TmuxControl", "name": "Disconnect-TmuxControl", "kind": "function", "qualifiedName": "LibTmux\\Disconnect-TmuxControl", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-disconnect-tmuxcontrol/" }, { "id": "LibTmux\\New-TmuxQuery", "name": "New-TmuxQuery", "kind": "function", "qualifiedName": "LibTmux\\New-TmuxQuery", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxquery/" }, { "id": "LibTmux\\Get-TmuxQueryPlan", "name": "Get-TmuxQueryPlan", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxQueryPlan", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxqueryplan/" }, { "id": "LibTmux\\Invoke-TmuxQuery", "name": "Invoke-TmuxQuery", "kind": "function", "qualifiedName": "LibTmux\\Invoke-TmuxQuery", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxquery/" }, { "id": "LibTmux\\ConvertTo-TmuxQueryJson", "name": "ConvertTo-TmuxQueryJson", "kind": "function", "qualifiedName": "LibTmux\\ConvertTo-TmuxQueryJson", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-convertto-tmuxqueryjson/" }, { "id": "LibTmux\\Get-TmuxQueryField", "name": "Get-TmuxQueryField", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxQueryField", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxqueryfield/" }, { "id": "LibTmux\\Get-TmuxSnapshot", "name": "Get-TmuxSnapshot", "kind": "function", "qualifiedName": "LibTmux\\Get-TmuxSnapshot", "namespace": "LibTmux", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxsnapshot/" }, { "id": "LibTmux", "name": "LibTmux", "kind": "module", "qualifiedName": "LibTmux", "namespace": "", "url": "https://libtmux.org/en/powershell/latest/reference/libtmux/" } ] } ] }