# Ruby

Source: https://libtmux.org/en/ruby/v0.1.0.alpha.2/

> libtmux for Ruby, version v0.1.0.alpha.2.

![](https://libtmux.org/en/brand/ruby/library/logo.svg)

Drive a real tmux from Ruby.

libtmux

You are reading the **v0.1.0.alpha.2** 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`

```console
$ gem install --version 0.1.0.alpha.1 libtmux
```

### [Workspace Manager](https://libtmux.org/en/ruby/v0.1.0.alpha.2/workspace/) `libtmux-workspace`

The workspace package is separate from the core library.

```console
$ gem install --version 0.1.0.alpha.1 libtmux-workspace
```

### [MCP](https://libtmux.org/en/ruby/v0.1.0.alpha.2/mcp/) `libtmux-mcp`

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

With [RubyGems ](https://rubygems.org/gems/libtmux-mcp)installed:

```console
$ claude mcp add tmux -- libtmux-mcp --socket-name libtmux-docs --endpoint local
```

The server borrows an existing named socket. Start it first with \`tmux -L libtmux-docs new-session -d\`; \`--endpoint\` is only its public alias.

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

### [Topics](https://libtmux.org/en/ruby/v0.1.0.alpha.2/topics/)

[Subject-by-subject, with Ruby in every code block.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/topics/)

### [Guides](https://libtmux.org/en/ruby/v0.1.0.alpha.2/guides/)

[Task guides for Ruby.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/guides/)

### [Examples](https://libtmux.org/en/ruby/v0.1.0.alpha.2/examples/)

[Complete programs, sourced from the code each port tests.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/examples/)

### [Concepts](https://libtmux.org/en/ruby/v0.1.0.alpha.2/concepts/)

[The domain model every port shares.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/concepts/)

## Packages and integrations

### [Async](https://libtmux.org/en/ruby/v0.1.0.alpha.2/guides/async/)

[Use the libtmux-async companion package for asynchronous tmux work.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/guides/async/)

### [MCP](https://libtmux.org/en/ruby/v0.1.0.alpha.2/mcp/)

[Configure libtmux-mcp and inspect its tmux tool protocol.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/mcp/)

### [Workspace Manager](https://libtmux.org/en/ruby/v0.1.0.alpha.2/workspace/)

[Validate, plan, and load workspace configuration with libtmux-workspace.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/workspace/)

## API references

### [Official reference](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/)

[Ruby API signatures and documentation, with links to related guides and APIs in other languages.](https://libtmux.org/en/ruby/v0.1.0.alpha.2/reference/)

[All Ruby versions and install instructions](https://libtmux.org/en/ruby/)