tsman

KO | EN

gitlite — search

#hacktoberfest #react #typescript #go #android #machine-learning #linux #docker #cli #kubernetes #pytorch #security #mcp #open-source

(★ 63)

a tmux session manager built in rust

tsman Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# tsman

[![CI](https://img.shields.io/github/actions/workflow/status/TecuceanuGabriel/tsman/build.yml?label=CI)](https://github.com/TecuceanuGabriel/tsman/actions)
[![Crates.io](https://img.shields.io/crates/v/tsman?logo=rust)](https://crates.io/crates/tsman)
[![Downloads](https://img.shields.io/crates/d/tsman?color=blue)](https://crates.io/crates/tsman)
[![Tmux](https://img.shields.io/badge/tmux-%3E%3Dv3.2-1BB91F?logo=tmux)](https://github.com/tmux/tmux)
[![License](https://img.shields.io/badge/License-MIT-orange)](https://raw.githubusercontent.com/GabrielTecuceanu/tsman/main/LICENSE)

a feature-rich session manager for tmux

![demo](https://raw.githubusercontent.com/GabrielTecuceanu/tsman/main/assets/demo.gif)

</div>

## Contents

- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
  - [Sessions](#sessions)
  - [Layouts](#layouts)
  - [Menu](#menu-m)
  - [Shell completions](#shell-completions-c)
- [Menu keybindings](#menu-keybindings)
- [Configuration](#configuration)
  - [Config file](#config-file)
  - [Shell / tmux integration](#shell--tmux-integration)
- [Notes](#notes)

## Features

- Quickly save/restore/delete/edit/reload tmux sessions.
- Work with layouts - reusable window/pane structure templates that can be applied to any working directory.
- Manage sessions and layouts from the interactive TUI menu:
  - Use keybindings to trigger actions (Save/Open/Edit/Delete/Rename/Kill/Reload).
  - Toggle between sessions and layouts list views.
  - Create new sessions from layout templates directly in the menu.
  - Fuzzy-find sessions and layouts (powered by
    [fuzzy-matcher](https://github.com/skim-rs/fuzzy-matcher)).
  - View session/layout structure in the preview panel.
- Shell completions for bash, zsh, and fish.

## Requirements

- tmux >= [v3.2](https://github.com/tmux/tmux/releases/tag/3.5a)
  (recommended for the display-popup feature).

## Installation

```bash
cargo install tsman
```

Or via Homebrew:
```bash
brew tap cmtonkinson/tap
brew install tsman
```

## Usage

Each subcommand has a short alias shown in parentheses.

### Sessions

#### Save current session (`s`)

```bash
tsman save <session_name> # save with the specified name
tsman save                # save with the current session name
```

#### Open a session (`o`)

```bash
tsman open <session_name>
```

#### Edit a session config file (`e`)

Opens the config file in `$EDITOR`.

```bash
tsman edit <session_name> # edit the specified session
tsman edit                # edit the current session
```

#### Reload a session (`r`)

Kill the running session and recreate it from its saved config. The session must be both active and saved.

```bash
tsman reload <session_name>
tsman reload # reload the current session
```

#### Delete a session config file (`d`)

```bash
tsman delete <session_name>
```

### Layouts

Layouts capture a session's window/pane structure without working directories, so you can reuse the same arrangement across different projects.

#### Save current session as a layout (`layout s`)

```bash
tsman layout save <layout_name> # save with the specified name
tsman layout save               # save with the current session name
```

#### Create a session from a layout (`layout c`)

All panes in the new session start in the given working directory.

```bash
tsman layout create <layout_name> <work_dir>               # session name defaults to layout name
tsman layout create <layout_name> <work_dir> <session_name> # use a custom session name
```

#### List saved layouts (`layout ls`)

```bash
tsman layout list
```

#### Edit a layout config file (`layout e`)

```bash
tsman layout edit <layout_name>
```

#### Delete a layout (`layout d`)

```bash
tsman layout delete <layout_name>
```

### Menu (`m`)

Open the interactive TUI menu.

```bash
tsman menu
tsman menu --preview              # start with the preview pane on
tsman menu --ask-for-confirmation # prompt before deleting
tsman menu -p -a                  # shorthand for both flags
```

### Shell completions (`c`)

```bash
tsman completions bash > ~/.local/share/bash-completion/completions/tsman
tsman completions zsh > ~/.zfunc/_tsman
tsman completions fish > ~/.config/fish/completions/tsman.fish
```

## Menu keybindings

Navigation:

| Keybinding     | Action               |
| -------------- | -------------------- |
| `Esc` / `C-c`  | Exit menu            |
| `Up` / `C-p`   | Select previous item |
| `Down` / `C-n` | Select next item     |

Session actions:

| Keybinding | Saved session                         | Unsaved session |
| ---------- | ------------------------------------- | --------------- |
| `Enter`    | Open session                          | Open session    |
| `C-s`      | -                                     | Save session    |
| `C-e`      | Edit config file                      | -               |
| `C-d`      | Delete config file                    | Kill session    |
| `C-k`      | Kill session                          | Kill session    |
| `C-r`      | Rename session and update config file | Rename session  |
| `C-o`      | Reload session from saved config      | -               |

Layout actions (when in layouts view):

| Keybinding | Action                           |
| ---------- | -------------------------------- |
| `Enter`    | Create a new session from layout |
| `C-e`      | Edit layout config file          |
| `C-d`      | Delete layout                    |
| `C-r`      | Rename layout                    |

UI controls:

| Keybinding   | Action                      |
| ------------ | --------------------------- |
| `C-l`        | Toggle sessions/layouts     |
| `C-t`        | Toggle preview pane         |
| `C-h`        | Toggle help popup           |
| `C-w`        | Delete last word from input |
| `C-u`        | Delete to line start        |
| `Shift-Up`   | Scroll preview up           |
| `Shift-Down` | Scroll preview down         |

Workdir completion controls (in layout creation):

| Keybinding          | Action                     |
| ------------------- | -------------------------- |
| `Tab` / `C-n`       | Open dropdown / cycle next |
| `Shift-Tab` / `C-p` | Cycle prev                 |
| `Up` / `Down`       | Prev / next                |

Confirmation popup:

| Keybinding              | Action  |
| ----------------------- | ------- |
| `y` / `Y` / `Enter`     | Confirm |
| `n` / `N` / `Esc` / `q` | Abort   |

Help popup:

| Keybinding                            | Action |
| ------------------------------------- | ------ |
| `C-h` / `C-c` / `Esc` / `q` / `Enter` | Close  |

## Configuration

### Config file

tsman reads `~/.config/tsman/config.toml` on startup.

Run the init command to generate one interactively:

```bash
tsman init
```

All fields are optional - omit any section or key to use the default value.

```toml
[menu]
preview = false              # start menu with the preview pane on
ask_for_confirmation = false # prompt before deleting
show_key_presses = false     # show key press hints in the menu footer

[storage]
sessions_dir = "~/.config/.tsessions" # where session YAML files are stored
layouts_dir  = "~/.config/.tlayouts"  # where layout YAML files are stored
```

Precedence (highest to lowest): CLI flag > environment variable > config file > default.

### Shell / tmux integration

You can add keybindings/aliases to your tmux/shell config for faster usage.

`~/.tmux.conf`:

```bash
# open menu in a tmux popup with preview pane and delete confirmation on
# note: requires tmux v3.2+
bind -r f display-popup -E -w 80% -h 80% "tsman menu -p -a"
bind -r C-s run-shell "tsman save"
```

`~/.zshrc`:

```bash
alias mux-fd="tsman menu -p -a"
```

## Notes

- `$EDITOR` must be set to use the edit command.
- Session names must be 1-30 characters, alphanumeric plus `-` and `_`.
- Config files are stored as YAML - you can edit them manually for fine-grained control.

## Contributing

- Please see [CONTRIBUTING.md](./.github/CONTRIBUTING.md)

## Acknowledgements

- [tmuxinator](https://github.com/tmuxinator/tmuxinator)
- [ThePrimeagen's tmux-sessionizer](https://github.com/ThePrimeagen/tmux-sessionizer)

tsman

tsman Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tsman

tsman Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README