@involvex/disk-tui 0.0.0-stage → 0.0.1
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 +74 -2
- package/dist/cli.js +47918 -0
- package/package.json +58 -4
package/README.md
CHANGED
|
@@ -1,3 +1,75 @@
|
|
|
1
|
-
#
|
|
1
|
+
# disk-tui
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A modern CLI / TUI app built with [Ink](https://github.com/vadimdemedes/ink) and [Bun](https://bun.sh) to display disk information in the terminal.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Cross-platform disk / mount info (Windows via PowerShell CIM, Linux/macOS/Android Termux via `df`)
|
|
8
|
+
- Interactive menu (Disk Info, Help, Settings, About, Version, Exit)
|
|
9
|
+
- Formatted, human-readable sizes (B/KB/MB/GB/TB/PB)
|
|
10
|
+
- CLI flags: `--help`, `--version`, `--about`
|
|
11
|
+
|
|
12
|
+
## Requirements
|
|
13
|
+
|
|
14
|
+
- Node.js >= 16 (or Bun)
|
|
15
|
+
- Bun (for development / build)
|
|
16
|
+
|
|
17
|
+
## Install / Run
|
|
18
|
+
|
|
19
|
+
Run directly with Bun:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
bun run src/cli.tsx
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or build and run the compiled CLI:
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
bun run build
|
|
29
|
+
node dist/cli.js
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Install globally (after build/publish):
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
npm install -g @involvex/disk-tui
|
|
36
|
+
disk-tui
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
disk-tui # launch interactive TUI (starts on Disk Info)
|
|
43
|
+
disk-tui --help # show help
|
|
44
|
+
disk-tui --version # show version
|
|
45
|
+
disk-tui --about # show about
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Navigation: `↑/↓` navigate menu, `Enter` select, `Esc` go back.
|
|
49
|
+
|
|
50
|
+
## Development
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
bun run dev # hot reload
|
|
54
|
+
bun run start # run source
|
|
55
|
+
bun run build # typecheck + lint + format + bundle
|
|
56
|
+
bun run lint # lint src
|
|
57
|
+
bun run format # format
|
|
58
|
+
bun run typecheck # type check
|
|
59
|
+
bun test # tests
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Project Structure
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
src/
|
|
66
|
+
cli.tsx # entry point + meow CLI flags
|
|
67
|
+
app.tsx # screen router + menu
|
|
68
|
+
commands/ # disk-info, help, about, version, settings, exit
|
|
69
|
+
components/ # menu, select-input
|
|
70
|
+
lib/ # disk-info (platform data gathering)
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## License
|
|
74
|
+
|
|
75
|
+
MIT © involvex
|