tmux-tui 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +117 -0
- package/dist/tmuxtui.js +401 -0
- package/package.json +39 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 mark liu
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# tmuxtui
|
|
2
|
+
|
|
3
|
+
Interactive terminal UI for managing tmux sessions. Browse, create, rename, detach, and kill sessions without memorizing tmux commands.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Session browser** — list all tmux sessions sorted by last used, with window count and creation time
|
|
8
|
+
- **Quick attach** — select and attach to any session instantly
|
|
9
|
+
- **Create sessions** — new session with custom name and working directory
|
|
10
|
+
- **Rename / Detach / Kill** — full session lifecycle management
|
|
11
|
+
- **Works everywhere** — runs inside or outside tmux (auto-detects and uses `switch-client` or `attach-session`)
|
|
12
|
+
- **`init` command** — register the current directory as a new tmux session in one step
|
|
13
|
+
|
|
14
|
+
## Requirements
|
|
15
|
+
|
|
16
|
+
- Node.js >= 18
|
|
17
|
+
- tmux >= 3.2
|
|
18
|
+
|
|
19
|
+
## Install
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g tmuxtui
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
### Interactive TUI
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
tmuxtui
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Keyboard shortcuts:
|
|
34
|
+
|
|
35
|
+
| Key | Action |
|
|
36
|
+
|-----|--------|
|
|
37
|
+
| `↑` `↓` | Select session |
|
|
38
|
+
| `Enter` | Attach to session |
|
|
39
|
+
| `n` | New session |
|
|
40
|
+
| `r` | Rename session |
|
|
41
|
+
| `x` | Detach session |
|
|
42
|
+
| `d` | Kill session (with confirm) |
|
|
43
|
+
| `q` | Quit |
|
|
44
|
+
|
|
45
|
+
When creating a new session, press `Tab` to switch between the name and path fields.
|
|
46
|
+
|
|
47
|
+
### Quick register current project
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
tmuxtui init
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Creates a new tmux session named after the current directory and opens it with tmuxtui.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
[English](#tmuxtui) | [中文](#tmuxtui-1)
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
# tmuxtui
|
|
62
|
+
|
|
63
|
+
tmux 会话管理的交互式终端界面。无需记忆 tmux 命令，即可浏览、创建、重命名、分离和销毁会话。
|
|
64
|
+
|
|
65
|
+
## 功能
|
|
66
|
+
|
|
67
|
+
- **会话浏览** — 按最近使用排序列出所有 tmux 会话，显示窗口数和创建时间
|
|
68
|
+
- **快速接入** — 选中会话后一键 attach
|
|
69
|
+
- **创建会话** — 自定义名称和工作目录
|
|
70
|
+
- **重命名 / 分离 / 销毁** — 完整的会话生命周期管理
|
|
71
|
+
- **全场景适配** — 在 tmux 内外均可运行（自动检测并使用 `switch-client` 或 `attach-session`）
|
|
72
|
+
- **`init` 命令** — 一行命令将当前目录注册为新的 tmux 会话
|
|
73
|
+
|
|
74
|
+
## 环境要求
|
|
75
|
+
|
|
76
|
+
- Node.js >= 18
|
|
77
|
+
- tmux >= 3.2
|
|
78
|
+
|
|
79
|
+
## 安装
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
npm install -g tmuxtui
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## 使用
|
|
86
|
+
|
|
87
|
+
### 交互式 TUI
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
tmuxtui
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
快捷键：
|
|
94
|
+
|
|
95
|
+
| 按键 | 操作 |
|
|
96
|
+
|------|------|
|
|
97
|
+
| `↑` `↓` | 选择会话 |
|
|
98
|
+
| `Enter` | 接入会话 |
|
|
99
|
+
| `n` | 新建会话 |
|
|
100
|
+
| `r` | 重命名会话 |
|
|
101
|
+
| `x` | 分离会话 |
|
|
102
|
+
| `d` | 销毁会话（需确认） |
|
|
103
|
+
| `q` | 退出 |
|
|
104
|
+
|
|
105
|
+
创建新会话时，按 `Tab` 在名称和路径输入框之间切换。
|
|
106
|
+
|
|
107
|
+
### 快速注册当前项目
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
tmuxtui init
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
以当前目录名创建 tmux 会话，并通过 tmuxtui 打开。
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
MIT
|