@textui/cli 0.1.0 → 0.3.0
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 +16 -18
- package/dist/bin.js +0 -0
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
# @textui/cli
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@textui/cli) [](https://github.com/softov/textui/blob/main/LICENSE)
|
|
4
|
+
|
|
5
|
+
`textui` - set a project up, copy components into it, and find out what the terminal in front of you can actually do.
|
|
5
6
|
|
|
6
7
|
```bash
|
|
7
8
|
npx @textui/cli init
|
|
@@ -9,9 +10,7 @@ npx @textui/cli init
|
|
|
9
10
|
|
|
10
11
|
## Components are copied, not imported
|
|
11
12
|
|
|
12
|
-
`@textui/widgets` is a dependency you install. The registry behind `textui add`
|
|
13
|
-
is the opposite: it writes the source into your project and you own it from
|
|
14
|
-
there, edits included.
|
|
13
|
+
[`@textui/widgets`](https://www.npmjs.com/package/@textui/widgets) is a dependency you install. The registry behind `textui add` is the opposite: it writes the source into your project and you own it from there, edits included.
|
|
15
14
|
|
|
16
15
|
```bash
|
|
17
16
|
textui add service-table # writes src/ui/service-table.tsx
|
|
@@ -19,9 +18,7 @@ textui create dashboard # writes a whole screen
|
|
|
19
18
|
textui diff # what you have edited since it was copied
|
|
20
19
|
```
|
|
21
20
|
|
|
22
|
-
`diff` matters because owning the source means upstream fixes do not reach you.
|
|
23
|
-
It tells you which files have drifted, so an update is a decision rather than a
|
|
24
|
-
surprise.
|
|
21
|
+
`diff` matters because owning the source means upstream fixes do not reach you. It tells you which files have drifted, so an update is a decision rather than a surprise.
|
|
25
22
|
|
|
26
23
|
## Commands
|
|
27
24
|
|
|
@@ -36,23 +33,24 @@ surprise.
|
|
|
36
33
|
| `diff` | Which copied components have drifted from upstream |
|
|
37
34
|
| `doctor` | What this terminal can do, and what the project looks like |
|
|
38
35
|
|
|
39
|
-
`doctor` is the one to run first when something renders wrong: it reports the
|
|
40
|
-
unicode level, colour depth, mouse and keyboard protocol actually detected,
|
|
41
|
-
which is usually the answer.
|
|
36
|
+
`doctor` is the one to run first when something renders wrong: it reports the unicode level, colour depth, mouse and keyboard protocol actually detected, which is usually the answer.
|
|
42
37
|
|
|
43
38
|
## Building your own
|
|
44
39
|
|
|
45
|
-
`createCli()` is exported, and `@textui/cli/app` is the primitives under it -
|
|
46
|
-
commands, options, help and prompts. Deliberately small: the point is that an
|
|
47
|
-
application built on TextUI can combine plain commands with interactive screens
|
|
48
|
-
without a second framework and a second idea of what an argument is.
|
|
40
|
+
`createCli()` is exported, and `@textui/cli/app` is the primitives under it - commands, options, help and prompts. Deliberately small: the point is that an application built on TextUI can combine plain commands with interactive screens without a second framework and a second idea of what an argument is.
|
|
49
41
|
|
|
50
42
|
## Runtime
|
|
51
43
|
|
|
52
|
-
Depends on `@textui/core` and `@textui/terminal
|
|
53
|
-
and `node:crypto` - it is the one library package here that touches a disk.
|
|
54
|
-
Node 22+ and Bun.
|
|
44
|
+
Depends on [`@textui/core`](https://www.npmjs.com/package/@textui/core) and [`@textui/terminal`](https://www.npmjs.com/package/@textui/terminal). Uses `node:fs`, `node:path` and `node:crypto` - it is the one library package here that touches a disk. Node 22+ and Bun.
|
|
55
45
|
|
|
56
46
|
## Documentation
|
|
57
47
|
|
|
58
48
|
<https://softov.github.io/textui/>
|
|
49
|
+
|
|
50
|
+
<!-- family -->
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
Part of **[TextUI](https://github.com/softov/textui)** - [documentation](https://softov.github.io/textui/) - [getting started](https://softov.github.io/textui/getting-started.html)
|
|
55
|
+
|
|
56
|
+
[`@textui/kit`](https://www.npmjs.com/package/@textui/kit) one install · [`@textui/core`](https://www.npmjs.com/package/@textui/core) the runtime · [`@textui/widgets`](https://www.npmjs.com/package/@textui/widgets) the catalog · [`@textui/terminal`](https://www.npmjs.com/package/@textui/terminal) adapters and input · [`@textui/testing`](https://www.npmjs.com/package/@textui/testing) the harness · **`@textui/cli`** the CLI
|
package/dist/bin.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@textui/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "TextUI developer CLI - init, add, create, doctor - and primitives for building your own",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"terminal",
|
|
@@ -45,17 +45,17 @@
|
|
|
45
45
|
"import": "./dist/app.js"
|
|
46
46
|
}
|
|
47
47
|
},
|
|
48
|
-
"dependencies": {
|
|
49
|
-
"@textui/core": "^0.1.0",
|
|
50
|
-
"@textui/widgets": "^0.1.0",
|
|
51
|
-
"@textui/terminal": "^0.1.0"
|
|
52
|
-
},
|
|
53
|
-
"publishConfig": {
|
|
54
|
-
"access": "public"
|
|
55
|
-
},
|
|
56
48
|
"scripts": {
|
|
57
49
|
"build": "tsc -p tsconfig.json",
|
|
58
50
|
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json",
|
|
59
51
|
"test": "vitest run"
|
|
52
|
+
},
|
|
53
|
+
"dependencies": {
|
|
54
|
+
"@textui/core": "^0.3.0",
|
|
55
|
+
"@textui/terminal": "^0.3.0",
|
|
56
|
+
"@textui/widgets": "^0.3.0"
|
|
57
|
+
},
|
|
58
|
+
"publishConfig": {
|
|
59
|
+
"access": "public"
|
|
60
60
|
}
|
|
61
|
-
}
|
|
61
|
+
}
|