create-termui-app 0.1.0 → 0.1.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 +56 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# create-termui-app
|
|
2
|
+
|
|
3
|
+
Scaffold a new TermUI project. Pick a template, choose a theme, start building.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx create-termui-app my-app
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or with a project name directly:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx create-termui-app my-app
|
|
15
|
+
cd my-app
|
|
16
|
+
npm install
|
|
17
|
+
npm run dev
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Templates
|
|
21
|
+
|
|
22
|
+
The CLI prompts you to choose:
|
|
23
|
+
|
|
24
|
+
| Template | What you get |
|
|
25
|
+
|----------|-------------|
|
|
26
|
+
| Empty | Blank project, one file |
|
|
27
|
+
| Dashboard | Real-time gauges and tables |
|
|
28
|
+
| Interactive Tool | Forms, selects, and prompts |
|
|
29
|
+
| CLI Wrapper | Wraps an existing shell command with a UI |
|
|
30
|
+
|
|
31
|
+
## Themes
|
|
32
|
+
|
|
33
|
+
Five themes available at setup: Default, Cyberpunk, Nord, Dracula, Catppuccin.
|
|
34
|
+
|
|
35
|
+
## Features
|
|
36
|
+
|
|
37
|
+
You pick which features to include:
|
|
38
|
+
|
|
39
|
+
- Screen Router (file-based navigation)
|
|
40
|
+
- Data Providers (CPU, memory, disk)
|
|
41
|
+
- Hot Reload (auto-restart on save)
|
|
42
|
+
|
|
43
|
+
## Generated files
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
my-app/
|
|
47
|
+
package.json
|
|
48
|
+
tsconfig.json
|
|
49
|
+
termui.config.ts
|
|
50
|
+
themes/cyberpunk.tss
|
|
51
|
+
src/index.tsx
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-termui-app",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Scaffold a new TermUI app — the create-react-app for terminals",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"dist"
|
|
12
12
|
],
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@termuijs/tss": "0.1.
|
|
14
|
+
"@termuijs/tss": "0.1.1"
|
|
15
15
|
},
|
|
16
16
|
"devDependencies": {
|
|
17
17
|
"tsup": "^8.0.0",
|