Rust

Drive a real tmux from Rust.

libtmux

You are reading the latest documentation. Use the version control in the header to move between releases, or the port dropdown to find a corresponding page in another language.

Install

Library `libtmux`

$ cargo add libtmux

Workspace Manager `tmux-workspace`

The workspace package is separate from the core library.

$ cargo install --locked --version 0.1.0-alpha.15 tmux-workspace

Needs Rust 1.85 or newer. cargo install skips prereleases unless asked, so the command names the version. This builds and installs the native CLI; run tmux-workspace --help afterward.

MCP `tmux-mcp`

Choose your client and configuration scope, then run the command or paste the configuration.

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ claude mcp add tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.claude.json (this project)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ claude mcp add tmux --scope user -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.claude.json (all projects)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ claude mcp add tmux --scope project -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .mcp.json (in repo, version-controlled)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: claude_desktop_config.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ codex mcp add tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.codex/config.toml

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

Codex's CLI doesn't support project scope yet — paste this into .codex/config.toml at the repo root.

[mcp_servers.tmux]
command = "tmux-mcp"

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .codex/config.toml (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ gemini mcp add --scope user tmux tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.gemini/settings.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ gemini mcp add --scope project tmux tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .gemini/settings.json (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: .cursor/mcp.json (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.cursor/mcp.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ grok mcp add --scope user tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.grok/config.toml

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ grok mcp add --scope project tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ./.grok/config.toml (in repo)

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then use this config:

{
    "mcpServers": {
        "tmux": {
            "command": "tmux-mcp"
        }
    }
}

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.gemini/config/mcp_config.json

Build or install the server first:

$ cargo install tmux-mcp --version 0.1.0-alpha.13

Then register:

$ opencode mcp add tmux -- tmux-mcp

Cargo requires an explicit prerelease version. The installed `tmux-mcp` binary speaks MCP on stdin and stdout.

Config file: ~/.config/opencode/opencode.jsonc

Packages and integrations

Workspace Manager

Load workspace files with the tmux-workspace load prerelease.

MCP

In development. Connect an MCP client to tmux tools and inspect the server API.

API references

Official reference

Rust API signatures and documentation, with links to related guides and APIs in other languages.

docs.rs documentation

Rust API documentation for published crate versions on docs.rs.

All Rust versions and install instructions

Scripting & web

Compiled & native

JVM

.NET

tmux

Rust

Install

Library `libtmux`

Workspace Manager `tmux-workspace`

MCP `tmux-mcp`

Topics

Guides

Examples

Concepts

Packages and integrations

Workspace Manager

MCP

API references

Official reference

docs.rs documentation

Rust

Install

Library libtmux

Workspace Manager tmux-workspace

MCP tmux-mcp

Topics

Guides

Examples

Concepts

Packages and integrations

Workspace Manager

MCP

API references

Official reference

docs.rs documentation ↗︎

Library `libtmux`

Workspace Manager `tmux-workspace`

MCP `tmux-mcp`

docs.rs documentation