@ui8kit/uxdx 0.1.3 → 0.1.5
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 +38 -72
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,114 +1,80 @@
|
|
|
1
1
|
# UXDX
|
|
2
2
|
|
|
3
|
-
CLI for operator files and SDLC harness packs.
|
|
4
|
-
commands. Package: [`@ui8kit/uxdx`](https://www.npmjs.com/package/@ui8kit/uxdx).
|
|
3
|
+
CLI for creating operator files and installing SDLC harness packs.
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
Package: [`@ui8kit/uxdx`](https://www.npmjs.com/package/@ui8kit/uxdx)
|
|
6
|
+
Source: [github.com/ui8kit/uxdx](https://github.com/ui8kit/uxdx)
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Quick start
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Create the operator layout in the current directory:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
|
|
14
|
-
bunx @ui8kit/uxdx -p
|
|
15
|
-
bunx @ui8kit/uxdx -s --level light
|
|
13
|
+
npx @ui8kit/uxdx@latest -p
|
|
16
14
|
```
|
|
17
15
|
|
|
18
|
-
|
|
16
|
+
Install one SDLC harness level:
|
|
19
17
|
|
|
20
18
|
```bash
|
|
21
|
-
npx @ui8kit/uxdx@latest --
|
|
22
|
-
npx @ui8kit/uxdx@latest -- -p
|
|
23
|
-
npx @ui8kit/uxdx@latest -- -s --level light
|
|
19
|
+
npx @ui8kit/uxdx@latest -s --level light
|
|
24
20
|
```
|
|
25
21
|
|
|
26
|
-
|
|
27
|
-
CLI. `--` keeps flags for `uxdx` (`npx` also has `-p`). Success still requires
|
|
28
|
-
`uxdx: project init` or `uxdx: sdlc …` after the warning.
|
|
29
|
-
|
|
30
|
-
After a local or global install the binary is unscoped:
|
|
22
|
+
You can use `bunx` instead of `npx`:
|
|
31
23
|
|
|
32
24
|
```bash
|
|
33
|
-
|
|
34
|
-
uxdx --help
|
|
35
|
-
|
|
36
|
-
npm i -D @ui8kit/uxdx
|
|
37
|
-
npx uxdx --help
|
|
25
|
+
bunx @ui8kit/uxdx -p
|
|
38
26
|
```
|
|
39
27
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
Aliases are equivalent. `init` is the default and may be omitted.
|
|
28
|
+
Do not place `--` after the package name. If `npx` prints a `punycode`
|
|
29
|
+
deprecation warning, it comes from npm and does not prevent UXDX from running.
|
|
43
30
|
|
|
44
|
-
|
|
45
|
-
uxdx [--help]
|
|
46
|
-
uxdx project | p | -p | --project [init] [--dir <path>] [--rules] [--force]
|
|
47
|
-
uxdx sdlc | s | -s | --sdlc [init] [--dir <path>] --level light|core|full [--force] [--no-install]
|
|
48
|
-
```
|
|
31
|
+
## Project layout
|
|
49
32
|
|
|
50
|
-
|
|
51
|
-
| --- | --- | --- |
|
|
52
|
-
| `--dir <path>` | both | Target repo (default: cwd) |
|
|
53
|
-
| `--force` | both | Overwrite files this tool owns |
|
|
54
|
-
| `--rules` | `project` | Stub `.cursor/rules/uxdx.mdc` if missing |
|
|
55
|
-
| `--level` | `sdlc` | Required: `light`, `core`, or `full` |
|
|
56
|
-
| `--no-install` | `sdlc` | Copy `.sdlc/` only; skip `sdlc.sh install` |
|
|
33
|
+
`-p` is an alias for `project`. It creates or updates:
|
|
57
34
|
|
|
58
|
-
|
|
35
|
+
- `README.md`
|
|
36
|
+
- `.gitignore`
|
|
37
|
+
- `.cursorignore`
|
|
38
|
+
- `.project/README.md`
|
|
39
|
+
- `.manual/.gitkeep` when `.manual/` does not exist
|
|
59
40
|
|
|
60
|
-
|
|
61
|
-
|
|
41
|
+
Existing content is preserved unless `--force` is used. Operator notes under
|
|
42
|
+
`.manual/` remain ignored by Git.
|
|
62
43
|
|
|
63
44
|
```bash
|
|
64
|
-
|
|
65
|
-
|
|
45
|
+
npx @ui8kit/uxdx@latest -p --dir ./my-repo
|
|
46
|
+
npx @ui8kit/uxdx@latest -p --rules
|
|
66
47
|
```
|
|
67
48
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
- `README.md` (only if missing)
|
|
71
|
-
- `.gitignore` (`.manual/*` + `!.manual/.gitkeep`)
|
|
72
|
-
- `.cursorignore` (`.manual/`)
|
|
73
|
-
- `.project/README.md` stub
|
|
74
|
-
- `.manual/.gitkeep` (only if `.manual/` is missing)
|
|
49
|
+
## SDLC harness
|
|
75
50
|
|
|
76
|
-
|
|
51
|
+
`-s` is an alias for `sdlc`. `--level` is required:
|
|
77
52
|
|
|
78
|
-
```
|
|
79
|
-
uxdx
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
.cursorignore
|
|
83
|
-
.project/
|
|
84
|
-
.manual/
|
|
53
|
+
```bash
|
|
54
|
+
npx @ui8kit/uxdx@latest -s --level light
|
|
55
|
+
npx @ui8kit/uxdx@latest -s --level core
|
|
56
|
+
npx @ui8kit/uxdx@latest -s --level full
|
|
85
57
|
```
|
|
86
58
|
|
|
87
|
-
|
|
59
|
+
The command copies one pack into `.sdlc/` and runs its installer. Use
|
|
60
|
+
`--no-install` to copy only, or `--dir <path>` to target another repository.
|
|
61
|
+
Do not combine multiple levels in one repository.
|
|
88
62
|
|
|
89
|
-
|
|
90
|
-
`full`). Then runs `.sdlc/sdlc.sh install` unless `--no-install`.
|
|
63
|
+
## Help
|
|
91
64
|
|
|
92
65
|
```bash
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
66
|
+
npx @ui8kit/uxdx@latest --help
|
|
67
|
+
npx @ui8kit/uxdx@latest -p --help
|
|
68
|
+
npx @ui8kit/uxdx@latest -s --help
|
|
96
69
|
```
|
|
97
70
|
|
|
98
|
-
|
|
99
|
-
different level.
|
|
100
|
-
|
|
101
|
-
Pack source: `packages/sdlc/harness/`.
|
|
102
|
-
|
|
103
|
-
## This checkout
|
|
71
|
+
## Development
|
|
104
72
|
|
|
105
73
|
```bash
|
|
106
74
|
bun install
|
|
107
75
|
bun test
|
|
108
76
|
bun run build
|
|
109
77
|
bun run uxdx -- --help
|
|
110
|
-
bun run uxdx -- -p --help
|
|
111
|
-
bun run uxdx -- -s --help
|
|
112
78
|
```
|
|
113
79
|
|
|
114
|
-
|
|
80
|
+
The separator `--` is required only after `bun run uxdx`.
|