@openauditmodel/cli 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/README.md +7 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -26,13 +26,9 @@ specification is not compliance with any law, regulation, standard or contract.
|
|
|
26
26
|
|
|
27
27
|
## Quick start
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
Requires Node.js 22 or newer.
|
|
29
|
+
No install, no checkout — three commands against one file.
|
|
31
30
|
|
|
32
31
|
```bash
|
|
33
|
-
git clone https://github.com/OpenAuditModel/OpenAuditModel.git
|
|
34
|
-
cd OpenAuditModel && npm install && npm run build
|
|
35
|
-
|
|
36
32
|
cat > audit-event.json <<'EOF'
|
|
37
33
|
{
|
|
38
34
|
"specVersion": "0.1",
|
|
@@ -49,14 +45,13 @@ cat > audit-event.json <<'EOF'
|
|
|
49
45
|
}
|
|
50
46
|
EOF
|
|
51
47
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
48
|
+
npx @openauditmodel/cli validate audit-event.json
|
|
49
|
+
npx @openauditmodel/cli lint-privacy audit-event.json
|
|
50
|
+
npx @openauditmodel/cli check-profile audit-event.json --profile financial-transaction-management
|
|
55
51
|
```
|
|
56
52
|
|
|
57
|
-
The binary is `auditmodel` once
|
|
58
|
-
|
|
59
|
-
`--profile`, never positionally.
|
|
53
|
+
The binary is `auditmodel` once installed (`npm i -D @openauditmodel/cli`); `openauditmodel` is
|
|
54
|
+
accepted as an alias. The profile is passed with `--profile`, never positionally.
|
|
60
55
|
|
|
61
56
|
That third command **fails**, and it is meant to. The event is schema-valid but the financial profile
|
|
62
57
|
requires an authorization decision, a correlation identifier, a transaction reference, an amount, a
|
|
@@ -109,7 +104,7 @@ The same contract across every command, so a CI job can branch on it:
|
|
|
109
104
|
# conforming → 0 the profile's rules were checked and passed
|
|
110
105
|
# violations → 1 the event matched the profile and failed a rule
|
|
111
106
|
# not applicable → 3 the event name matched no rule in the profile
|
|
112
|
-
|
|
107
|
+
npx @openauditmodel/cli check-profile audit-event.json --profile document-management
|
|
113
108
|
```
|
|
114
109
|
|
|
115
110
|
That last command returns `3` for the financial event above: `document-management` governs no
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openauditmodel/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Conformance toolchain for OpenAuditModel: validate audit events against the canonical JSON Schema, verify tamper-evidence, lint for leaked secrets and check domain profiles. Offline and deterministic.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"audit",
|