@booga/vcli 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/CHANGELOG.md +16 -0
- package/README.md +26 -45
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.1.1] - 2026-05-24
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- `demo/` example consumer: a real one-page MDX site that exercises
|
|
13
|
+
`vcli ssg build` end to end. Build produces `out/index.html` in roughly
|
|
14
|
+
20 ms; browser render verified against the expected DOM. Lives in the
|
|
15
|
+
repo for review, not shipped to npm (`files` ships only `dist/`).
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
- README rewritten in avatar voice, GTM-oriented. Adds a 10-second quick
|
|
20
|
+
start, a "what it does" surface, and an end-to-end verification section
|
|
21
|
+
citing the `demo/` evidence.
|
|
22
|
+
- `package.json` description aligned to avatar voice.
|
|
23
|
+
|
|
8
24
|
## [0.1.0] - 2026-05-24
|
|
9
25
|
|
|
10
26
|
### Added
|
package/README.md
CHANGED
|
@@ -1,63 +1,44 @@
|
|
|
1
1
|
# @booga/vcli
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
required.
|
|
3
|
+
My terminal handle on the vsuite. Registry browsing, vSsg static-site build,
|
|
4
|
+
straight from the shell. No host project, no React wiring.
|
|
6
5
|
|
|
7
|
-
##
|
|
6
|
+
## Quick start, 10 seconds
|
|
8
7
|
|
|
9
8
|
```bash
|
|
10
|
-
|
|
11
|
-
# or, ad-hoc:
|
|
12
|
-
npx @booga/vcli --help
|
|
9
|
+
npx @booga/vcli registry list
|
|
13
10
|
```
|
|
14
11
|
|
|
15
|
-
|
|
12
|
+
Every vsuite component, id, category, name, off the live registry. No clone,
|
|
13
|
+
no install, no project, no config. One command, instant catalog.
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
## What it does
|
|
18
16
|
|
|
19
|
-
|
|
17
|
+
- `vcli registry list` — full catalog. `--json` for pipes, `-c <cat>` to
|
|
18
|
+
filter.
|
|
19
|
+
- `vcli registry inspect <id>` — one entry, JSON, schema and example props
|
|
20
|
+
included. Exit 1 on miss.
|
|
21
|
+
- `vcli ssg build <config>` — runs the vSsg pipeline. Dynamic-imports the
|
|
22
|
+
config file, walks routes, compiles MDX, emits HTML, prints page count,
|
|
23
|
+
asset count, duration. Exit 1 on failure, message attached.
|
|
24
|
+
- Programmatic mount: `registerRegistryCmd(cmd)`, `registerSsgCmd(cmd)`.
|
|
25
|
+
Attaches the same subcommand trees to any host commander program.
|
|
20
26
|
|
|
21
|
-
|
|
22
|
-
vcli registry list # human-readable
|
|
23
|
-
vcli registry list --json # JSON, pipe-friendly
|
|
24
|
-
vcli registry list -c block # filter by category
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
### `vcli registry inspect <id>`
|
|
28
|
-
|
|
29
|
-
Print one entry as JSON (schema, default props, source, dependencies).
|
|
27
|
+
## Install
|
|
30
28
|
|
|
31
29
|
```bash
|
|
32
|
-
|
|
30
|
+
npm install -g @booga/vcli
|
|
31
|
+
npx @booga/vcli --help
|
|
33
32
|
```
|
|
34
33
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
### `vcli ssg build <config>`
|
|
34
|
+
## Verified end-to-end
|
|
38
35
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
36
|
+
`demo/` ships a real consumer. One MDX page, real install of `@booga/vssg`,
|
|
37
|
+
`vcli ssg build vssg.config.js` produces `out/index.html`. Renders in
|
|
38
|
+
headless Chromium with the expected DOM, h1, p, 3 li, stylesheet link, 0
|
|
39
|
+
page errors. No mocks, the published binary against the published pipeline.
|
|
42
40
|
|
|
43
41
|
```bash
|
|
44
|
-
vcli ssg build vssg.config.js
|
|
45
|
-
# built
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Exits 1 with the error message if the pipeline throws.
|
|
49
|
-
|
|
50
|
-
## Programmatic API
|
|
51
|
-
|
|
52
|
-
`vCli` also exports its subcommand registrars, so a host program can compose
|
|
53
|
-
the same commands into a larger `commander` tree:
|
|
54
|
-
|
|
55
|
-
```ts
|
|
56
|
-
import { Command } from "commander";
|
|
57
|
-
import { registerRegistryCmd, registerSsgCmd } from "@booga/vcli";
|
|
58
|
-
|
|
59
|
-
const app = new Command().name("mytool");
|
|
60
|
-
registerRegistryCmd(app);
|
|
61
|
-
registerSsgCmd(app);
|
|
62
|
-
app.parseAsync();
|
|
42
|
+
cd demo && npm install && npx vcli ssg build vssg.config.js
|
|
43
|
+
# → built 1 pages, 2 assets in 22ms
|
|
63
44
|
```
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@booga/vcli",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "My terminal handle on the vsuite. Registry browsing, vSsg static-site build, from the shell.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
7
7
|
"module": "./dist/index.js",
|