tuidoscope 0.1.4 → 0.1.7
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 +34 -4
- package/dist/index.js +705 -461
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -41,13 +41,37 @@ A centralized TUI management application for running multiple TUI applications i
|
|
|
41
41
|
- [Bun](https://bun.sh/) runtime installed on your system.
|
|
42
42
|
- A terminal that supports TUI applications (xterm-256color recommended).
|
|
43
43
|
|
|
44
|
+
### Quick Start (No Install)
|
|
45
|
+
|
|
46
|
+
Run tuidoscope instantly without installing:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
bunx tuidoscope
|
|
50
|
+
```
|
|
51
|
+
|
|
44
52
|
### Installation
|
|
45
53
|
|
|
54
|
+
Install globally:
|
|
55
|
+
|
|
46
56
|
```bash
|
|
47
|
-
bun install
|
|
57
|
+
bun install -g tuidoscope
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Then run from anywhere:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
tuidoscope
|
|
48
64
|
```
|
|
49
65
|
|
|
50
|
-
|
|
66
|
+
## Development
|
|
67
|
+
|
|
68
|
+
Clone the repository and install dependencies:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
git clone https://github.com/shuv1337/tuidoscope.git
|
|
72
|
+
cd tuidoscope
|
|
73
|
+
bun install
|
|
74
|
+
```
|
|
51
75
|
|
|
52
76
|
Start the application in development mode:
|
|
53
77
|
|
|
@@ -61,6 +85,12 @@ Build for production:
|
|
|
61
85
|
bun run build
|
|
62
86
|
```
|
|
63
87
|
|
|
88
|
+
Run typechecks:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
bun run typecheck
|
|
92
|
+
```
|
|
93
|
+
|
|
64
94
|
## Configuration
|
|
65
95
|
|
|
66
96
|
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.
|
|
@@ -105,6 +135,6 @@ theme:
|
|
|
105
135
|
- Runtime application configuration (Add/Edit).
|
|
106
136
|
- Path expansion for working directories.
|
|
107
137
|
|
|
108
|
-
##
|
|
138
|
+
## License
|
|
109
139
|
|
|
110
|
-
|
|
140
|
+
MIT
|