@oxdeai/cli 0.2.3 → 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/CHANGELOG.md CHANGED
@@ -7,6 +7,99 @@ This project follows Semantic Versioning.
7
7
 
8
8
  ---
9
9
 
10
+ ## [0.3.0] - Unreleased
11
+
12
+ **Baseline for this entry:** the published `@oxdeai/cli@0.2.4` npm artifact
13
+ (2026-03-12). The Git tag `cli-v0.2.4` (`3614d94`) carries the same date, so the
14
+ baseline is provable for this package.
15
+
16
+ Pre-1.0, so a minor bump carries the breaking change.
17
+
18
+ ### Breaking
19
+
20
+ - **Depends on the `@oxdeai/core` 2.0 line.** Behaviour that follows from core's
21
+ trusted-time work is inherited by the CLI's build/verify/replay paths.
22
+ - **A valid `engine_secret` is enforced on the validation path.** Insecure defaults
23
+ were removed; a run that previously succeeded with an absent or too-short secret
24
+ now fails with an actionable error rather than proceeding.
25
+ - **Strict-mode verification requires an explicit trust anchor.** The four strict
26
+ `verify` entry points require `--trusted-keyset`, or an explicit
27
+ `--mode best-effort`. A missing keyset produces an actionable error instead of a
28
+ silent inconclusive result.
29
+
30
+ ### Fixed
31
+
32
+ - Deterministic `init` behaviour restored.
33
+ - `oxdeai` with no command exits 0 and prints usage to stdout.
34
+
35
+ ### Packaging
36
+
37
+ - `license`, `repository` (with `directory`), `homepage` and `bugs` are now declared;
38
+ the published `0.2.4` artifact carried none of them, which blocks npm provenance.
39
+ - The existing `prepack` build step is unchanged.
40
+
41
+ ---
42
+
43
+ ## [0.2.4] - 2026-03-19
44
+
45
+ ### Fixed
46
+
47
+ - No-command invocation (`oxdeai` with no arguments) now exits with code 0 and prints usage to stdout instead of stderr. Eliminates spurious `ELIFECYCLE` error from pnpm.
48
+
49
+ ---
50
+
51
+ ## [0.2.4] - 2026-03-12
52
+
53
+ ### Changed
54
+
55
+ - Follow-up CLI usability patch release after `0.2.3`.
56
+ - Clarified authorization shorthand behavior so `oxdeai verify auth` fails with actionable `--file` guidance instead of reading empty stdin.
57
+
58
+ ### Notes
59
+
60
+ - Patch release only.
61
+ - No protocol semantics or `@oxdeai/core` runtime behavior changes.
62
+
63
+ ---
64
+
65
+ ## [0.2.3] - 2026-03-12
66
+
67
+ ### Added
68
+
69
+ - Standard CLI help support:
70
+ - `oxdeai --help`
71
+ - `oxdeai -h`
72
+ - `oxdeai help`
73
+ - subcommand help such as `oxdeai verify --help`
74
+ - Standard CLI version support:
75
+ - `oxdeai --version`
76
+ - `oxdeai -v`
77
+ - Positional shorthand command forms for common local workflows:
78
+ - `oxdeai verify snap`
79
+ - `oxdeai verify audit`
80
+ - `oxdeai verify envelope`
81
+ - `oxdeai verify auth`
82
+ - `oxdeai build snapshot`
83
+ - Post-build executable entrypoint handling for the published CLI bin target.
84
+
85
+ ### Changed
86
+
87
+ - Improved monorepo developer workflow with clearer local CLI execution paths.
88
+ - Improved README quickstart for:
89
+ - npm users
90
+ - local contributors
91
+ - linked/global CLI workflows
92
+ - Improved top-level CLI error handling and usage guidance for unsupported flags and command misuse.
93
+ - Fixed direct execution detection so linked/global `oxdeai` works correctly through symlinked bin paths.
94
+ - Authorization shorthand now fails with actionable guidance when `--file` is omitted.
95
+
96
+ ### Notes
97
+
98
+ - CLI usability and packaging release only.
99
+ - No protocol semantics or `@oxdeai/core` runtime behavior changes.
100
+
101
+ ---
102
+
10
103
  ## [0.2.2] - 2026-03-08
