@flux-lang/cli-core 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 +52 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @flux-lang/cli-core
|
|
2
|
+
|
|
3
|
+
1) **What this package is**
|
|
4
|
+
Core command implementations for the Flux CLI (parse/check/render/view/new/add and config helpers).
|
|
5
|
+
|
|
6
|
+
2) **When you use it**
|
|
7
|
+
Use it when embedding Flux CLI behavior inside other tools or UIs (e.g., the Ink UI).
|
|
8
|
+
|
|
9
|
+
3) **Install**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @flux-lang/cli-core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
4) **Basic usage**
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { newCommand } from "@flux-lang/cli-core";
|
|
19
|
+
|
|
20
|
+
const result = await newCommand({
|
|
21
|
+
cwd: process.cwd(),
|
|
22
|
+
template: "demo",
|
|
23
|
+
out: "./demo-doc",
|
|
24
|
+
page: "A4",
|
|
25
|
+
theme: "both",
|
|
26
|
+
fonts: "bookish",
|
|
27
|
+
fontFallback: "system",
|
|
28
|
+
assets: true,
|
|
29
|
+
chapters: 2,
|
|
30
|
+
live: true,
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
5) **Reference**
|
|
35
|
+
- **Command exports** (see `src/index.ts`):
|
|
36
|
+
- `parseCommand`, `checkCommand`, `renderCommand`, `formatCommand`
|
|
37
|
+
- `tickCommand`, `stepCommand`, `viewCommand`, `pdfCommand`
|
|
38
|
+
- `newCommand`, `addCommand`, `configCommand`
|
|
39
|
+
- viewer helpers (`viewer/manager`)
|
|
40
|
+
|
|
41
|
+
6) **How it relates to IR/runtime**
|
|
42
|
+
This package wraps `@flux-lang/core` parsing/rendering and coordinates viewer/runtime stepping for CLI workflows.
|
|
43
|
+
|
|
44
|
+
7) **Gotchas & troubleshooting**
|
|
45
|
+
- Commands return `{ ok, data, error }` shapes; always check `ok` before using `data`.
|
|
46
|
+
|
|
47
|
+
8) **Versioning / compatibility notes**
|
|
48
|
+
TBD / Not yet implemented.
|
|
49
|
+
|
|
50
|
+
9) **Links**
|
|
51
|
+
- Root Flux manual: [`../../README.md`](../../README.md)
|
|
52
|
+
- Source: [`src/`](src/)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flux-lang/cli-core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.14",
|
|
4
4
|
"description": "Core command implementations for Flux CLI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -16,10 +16,10 @@
|
|
|
16
16
|
}
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
|
-
"@flux-lang/core": "^0.1.
|
|
20
|
-
"@flux-lang/
|
|
21
|
-
"@flux-lang/viewer": "^0.1.
|
|
22
|
-
"@flux-lang/
|
|
19
|
+
"@flux-lang/core": "^0.1.14",
|
|
20
|
+
"@flux-lang/render-html": "^0.1.14",
|
|
21
|
+
"@flux-lang/viewer": "^0.1.14",
|
|
22
|
+
"@flux-lang/typesetter": "^0.1.14"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@types/node": "^22.0.0",
|