@flux-lang/cli-ui 0.1.13 → 0.1.14
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 +40 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @flux-lang/cli-ui
|
|
2
|
+
|
|
3
|
+
1) **What this package is**
|
|
4
|
+
Ink-based terminal UI for the Flux CLI.
|
|
5
|
+
|
|
6
|
+
2) **When you use it**
|
|
7
|
+
Use it when you want an interactive TTY UI on top of the CLI command set.
|
|
8
|
+
|
|
9
|
+
3) **Install**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @flux-lang/cli-ui
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
4) **Basic usage**
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { runCliUi } from "@flux-lang/cli-ui";
|
|
19
|
+
import { coerceVersionInfo } from "@flux-lang/brand";
|
|
20
|
+
|
|
21
|
+
await runCliUi({ cwd: process.cwd(), versionInfo: coerceVersionInfo({ version: "0.1.13" }) });
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
5) **Reference**
|
|
25
|
+
- **Public entry point**: `@flux-lang/cli-ui` → `src/index.tsx`
|
|
26
|
+
- **UI launcher**: `runCliUi` (calls Ink `render()` with the app shell)
|
|
27
|
+
- **State exports**: `dashboard-machine`
|
|
28
|
+
|
|
29
|
+
6) **How it relates to IR/runtime**
|
|
30
|
+
The UI delegates all parsing/rendering/runtime work to `@flux-lang/cli-core` and surfaces status for docstep/time/seed.
|
|
31
|
+
|
|
32
|
+
7) **Gotchas & troubleshooting**
|
|
33
|
+
- The UI is intended for TTY environments; for non-interactive usage, use the plain CLI with `--no-ui`.
|
|
34
|
+
|
|
35
|
+
8) **Versioning / compatibility notes**
|
|
36
|
+
TBD / Not yet implemented.
|
|
37
|
+
|
|
38
|
+
9) **Links**
|
|
39
|
+
- Root Flux manual: [`../../README.md`](../../README.md)
|
|
40
|
+
- Source: [`src/`](src/)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flux-lang/cli-ui",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.14",
|
|
4
4
|
"description": "Ink-based UI for the Flux CLI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -19,8 +19,8 @@
|
|
|
19
19
|
"chalk": "^5.4.1",
|
|
20
20
|
"ink": "^4.4.1",
|
|
21
21
|
"react": "^18.3.1",
|
|
22
|
-
"@flux-lang/brand": "^0.1.
|
|
23
|
-
"@flux-lang/cli-core": "^0.1.
|
|
22
|
+
"@flux-lang/brand": "^0.1.14",
|
|
23
|
+
"@flux-lang/cli-core": "^0.1.14"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
26
|
"@types/node": "^22.0.0",
|