11
104
 
12
105
  ### Changed
package/LICENSE ADDED
@@ -0,0 +1,213 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+
9
+ 1. Definitions.
10
+
11
+ http://www.apache.org/licenses/LICENSE-2.0
12
+ "License" shall mean the terms and conditions for use, reproduction,
13
+ and distribution as defined by Sections 1 through 9 of this document.
14
+
15
+ "Licensor" shall mean the copyright owner or entity authorized by
16
+ the copyright owner that is granting the License.
17
+
18
+ "Legal Entity" shall mean the union of the acting entity and all
19
+ other entities that control, are controlled by, or are under common
20
+ control with that entity. For the purposes of this definition,
21
+ "control" means (i) the power, direct or indirect, to cause the
22
+ direction or management of such entity, whether by contract or
23
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
24
+ outstanding shares, or (iii) beneficial ownership of such entity.
25
+
26
+ "You" (or "Your") shall mean an individual or Legal Entity
27
+ exercising permissions granted by this License.
28
+
29
+ "Source" form shall mean the preferred form for making modifications,
30
+ including but not limited to software source code, documentation
31
+ source, and configuration files.
32
+
33
+ "Object" form shall mean any form resulting from mechanical
34
+ transformation or translation of a Source form, including but
35
+ not limited to compiled object code, generated documentation,
36
+ and conversions to other media types.
37
+
38
+ "Work" shall mean the work of authorship, whether in Source or
39
+ Object form, made available under the License, as indicated by a
40
+ copyright notice that is included in or attached to the work
41
+ (an example is provided in the Appendix below).
42
+
43
+ "Derivative Works" shall mean any work, whether in Source or Object
44
+ form, that is based on (or derived from) the Work and for which the
45
+ editorial revisions, annotations, elaborations, or other modifications
46
+ represent, as a whole, an original work of authorship. For the purposes
47
+ of this License, Derivative Works shall not include works that remain
48
+ separable from, or merely link (or bind by name) to the interfaces of,
49
+ the Work and Derivative Works thereof.
50
+
51
+ "Contribution" shall mean any work of authorship, including
52
+ the original version of the Work and any modifications or additions
53
+ to that Work or Derivative Works thereof, that is intentionally
54
+ submitted to Licensor for inclusion in the Work by the copyright owner
55
+ or by an individual or Legal Entity authorized to submit on behalf of
56
+ the copyright owner. For the purposes of this definition, "submitted"
57
+ means any form of electronic, verbal, or written communication sent
58
+ to the Licensor or its representatives, including but not limited to
59
+ communication on electronic mailing lists, source code control systems,
60
+ and issue tracking systems that are managed by, or on behalf of, the
61
+ Licensor for the purpose of discussing and improving the Work, but
62
+ excluding communication that is conspicuously marked or otherwise
63
+ designated in writing by the copyright owner as "Not a Contribution."
64
+
65
+ "Contributor" shall mean Licensor and any individual or Legal Entity
66
+ on behalf of whom a Contribution has been received by Licensor and
67
+ subsequently incorporated within the Work.
68
+
69
+ 2. Grant of Copyright License. Subject to the terms and conditions of
70
+ this License, each Contributor hereby grants to You a perpetual,
71
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
72
+ copyright license to reproduce, prepare Derivative Works of,
73
+ publicly display, publicly perform, sublicense, and distribute the
74
+ Work and such Derivative Works in Source or Object form.
75
+
76
+ 3. Grant of Patent License. Subject to the terms and conditions of
77
+ this License, each Contributor hereby grants to You a perpetual,
78
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
79
+ (except as stated in this section) patent license to make, have made,
80
+ use, offer to sell, sell, import, and otherwise transfer the Work,
81
+ where such license applies only to those patent claims licensable
82
+ by such Contributor that are necessarily infringed by their
83
+ Contribution(s) alone or by combination of their Contribution(s)
84
+ with the Work to which such Contribution(s) was submitted. If You
85
+ institute patent litigation against any entity (including a
86
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
87
+ or a Contribution incorporated within the Work constitutes direct
88
+ or contributory patent infringement, then any patent licenses
89
+ granted to You under this License for that Work shall terminate
90
+ as of the date such litigation is filed.
91
+
92
+ 4. Redistribution. You may reproduce and distribute copies of the
93
+ Work or Derivative Works thereof in any medium, with or without
94
+ modifications, and in Source or Object form, provided that You
95
+ meet the following conditions:
96
+
97
+ (a) You must give any other recipients of the Work or
98
+ Derivative Works a copy of this License; and
99
+
100
+ (b) You must cause any modified files to carry prominent notices
101
+ stating that You changed the files; and
102
+
103
+ (c) You must retain, in the Source form of any Derivative Works
104
+ that You distribute, all copyright, patent, trademark, and
105
+ attribution notices from the Source form of the Work,
106
+ excluding those notices that do not pertain to any part of
107
+ the Derivative Works; and
108
+
109
+ (d) If the Work includes a "NOTICE" text file as part of its
110
+ distribution, then any Derivative Works that You distribute must
111
+ include a readable copy of the attribution notices contained
112
+ within such NOTICE file, excluding those notices that do not
113
+ pertain to any part of the Derivative Works, in at least one
114
+ of the following places: within a NOTICE text file distributed
115
+ as part of the Derivative Works; within the Source form or
116
+ documentation, if provided along with the Derivative Works; or,
117
+ within a display generated by the Derivative Works, if and
118
+ wherever such third-party notices normally appear. The contents
119
+ of the NOTICE file are for informational purposes only and
120
+ do not modify the License. You may add Your own attribution
121
+ notices within Derivative Works that You distribute, alongside
122
+ or as an addendum to the NOTICE text from the Work, provided
123
+ that such additional attribution notices cannot be construed
124
+ as modifying the License.
125
+
126
+ You may add Your own copyright statement to Your modifications and
127
+ may provide additional or different license terms and conditions
128
+ for use, reproduction, or distribution of Your modifications, or
129
+ for any such Derivative Works as a whole, provided Your use,
130
+ reproduction, and distribution of the Work otherwise complies with
131
+ the conditions stated in this License.
132
+
133
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
134
+ any Contribution intentionally submitted for inclusion in the Work
135
+ by You to the Licensor shall be under the terms and conditions of
136
+ this License, without any additional terms or conditions.
137
+ Notwithstanding the above, nothing herein shall supersede or modify
138
+ the terms of any separate license agreement you may have executed
139
+ with Licensor regarding such Contributions.
140
+
141
+ 6. Trademarks. This License does not grant permission to use the trade
142
+ names, trademarks, service marks, or product names of the Licensor,
143
+ except as required for reasonable and customary use in describing the
144
+ origin of the Work and reproducing the content of the NOTICE file.
145
+
146
+ 7. Disclaimer of Warranty. Unless required by applicable law or
147
+ agreed to in writing, Licensor provides the Work (and each
148
+ Contributor provides its Contributions) on an "AS IS" BASIS,
149
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
150
+ implied, including, without limitation, any warranties or conditions
151
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
152
+ PARTICULAR PURPOSE. You are solely responsible for determining the
153
+ appropriateness of using or redistributing the Work and assume any
154
+ risks associated with Your exercise of permissions under this License.
155
+
156
+ 8. Limitation of Liability. In no event and under no legal theory,
157
+ whether in tort (including negligence), contract, or otherwise,
158
+ unless required by applicable law (such as deliberate and grossly
159
+ negligent acts) or agreed to in writing, shall any Contributor be
160
+ liable to You for damages, including any direct, indirect, special,
161
+ incidental, or consequential damages of any character arising as a
162
+ result of this License or out of the use or inability to use the
163
+ Work (including but not limited to damages for loss of goodwill,
164
+ work stoppage, computer failure or malfunction, or any and all
165
+ other commercial damages or losses), even if such Contributor
166
+ has been advised of the possibility of such damages.
167
+
168
+ 9. Accepting Warranty or Additional Liability. While redistributing
169
+ the Work or Derivative Works thereof, You may choose to offer,
170
+ and charge a fee for, acceptance of support, warranty, indemnity,
171
+ or other liability obligations and/or rights consistent with this
172
+ License. However, in accepting such obligations, You may act only
173
+ on Your own behalf and on Your sole responsibility, not on behalf
174
+ of any other Contributor, and only if You agree to indemnify,
175
+ defend, and hold each Contributor harmless for any liability
176
+ incurred by, or claims asserted against, such Contributor by reason
177
+ of your accepting any such warranty or additional liability.
178
+
179
+ END OF TERMS AND CONDITIONS
180
+
181
+ APPENDIX: How to apply the Apache License to your work.
182
+
183
+ To apply the Apache License to your work, attach the following
184
+ boilerplate notice, with the fields enclosed by brackets "[]"
185
+ replaced with your own identifying information. (Don't include
186
+ the brackets!) The text should be enclosed in the appropriate
187
+ comment syntax for the file format. We also recommend that a
188
+ file or class name and description of purpose be included on the
189
+ same "printed page" as the copyright notice for easier
190
+ identification within third-party archives.
191
+
192
+ Copyright [yyyy] [name of copyright owner]
193
+
194
+ Licensed under the Apache License, Version 2.0 (the "License");
195
+ you may not use this file except in compliance with the License.
196
+ You may obtain a copy of the License at
197
+
198
+ http://www.apache.org/licenses/LICENSE-2.0
199
+
200
+ Unless required by applicable law or agreed to in writing, software
201
+ distributed under the License is distributed on an "AS IS" BASIS,
202
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
203
+ See the License for the specific language governing permissions and
204
+ limitations under the License.
205
+
206
+
207
+ OxDeAI
208
+ Copyright 2026 OxDeAI contributors
209
+
210
+ This product includes software developed by the OxDeAI project
211
+ (https://github.com/oxdeai/oxdeai).
212
+
213
+
package/README.md CHANGED
@@ -1,9 +1,20 @@
1
1
  # @oxdeai/cli
2
-
3
- Protocol-oriented command-line tooling for OxDeAI.
2
+ CLI for the OxDeAI execution-time authorization protocol.
3
+ Runs local verification and artifact inspection; no valid authorization means execution should not proceed.
4
4
 
5
5
  `@oxdeai/cli` is a thin Node.js wrapper around `@oxdeai/core` verification and local state workflows. It is framework-agnostic and intended for local policy operations, artifact inspection, and deterministic verification.
6
6
 
7
+ ## Version and registry status
8
+
9
+ The published npm package (`npm view @oxdeai/cli version`) is `0.2.4`. This
10
+ repository's current `packages/cli/package.json` version is `0.3.0`
11
+ (unreleased). The two differ in behavior, not just number: per
12
+ [`CHANGELOG.md`](./CHANGELOG.md), `0.3.0` enforces a valid `engine_secret` on
13
+ the validation path and requires an explicit `--trusted-keyset` (or
14
+ `--mode best-effort`) on strict `verify` entry points; the published `0.2.4`
15
+ does neither. Commands below and their env-var requirements describe this
16
+ repository's `0.3.0` behavior, not the currently published `0.2.4` artifact.
17
+
7
18
  ## Quickstart
8
19
 
9
20
  ### End users
@@ -14,6 +25,16 @@ Install the CLI:
14
25
  npm install -g @oxdeai/cli
15
26
  ```
16
27
 
28
+ This installs the published `0.2.4` line, not the `0.3.0` behavior described
29
+ below. To run the behavior in this repository, use the local monorepo
30
+ workflow instead (see "Local monorepo contributors").
31
+
32
+ `build`, `verify auth`, and `launch dry-run` require a trusted engine secret:
33
+
34
+ ```bash
35
+ export OXDEAI_ENGINE_SECRET='test-secret-must-be-at-least-32-chars!!'
36
+ ```
37
+
17
38
  Basic commands:
18
39
 
19
40
  ```bash
@@ -22,6 +43,9 @@ oxdeai --version
22
43
  oxdeai verify snap
23
44
  oxdeai verify envelope
24
45
  oxdeai build snapshot
46
+ oxdeai verify all
47
+ oxdeai inspect snapshot --file .oxdeai/snapshot.bin
48
+ oxdeai doctor
25
49
  ```
26
50
 
27
51
  ### Local monorepo contributors
@@ -60,6 +84,11 @@ oxdeai --help
60
84
 
61
85
  - `oxdeai build`
62
86
  - `oxdeai verify`
87
+ - `oxdeai inspect`
88
+ - `oxdeai doctor`
89
+ - `oxdeai paths`
90
+ - `oxdeai auth`
91
+ - `oxdeai examples`
63
92
  - `oxdeai replay`
64
93
 
65
94
  Legacy helper commands are still available (`init`, `launch`, `state`, `audit`, `verify-audit`, `make-envelope`, `verify-envelope`, `snapshot-hash`) for local development workflows.
@@ -68,7 +97,8 @@ Legacy helper commands are still available (`init`, `launch`, `state`, `audit`,
68
97
 
69
98
  ### build
70
99
 
71
- Builds a canonical snapshot verification payload from state.
100
+ Builds a canonical snapshot verification payload from state. Requires
101
+ `OXDEAI_ENGINE_SECRET` (see Quickstart).
72
102
 
73
103
  ```bash
74
104
  oxdeai build snapshot
@@ -90,15 +120,77 @@ Examples:
90
120
  oxdeai verify snap
91
121
  oxdeai verify audit
92
122
  oxdeai verify envelope
123
+ oxdeai verify auth --file authorization.json --expected-issuer oxdeai://issuer --expected-audience rp://tool-gateway --json
93
124
  oxdeai verify --kind snapshot --file snapshot.bin --json
94
125
  oxdeai verify --kind audit --file audit.ndjson --mode strict --json
95
126
  oxdeai verify --kind envelope --file envelope.bin --trusted-keyset keyset.json --require-signature --json
96
127
  oxdeai verify --kind authorization --file authorization.json --expected-issuer oxdeai://issuer --expected-audience rp://tool-gateway --json
97
128
  ```
98
129
 
130
+ `verify auth` does not assume a default file. Pass `--file <authorization.json>` explicitly.
131
+
132
+ ### inspect
133
+
134
+ Inspects local protocol artifacts without changing them.
135
+
136
+ ```bash
137
+ oxdeai inspect snapshot --file .oxdeai/snapshot.bin
138
+ oxdeai inspect audit --file .oxdeai/audit.ndjson
139
+ oxdeai inspect envelope --file .oxdeai/envelope.bin
140
+ oxdeai inspect auth --file authorization.json
141
+ ```
142
+
143
+ ### verify all
144
+
145
+ Runs snapshot, audit, and envelope verification together using local defaults.
146
+
147
+ ```bash
148
+ oxdeai verify all
149
+ ```
150
+
151
+ ### auth
152
+
153
+ Creates and inspects authorization artifacts for local relying-party tests.
154
+ `auth create` requires `OXDEAI_ENGINE_SECRET`; `auth inspect` does not.
155
+
156
+ ```bash
157
+ oxdeai auth create PROVISION 100 us-east-1 --agent agent-1 --nonce 1 --out authorization.json --json
158
+ oxdeai auth inspect --file authorization.json
159
+ ```
160
+
161
+ ### doctor and paths
162
+
163
+ Shows local path defaults and checks whether expected files exist.
164
+
165
+ ```bash
166
+ oxdeai paths
167
+ oxdeai doctor
168
+ ```
169
+
170
+ ### examples init
171
+
172
+ Writes a starter local state file and clears the audit log.
173
+
174
+ ```bash
175
+ oxdeai examples init
176
+ ```
177
+
178
+ ### launch dry-run
179
+
180
+ Evaluates an action without mutating local state or audit files. Requires
181
+ `OXDEAI_ENGINE_SECRET`.
182
+
183
+ ```bash
184
+ oxdeai launch dry-run PROVISION 100 us-east-1 --agent agent-1 --nonce 1 --json
185
+ ```
186
+
99
187
  ### replay
100
188
 
101
- Protocol-aware stub in `0.1.x`. It returns a clear unsupported response and points users to deterministic audit verification (`verify --kind audit`).
189
+ Protocol-aware stub. The current implementation (`packages/cli/src/main.ts`)
190
+ reports itself as `@oxdeai/cli v0.2.x` in this message; that string has not
191
+ been updated to match this package's own `package.json` version (`0.3.0`,
192
+ unreleased). It returns a clear unsupported response and points users to
193
+ deterministic audit verification (`verify --kind audit`).
102
194
 
103
195
  ## Output and Exit Codes
104
196