tuidoscope 0.1.4
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/README.md +110 -0
- package/dist/index.js +1717 -0
- package/package.json +50 -0
package/README.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# tuidoscope
|
|
2
|
+
|
|
3
|
+
A centralized TUI management application for running multiple TUI applications in embedded terminal windows. Built with [OpenTUI](https://github.com/opentui/opentui) and SolidJS.
|
|
4
|
+
|
|
5
|
+
## Screenshots
|
|
6
|
+
|
|
7
|
+
### Main Interface
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### Running TUI Applications
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Command Palette
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Edit App Modal
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## Features
|
|
20
|
+
|
|
21
|
+
- **Embedded Terminals**: Run multiple TUIs in a single window using Ghostty's high-performance terminal emulator.
|
|
22
|
+
- **Tab Management**: Organize and switch between different applications using a vertical sidebar.
|
|
23
|
+
- **Command Palette**: Quickly search and switch between apps or perform actions with a fuzzy-search palette (Ctrl+P).
|
|
24
|
+
- **Runtime Management**: Add, edit, and remove application entries directly within the app without restarting.
|
|
25
|
+
- **Session Persistence**: Automatically remembers and restores your running applications and active tab between restarts.
|
|
26
|
+
- **Highly Configurable**: Customize themes, keybinds, and application lists via YAML.
|
|
27
|
+
- **Path Expansion**: Supports `~` and `<CONFIG_DIR>` tokens in working directory paths.
|
|
28
|
+
|
|
29
|
+
## Tech Stack
|
|
30
|
+
|
|
31
|
+
- **Runtime**: [Bun](https://bun.sh/)
|
|
32
|
+
- **Framework**: [SolidJS](https://www.solidjs.com/)
|
|
33
|
+
- **TUI Engine**: [OpenTUI](https://github.com/opentui/opentui)
|
|
34
|
+
- **Terminal Emulator**: [ghostty-opentui](https://github.com/remorses/ghostty-opentui)
|
|
35
|
+
- **PTY**: `node-pty` (via `spawn-pty`)
|
|
36
|
+
|
|
37
|
+
## Getting Started
|
|
38
|
+
|
|
39
|
+
### Prerequisites
|
|
40
|
+
|
|
41
|
+
- [Bun](https://bun.sh/) runtime installed on your system.
|
|
42
|
+
- A terminal that supports TUI applications (xterm-256color recommended).
|
|
43
|
+
|
|
44
|
+
### Installation
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
bun install
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Usage
|
|
51
|
+
|
|
52
|
+
Start the application in development mode:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
bun dev
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Build for production:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
bun run build
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Configuration
|
|
65
|
+
|
|
66
|
+
Tuidoscope looks for a configuration file at `~/.config/tuidoscope/config.yaml`. It also supports a local `tuidoscope.yaml` in the current working directory for project-specific setups.
|
|
67
|
+
|
|
68
|
+
### Default Keybinds
|
|
69
|
+
|
|
70
|
+
| Action | Default Keybind |
|
|
71
|
+
|--------|-----------------|
|
|
72
|
+
| Next Tab | `Ctrl+N` |
|
|
73
|
+
| Previous Tab | `Ctrl+P` |
|
|
74
|
+
| Toggle Focus (Tabs/Terminal) | `Ctrl+A` |
|
|
75
|
+
| New Tab | `Ctrl+T` |
|
|
76
|
+
| Edit App | `Ctrl+E` |
|
|
77
|
+
| Command Palette | `Ctrl+Space` (or `Ctrl+P`) |
|
|
78
|
+
| Stop Current App | `Ctrl+X` |
|
|
79
|
+
| Close Tab | `Ctrl+W` |
|
|
80
|
+
| Restart Current App | `Ctrl+Shift+R` |
|
|
81
|
+
| Kill All Apps | `Ctrl+Shift+K` |
|
|
82
|
+
| Quit Tuidoscope | `Ctrl+Q` |
|
|
83
|
+
|
|
84
|
+
### Theme Customization
|
|
85
|
+
|
|
86
|
+
You can customize the theme in your `config.yaml`:
|
|
87
|
+
|
|
88
|
+
```yaml
|
|
89
|
+
theme:
|
|
90
|
+
primary: "#7aa2f7"
|
|
91
|
+
background: "#1a1b26"
|
|
92
|
+
foreground: "#c0caf5"
|
|
93
|
+
accent: "#bb9af7"
|
|
94
|
+
muted: "#565f89"
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Change Log
|
|
98
|
+
|
|
99
|
+
### v0.1.0
|
|
100
|
+
- Initial release.
|
|
101
|
+
- Embedded terminal windows via `ghostty-opentui`.
|
|
102
|
+
- Vertical tab sidebar for application management.
|
|
103
|
+
- Command palette with fuzzy search.
|
|
104
|
+
- Session persistence (running apps & active tab).
|
|
105
|
+
- Runtime application configuration (Add/Edit).
|
|
106
|
+
- Path expansion for working directories.
|
|
107
|
+
|
|
108
|
+
## Development
|
|
109
|
+
|
|
110
|
+
- **Typecheck**: `bun run typecheck`
|