[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_116":117},"routes/modules.$creator.$moduleId",{"_14":15,"_16":17,"_18":19,"_20":21},"routes/modules.$creator.$moduleId.endpoints",{"_11":12,"_13":-5},"error","Module not found","tools","module",{"_20":22,"_23":24,"_25":26,"_27":28,"_29":30,"_31":32,"_33":34,"_35":26,"_36":37,"_38":-5,"_39":-5,"_40":-5,"_41":42,"_43":44,"_45":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":-5,"_56":48,"_57":58,"_59":60,"_61":-5,"_62":-5,"_63":-5,"_64":-5,"_65":66,"_67":68,"_69":70,"_71":72,"_73":74,"_75":-5,"_76":-5,"_77":-5,"_78":48,"_79":-5,"_80":58,"_81":82,"_83":84,"_85":86,"_87":88,"_89":90,"_91":92},"apiUrl","https://odel.app/api","creator","libtmux","moduleId","libtmux-go","@libtmux/libtmux-go","displayName","tmux","tagline","Drive one tmux server: sessions, windows, panes, and the output they produce.","iconKey","https://avatars.githubusercontent.com/u/316212987?v=4","category","local","status","published","visibility","public","metaDescription","deploymentType","external","workerName","bindingName","mcpConfig","pricingModel","free","creatorUserId","system:external-import","createdAt",1786942020000,"updatedAt",1788330180000,"sourceRegistry","official-mcp-registry","sourceUrl","https://registry.modelcontextprotocol.io/v0/servers?search=io.github.libtmux%2Ftmux-mcp-go","sourceVerified",true,"sourceMissingSince","importedAt","upstreamStars",0,"upstreamUpdatedAt",1788130109000,"detectedTransport","detectedAuthType","probeStatus","lastProbedAt","githubRepoUrl","https://github.com/libtmux/libtmux-go","githubRepoFullName","libtmux/libtmux-go","releaseId","ext-libtmux-libtmux-go","version","0.0.1-alpha.5","descriptionMarkdown","# libtmux for Go\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/libtmux/libtmux-go/tmux.svg)](https://pkg.go.dev/github.com/libtmux/libtmux-go/tmux)\n[![tests](https://github.com/libtmux/libtmux-go/actions/workflows/tests.yml/badge.svg)](https://github.com/libtmux/libtmux-go/actions/workflows/tests.yml)\n\nAlpha software. Releases carry an -alpha prerelease tag, the API is not\nsettled, and any release may change or remove exported identifiers without a\ndeprecation period. Pin an exact version. Not recommended for production.\n\nDrive tmux from Go: sessions, windows, and panes as typed values, every tmux\noption and hook as a typed accessor, and errors classified by what tmux actually\nrefused.\n\n- **No runtime dependencies.** The core module imports only the standard library.\n- **Go 1.26+**, tmux **3.2a through 3.7c** across the core, workspace, and MCP\n modules. The compatibility matrix checks every release in that range.\n The Go floor tracks upstream's support window, which covers the two most\n recent releases.\n- **Records never refresh behind you.** A `Session` you hold is what tmux said\n when you asked, not a live handle that changes underneath.\n\n```console\n$ go get github.com/libtmux/libtmux-go/tmux@latest\n```\n\nModules are tagged per directory, so each consumer carries its own version:\nthe tags are `mcp/vN` and `workspace/vN` beside the core's plain `vN`. Pin the\nexact ones you want in your own go.mod; the commands here fetch the newest.\n\n**Contents** — [Quick start](#quick-start) · [Querying](#what-querying-looks-like)\n· [Choosing a mode](#choosing-a-mode) · [Watching tmux](#watching-tmux) ·\n[Packages](#packages) · [For agents](#for-agents) ·\n[Testing your code](#testing-your-own-code) · [Documentation](#documentation)\n\n## Quick start\n\nMake a window, split it, send a command into the new pane:\n\n\n\n```go\nwindowName := \"work\"\nwindow, err := session.NewWindow(ctx, tmux.NewWindowRequest{Name: &windowName})\nif err != nil {\n\treturn fmt.Errorf(\"create window: %w\", err)\n}\npane, err := window.SplitPane(ctx, tmux.SplitPaneRequest{\n\tDirection: tmux.PaneDirectionRight,\n})\nif err != nil {\n\treturn fmt.Errorf(\"split window: %w\", err)\n}\ncommand := \"printf 'libtmux ready\\\\n'\"\nif err := pane.SendKeys(ctx, tmux.SendKeysRequest{Command: &command, Literal: true}); err != nil {\n\treturn fmt.Errorf(\"send command: %w\", err)\n}\n```\n\n\n\nEvery Go block below marked this way is generated from a program in\n[`examples/`](https://github.com/libtmux/libtmux-go/blob/master/examples/) that is compiled, linted, run against a real tmux, and\nswept across every supported release — so none of it can drift from code that\nworks.\n\nRunnable: [`examples/quickstart`](https://github.com/libtmux/libtmux-go/blob/master/examples/quickstart) — `go -C examples run ./quickstart`.\n\n## What querying looks like\n\nTwo ways to ask, and they answer the same question at different costs.\n\n**Let tmux filter**, which sends one command and gets back only matches:\n\n\n\n```go\nlive := tmux.TmuxFilter(\"#{==:#{session_name},libtmux-filter}\")\nsessions, err := server.SearchSessions(ctx, &live)\n```\n\n\n\n**Or read once and filter in Go**, when you want several answers from one read:\n\n\n\n```go\nsnapshot, err := server.Snapshot(ctx)\nif err != nil {\n\treturn err\n}\npredicate, err := tmux.PaneActiveIs(true).Predicate()\nif err != nil {\n\treturn err\n}\nactive := tmuxq.Where(snapshot.Panes(), predicate)\n```\n\n\n\nTyped filters compose, and the generated ones push down into tmux's own `-f`\nwhere tmux can evaluate them:\n\n```go\nfilter := tmux.PaneFilter{\n\tActive: tmux.Ptr(true),\n\tCurrentPath: tmux.Ptr(\"/home/you/project\"),\n}\npanes, err := server.SearchPanes(ctx, &filter)\n```\n\nRunnable: [`examples/filter-query`](https://github.com/libtmux/libtmux-go/blob/master/examples/filter-query).\n\n## Choosing an execution path\n\nA plain `Server` uses the executable, environment, working directory, and\nsocket selection frozen by `NewServer`. Values derived from it retain that\nsubprocess binding. Guards on materialized values assume stable, trusted tmux\nparser primitives and aliases. Establish a connection before socket\nreplacement when exact-daemon ownership is required.\n\n| Path | Construct it with | Cost | Reach for it |\n| --- | --- | --- | --- |\n| process | `NewServer` | one tmux process per operation | one-shot commands |\n| connection | `Session.OpenControl` | one tmux client per lane | repeated commands |\n| concurrent | `ConnectionOptions{Lanes: N}` | N tmux clients | parallel readers |\n| chained | `NewPlan` then `Run` | fewer process starts | builds and layouts |\n| streaming | `Session.OpenNotifications(ctx, NotificationOptions{})` | one tmux client | watching what tmux does |\n\nPlans run over either a plain server or a connection-bound server. Unsupported\ncapability policy is separate: `ServerOptions.Unsupported` decides whether a\nrequest naming an unavailable tmux flag is refused — the default — or\ncarried out without it and reported to a warning handler.\n\nA connection carries commands without starting a process for each. It appears\nin `list-clients` and counts toward `session_attached`, which is why opening one\nis explicit:\n\n\n\n```go\nconnection, err := session.OpenControl(ctx, tmux.ConnectionOptions{})\nif err != nil {\n\treturn fmt.Errorf(\"open control connection: %w\", err)\n}\ndefer func() { _ = connection.Close() }()\nconnected := connection.Session()\n```\n\n\n\nOnce established, `connection.Server()` and `connection.Session()` are bound\nto that exact daemon. Values derived from them retain that owner. The binding\nis terminal: closing the connection makes later operations return\n`ErrControlClosed`, and an operation that needs a separate process returns\n`ErrConnectionRequiresProcess`. It never falls back or rebinds. The original\nsession remains on its frozen subprocess binding.\n\n`Server.NewSessionConnection` creates a session and retains its creating\ncontrol process as the first lane. It returns the ordinary created session and\nan owned connection; use `connection.Session()` for connected operations.\n\nA plan records commands instead of running them, sends the ones needing no\nanswer together, and hands back a reference to what a step *will* create — so a\nbuild is written in one pass:\n\n\n\n```go\nplan := tmux.NewPlan()\nplan.SelectLayout(window.Ref(), tmux.SelectLayoutRequest{Layout: \"tiled\"})\neditor := plan.SplitPane(window.Ref(), tmux.SplitPaneRequest{Attach: true})\nplan.SetPaneTitle(editor, \"editor\")\nplan.SendKeys(editor, tmux.SendKeysRequest{Command: tmux.Ptr(\"echo built\")})\nplan.DisplayMessage(editor, \"#{pane_title}\")\n```\n\n\n\nRunnable: [`examples/fast-path`](https://github.com/libtmux/libtmux-go/blob/master/examples/fast-path) and\n[`examples/planned-build`](https://github.com/libtmux/libtmux-go/blob/master/examples/planned-build).\n[`BENCHMARKS.md`](https://github.com/libtmux/libtmux-go/blob/master/BENCHMARKS.md) is what each path costs, measured on every\nsupported tmux.\n\n## Watching tmux\n\n`Session.OpenNotifications` and `Server.OpenNotifications` return owned\nstreams. Zero options retain tmux changes but suppress pane output; set\n`IncludePaneOutput` when watching pane content. tmux pushes each change when it\nhappens rather than making a poll guess how often to ask. Before tmux 3.6,\ndestroying the attached session follows its `detach-on-destroy` policy and may\nend the stream:\n\n\n\n```go\nstream, err := session.OpenNotifications(ctx, tmux.NotificationOptions{})\nif err != nil {\n\treturn fmt.Errorf(\"open notification stream: %w\", err)\n}\ndefer func() { err = errors.Join(err, stream.Close()) }()\n\n// Rename after subscribing; notifications do not include earlier changes.\nif _, err := session.Rename(ctx, \"control-example\"); err != nil {\n\treturn fmt.Errorf(\"rename session: %w\", err)\n}\n\nfor {\n\tnotification, err := stream.Next(ctx)\n\tif err != nil {\n\t\treturn fmt.Errorf(\"read notification: %w\", err)\n\t}\n\tfmt.Printf(\"notification: %s\\n\", notification.Kind())\n\tif notification.Kind() == tmux.ControlNotificationSessionRenamed {\n\t\tfmt.Println(\"heard the rename\")\n\t\treturn nil\n\t}\n}\n```\n\n\n\nRunnable: [`examples/control-mode-subscribe`](https://github.com/libtmux/libtmux-go/blob/master/examples/control-mode-subscribe).\n\n## Packages\n\n| Package | Source | Reference | What it is |\n| --- | --- | --- | --- |\n| `tmux` | [`tmux/`](https://github.com/libtmux/libtmux-go/blob/master/tmux/) | [pkg.go.dev](https://pkg.go.dev/github.com/libtmux/libtmux-go/tmux) | The library. Sessions, windows, panes, options, hooks, formats, filters, snapshots, plans. |\n| `tmuxtest` | [`tmux/tmuxtest/`](https://github.com/libtmux/libtmux-go/blob/master/tmux/tmuxtest/) | [pkg.go.dev](https://pkg.go.dev/github.com/libtmux/libtmux-go/tmux/tmuxtest) | Run your program in a real tmux and assert on what it drew. |\n| `tmuxq` | [`tmuxq/`](https://github.com/libtmux/libtmux-go/blob/master/tmuxq/) | [pkg.go.dev](https://pkg.go.dev/github.com/libtmux/libtmux-go/tmuxq) | Model-free generic helpers for slices and `iter.Seq`. |\n\nThree more ship as **separate modules**, so `go get` on the library pulls in\nnone of them:\n\n| Module | Source | Reference | What it is |\n| --- | --- | --- | --- |\n| `mcp` | [`mcp/`](https://github.com/libtmux/libtmux-go/blob/master/mcp/) | [pkg.go.dev](https://pkg.go.dev/github.com/libtmux/libtmux-go/mcp) | **A tmux server for AI agents** over the Model Context Protocol. Install it as a binary. |\n| `workspace` | [`workspace/`](https://github.com/libtmux/libtmux-go/blob/master/workspace/) | [pkg.go.dev](https://pkg.go.dev/github.com/libtmux/libtmux-go/workspace) | Loads tmuxp-style YAML workspaces and builds them. |\n| `benchmarks` | [`benchmarks/`](https://github.com/libtmux/libtmux-go/blob/master/benchmarks/) | — | Prints what each way of reaching tmux costs. |\n\n### For agents\n\n[`mcp/`](https://github.com/libtmux/libtmux-go/blob/master/mcp/) is a standalone Model Context Protocol server that gives an agent\none tmux server: create panes, send keys, read output, wait for text.\n\n```console\n$ go install github.com/libtmux/libtmux-go/mcp/cmd/libtmux-mcp@latest\n```\n\nSee [`mcp/README.md`](https://github.com/libtmux/libtmux-go/blob/master/mcp/README.md) for client configuration, and\n[`mcp/TOOLS.md`](https://github.com/libtmux/libtmux-go/blob/master/mcp/TOOLS.md) for the tool reference.\n\n## Testing your own code\n\n[`tmux/tmuxtest`](https://github.com/libtmux/libtmux-go/blob/master/tmux/tmuxtest/) runs your program inside a real tmux and lets\na test assert on what it drew, with no sleeps. Run it, wait for what it draws,\ntype at it:\n\n\n\n```go\npane := tmuxtest.RunInPane(ctx, t, \"printf 'ready\\\\n'; cat\")\n\ntmuxtest.WaitForText(ctx, t, pane, \"ready\")\ntmuxtest.Type(ctx, t, pane, \"a line for the program\")\ntmuxtest.WaitForLine(ctx, t, pane, \"a line for the program\")\n```\n\n\n\nA wait that runs out fails with the screen the pane last held, rather than\nsending you back to add a print statement:\n\n```\ntmuxtest: pane %1 never showed a line containing \"ready\"\nthe pane showed 3 line(s):\n | tmuxtest$ ./mytui --watch\n | loading widgets\n | connecting\n```\n\nIt works for a test whose subject is tmux itself too, giving a server on its own\nsocket that is killed when the test ends:\n\n```go\nfunc TestSomething(t *testing.T) {\n\tctx := context.Background()\n\tserver := tmuxtest.NewServer(ctx, t)\n\n\tsession, err := server.NewSession(ctx, tmux.NewSessionRequest{Name: \"under-test\"})\n\t// ...\n}\n```\n\n`NewServer` snapshots its effective environment and working directory, resolves\none absolute executable, and returns an error before starting tmux when\nconfiguration or resolution fails. Later environment and directory changes do\nnot retarget the handle, and the zero `Server` is invalid. Tests of process\nbehavior can point `ServerOptions.Binary` at an executable fixture;\nconstruction still resolves and freezes it. Use `tmuxtest` when the behavior\nbelongs to a real tmux daemon.\n\n## Documentation\n\nThe package documentation is the reference, written to be read start to finish\nrather than searched:\n\n```console\n$ go doc github.com/libtmux/libtmux-go/tmux\n```\n\nIt opens with a task index, then the rule mapping a tmux command to its Go\nmethod — `kill-pane` is `Pane.Kill`, `rename-session` is `Session.Rename` — so a\ncommand usually leads to its method without a lookup.\n\n| | |\n| --- | --- |\n| [`DESIGN.md`](https://github.com/libtmux/libtmux-go/blob/master/DESIGN.md) | The conventions this package holds itself to, and the bakeoffs behind them |\n| [`PARITY.md`](https://github.com/libtmux/libtmux-go/blob/master/PARITY.md) | How the surface is checked against the Python libtmux |\n| [`BENCHMARKS.md`](https://github.com/libtmux/libtmux-go/blob/master/BENCHMARKS.md) | What each way of reaching tmux costs |\n| [`CHANGELOG.md`](https://github.com/libtmux/libtmux-go/blob/master/CHANGELOG.md) | What each release changed |\n| [`CONTRIBUTING.md`](https://github.com/libtmux/libtmux-go/blob/master/.github/CONTRIBUTING.md) | The gates a change has to pass |\n| [`WRITING.md`](https://github.com/libtmux/libtmux-go/blob/master/.github/WRITING.md) | How this repository writes: docs, the changelog, commits |\n| [`SECURITY.md`](https://github.com/libtmux/libtmux-go/blob/master/SECURITY.md) | What this software executes, and how to report a hole in it |\n| [`AGENTS.md`](https://github.com/libtmux/libtmux-go/blob/master/AGENTS.md) | Which of the above applies to what you are changing |\n| [`examples/`](https://github.com/libtmux/libtmux-go/blob/master/examples/) | Runnable programs for each of the above |\n\n## License\n\nMIT. See [`LICENSE`](https://github.com/libtmux/libtmux-go/blob/master/LICENSE).\n\n[tmux]: https://github.com/tmux/tmux\n","changelogMarkdown","videoKey","requiredSecretsJson","publishedAt","priceCents","trialDays","iconType","image","upstream",{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113},"requiredSecrets",[],"tags",[95,96,19,97,24,98,99,100,101],"assets",[],"stats",{"_93":58,"_94":58},"ratingAvg","reviewCount","go","golang","terminal","tmux-go","tmux-golang","tmux-mcp","tui","topics",[95,96,19,114,115,97,24,98,99,100,101],"license","MIT","language","Go","registryName","io.github.libtmux/tmux-mcp-go","homepage","https://github.com/libtmux/libtmux-go/tree/master/mcp","packages",[],"mcp","model-context-protocol","ENV",{"_118":119,"_120":121,"_122":123},"ENVIRONMENT","production","TURNSTILE_SITE_KEY","0x4AAAAAAB8-rEI2gNDf_QhU","SENTRY_DSN","https://45fd1229f78089d5c3ee78be128030e1@o4510583261757440.ingest.de.sentry.io/4510584253448272"]