# TypeScript

Source: https://libtmux.org/en/ts/latest/

> libtmux for TypeScript, version latest.

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

Drive a real tmux from TypeScript.

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`

Dependency cooldowns

The checkbox turns a cooldown on and off for every picker on the site. It applies to what an install pulls in; the package itself, and the libtmux it pins, stay current.

Cooldown type

Apply a cooldown of days Bypass any global cooldown

What are cooldowns?

Cooldowns delay picking up newly uploaded packages so the community has time to spot supply-chain attacks before you install. Most package managers don't apply one by default; you opt in through a global setting in your tool's configuration.

Learn more at [cooldowns.dev](https://cooldowns.dev/) · [Datadog Security Labs writeup](https://securitylabs.datadoghq.com/articles/dependency-cooldowns/).

```console
$ npm install libtmux
```

```console
$ npm install \
    --min-release-age=7 \
    --min-release-age-exclude=libtmux \
    libtmux
```

```console
$ npm install --min-release-age=0 libtmux
```

### [Workspace Manager](https://libtmux.org/en/ts/latest/workspace/) `@libtmux/workspace-cli`

The workspace package is separate from the core library.

Dependency cooldowns

The checkbox turns a cooldown on and off for every picker on the site. It applies to what an install pulls in; the package itself, and the libtmux it pins, stay current.

Cooldown type

Apply a cooldown of days Bypass any global cooldown

What are cooldowns?

Cooldowns delay picking up newly uploaded packages so the community has time to spot supply-chain attacks before you install. Most package managers don't apply one by default; you opt in through a global setting in your tool's configuration.

Learn more at [cooldowns.dev](https://cooldowns.dev/) · [Datadog Security Labs writeup](https://securitylabs.datadoghq.com/articles/dependency-cooldowns/).

```console
$ npx -y @libtmux/workspace-cli --help
```

```console
$ npx -y @libtmux/workspace-cli --help
```

npx ignores --min-release-age-exclude, so a cooldown here would also hold back the release this runs. This command runs without one.

```console
$ npx -y --min-release-age=0 @libtmux/workspace-cli --help
```

Runs tmux-workspace without installing it. Pass a command such as load ./workspace.yaml in place of --help.

### [MCP](https://libtmux.org/en/ts/latest/mcp/) `@libtmux/mcp`

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

```console
$ claude mcp add tmux -- npx -y @libtmux/mcp
```

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

### [Topics](https://libtmux.org/en/ts/latest/topics/)

[Subject-by-subject, with TypeScript in every code block.](https://libtmux.org/en/ts/latest/topics/)

### [Guides](https://libtmux.org/en/ts/latest/guides/)

[Task guides for TypeScript.](https://libtmux.org/en/ts/latest/guides/)

### [Examples](https://libtmux.org/en/ts/latest/examples/)

[Complete programs, sourced from the code each port tests.](https://libtmux.org/en/ts/latest/examples/)

### [Concepts](https://libtmux.org/en/ts/latest/concepts/)

[The domain model every port shares.](https://libtmux.org/en/ts/latest/concepts/)

## Packages and integrations

### [Workspace Manager](https://libtmux.org/en/ts/latest/workspace/)

[Load workspace files with the tmux-workspace load prerelease.](https://libtmux.org/en/ts/latest/workspace/)

### [MCP](https://libtmux.org/en/ts/latest/mcp/)

[In development. Connect an MCP client to tmux tools and inspect the server API.](https://libtmux.org/en/ts/latest/mcp/)

## API references

### [Official reference](https://libtmux.org/en/ts/latest/reference/)

[TypeScript API signatures and documentation, with links to related guides and APIs in other languages.](https://libtmux.org/en/ts/latest/reference/)

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