@uvrn/cli 1.0.0 → 1.0.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/README.md +19 -20
- package/package.json +8 -2
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# @uvrn/cli
|
|
2
2
|
|
|
3
|
-
Command-line interface for the
|
|
3
|
+
Command-line interface for the UVRN Delta Engine. Transform data bundles into verifiable receipts using deterministic comparison and canonical hashing.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Install
|
|
6
6
|
|
|
7
7
|
### Global Installation (Recommended)
|
|
8
8
|
|
|
@@ -62,7 +62,7 @@ npx delta-engine --version
|
|
|
62
62
|
delta-engine run bundle.json
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
3. **Get your receipt** (with deterministic hash):
|
|
65
|
+
3. **Get your receipt** (with deterministic hash). Example output:
|
|
66
66
|
|
|
67
67
|
```json
|
|
68
68
|
{
|
|
@@ -282,9 +282,16 @@ elif [ $? -eq 3 ]; then
|
|
|
282
282
|
fi
|
|
283
283
|
```
|
|
284
284
|
|
|
285
|
-
##
|
|
285
|
+
## Use cases
|
|
286
286
|
|
|
287
|
-
|
|
287
|
+
- **Run comparisons from the shell** — Pass a bundle file, stdin, or URL; get a receipt with outcome and hash.
|
|
288
|
+
- **Validate before running** — Use `delta-engine validate bundle.json` to check structure without executing.
|
|
289
|
+
- **Verify receipts** — Use `delta-engine verify receipt.json` to recompute the hash and confirm integrity.
|
|
290
|
+
- **CI and scripts** — Pipe bundles in and receipts out; use exit codes for success or failure.
|
|
291
|
+
|
|
292
|
+
## Protocol compliance
|
|
293
|
+
|
|
294
|
+
This CLI implements the UVRN Delta Engine protocol:
|
|
288
295
|
|
|
289
296
|
- Deterministic hash computation (SHA-256)
|
|
290
297
|
- Canonical JSON serialization
|
|
@@ -318,23 +325,15 @@ Make the CLI executable:
|
|
|
318
325
|
chmod +x node_modules/.bin/delta-engine
|
|
319
326
|
```
|
|
320
327
|
|
|
321
|
-
## Contributing
|
|
322
|
-
|
|
323
|
-
This package is part of the Loosechain Delta Engine Core monorepo. See the main repository for contribution guidelines.
|
|
324
|
-
|
|
325
328
|
## License
|
|
326
329
|
|
|
327
330
|
MIT
|
|
328
331
|
|
|
329
|
-
##
|
|
330
|
-
|
|
331
|
-
- [@uvrn/core](../uvrn-core) - Core engine library
|
|
332
|
-
- [@uvrn/api](../uvrn-api) - REST API server (coming soon)
|
|
333
|
-
- [@uvrn/mcp](../uvrn-mcp) - MCP server integration (coming soon)
|
|
334
|
-
- [@uvrn/sdk](../uvrn-sdk) - TypeScript SDK (coming soon)
|
|
335
|
-
|
|
336
|
-
## Support
|
|
332
|
+
## Links
|
|
337
333
|
|
|
338
|
-
-
|
|
339
|
-
-
|
|
340
|
-
-
|
|
334
|
+
- [Repository](https://github.com/UVRN-org/uvrn-packages) — monorepo (this package: `uvrn-cli`)
|
|
335
|
+
- [CLI Guide](docs/CLI_GUIDE.md) — full command reference
|
|
336
|
+
- [@uvrn/core](https://www.npmjs.com/package/@uvrn/core) — core engine library
|
|
337
|
+
- [@uvrn/api](https://www.npmjs.com/package/@uvrn/api) — REST API server (published)
|
|
338
|
+
- [@uvrn/mcp](https://www.npmjs.com/package/@uvrn/mcp) — MCP server for AI assistants (published)
|
|
339
|
+
- [@uvrn/sdk](https://www.npmjs.com/package/@uvrn/sdk) — TypeScript SDK (published)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uvrn/cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "UVRN CLI — bundle to receipt",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -14,9 +14,15 @@
|
|
|
14
14
|
"receipt"
|
|
15
15
|
],
|
|
16
16
|
"license": "MIT",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "https://github.com/UVRN-org/uvrn-packages.git",
|
|
20
|
+
"directory": "uvrn-cli"
|
|
21
|
+
},
|
|
22
|
+
"homepage": "https://github.com/UVRN-org/uvrn-packages#readme",
|
|
17
23
|
"dependencies": {
|
|
18
24
|
"commander": "^11.1.0",
|
|
19
|
-
"@uvrn/core": "1.0.
|
|
25
|
+
"@uvrn/core": "1.0.1"
|
|
20
26
|
},
|
|
21
27
|
"devDependencies": {
|
|
22
28
|
"@types/jest": "^29.5.0",
|