@axiomify/cli 6.0.0 → 6.1.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/README.md +28 -1
- package/dist/index.js +5450 -124
- package/dist/index.mjs +5468 -143
- package/package.json +19 -3
package/README.md
CHANGED
|
@@ -32,11 +32,12 @@ the same major as your `@axiomify/*` runtime packages.
|
|
|
32
32
|
| `axiomify openapi [entry]` | Generate the OpenAPI 3.0.3 spec |
|
|
33
33
|
| `axiomify check [entry]` | Static production-readiness audit |
|
|
34
34
|
| `axiomify doctor` | Diagnose the host environment |
|
|
35
|
+
| `axiomify sdk <subcommand>` | Manage, generate, build, validate, and diff SDKs |
|
|
35
36
|
|
|
36
37
|
`[entry]` defaults to `src/index.ts` everywhere it's accepted.
|
|
37
38
|
|
|
38
39
|
For the full reference (flags, exit codes, CI examples), see
|
|
39
|
-
[
|
|
40
|
+
[`./docs/packages/cli.md`](https://github.com/OTopman/axiomify/blob/main/docs/packages/cli.md).
|
|
40
41
|
|
|
41
42
|
## `axiomify init`
|
|
42
43
|
|
|
@@ -144,6 +145,30 @@ alignment, uWS bindings load successfully, recent build artefact, port
|
|
|
144
145
|
Run on a fresh clone or new CI runner before chasing test failures that
|
|
145
146
|
turn out to be Node-version mismatches.
|
|
146
147
|
|
|
148
|
+
## `axiomify sdk`
|
|
149
|
+
|
|
150
|
+
Subcommands for compiling type-safe client SDKs from specs:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
# Generate SDKs for TS, Python, and Go:
|
|
154
|
+
axiomify sdk generate spec.json --target typescript python go -o ./sdks
|
|
155
|
+
|
|
156
|
+
# Deep structural diff for breaking changes:
|
|
157
|
+
axiomify sdk diff old-spec.json new-spec.json
|
|
158
|
+
|
|
159
|
+
# Get client migration guidance:
|
|
160
|
+
axiomify sdk migrate old-spec.json new-spec.json
|
|
161
|
+
|
|
162
|
+
# Run generation hot-reloads on file change:
|
|
163
|
+
axiomify sdk watch spec.json --target typescript python
|
|
164
|
+
|
|
165
|
+
# Run local toolchain diagnostics:
|
|
166
|
+
axiomify sdk doctor
|
|
167
|
+
|
|
168
|
+
# Run compiler and emitter throughput benchmarks:
|
|
169
|
+
axiomify sdk benchmark
|
|
170
|
+
```
|
|
171
|
+
|
|
147
172
|
## CI example
|
|
148
173
|
|
|
149
174
|
```yaml
|
|
@@ -152,6 +177,8 @@ turn out to be Node-version mismatches.
|
|
|
152
177
|
- run: npx axiomify build
|
|
153
178
|
- run: npx axiomify openapi -o ./openapi.json --spec-version "$GITHUB_SHA"
|
|
154
179
|
- run: npx axiomify routes --json > routes.json # surface snapshot
|
|
180
|
+
- run: npx axiomify sdk validate ./openapi.json # schema verification
|
|
181
|
+
- run: npx axiomify sdk diff old-spec.json ./openapi.json # check breaking changes
|
|
155
182
|
```
|
|
156
183
|
|
|
157
184
|
Diff `routes.json` between commits to detect accidental API changes
|