micro-contracts 0.17.12 → 0.17.14
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/docs/cli-reference.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Contract-first OpenAPI toolchain for TypeScript Web/API systems. Generates contract packages, server routes, and frontend clients from OpenAPI specifications with enforceable guardrails.
|
|
4
4
|
|
|
5
|
-
**Version:** 0.17.
|
|
5
|
+
**Version:** 0.17.14
|
|
6
6
|
|
|
7
7
|
## Table of Contents
|
|
8
8
|
|
|
@@ -91,13 +91,13 @@ micro-contracts generate --force
|
|
|
91
91
|
#### Extensions
|
|
92
92
|
|
|
93
93
|
```yaml
|
|
94
|
-
x-agent:
|
|
94
|
+
x-agent:
|
|
95
95
|
risk_level: medium
|
|
96
96
|
requires_confirmation: false
|
|
97
97
|
idempotent: true
|
|
98
|
-
side_effects:
|
|
98
|
+
side_effects:
|
|
99
99
|
- file_write
|
|
100
|
-
recommended_before_use:
|
|
100
|
+
recommended_before_use:
|
|
101
101
|
- Ensure micro-contracts.config.yaml exists.
|
|
102
102
|
- Verify OpenAPI specs are valid.
|
|
103
103
|
```
|
|
@@ -144,11 +144,11 @@ micro-contracts lint spec/core/openapi/core.yaml --strict
|
|
|
144
144
|
#### Extensions
|
|
145
145
|
|
|
146
146
|
```yaml
|
|
147
|
-
x-agent:
|
|
147
|
+
x-agent:
|
|
148
148
|
risk_level: low
|
|
149
149
|
requires_confirmation: false
|
|
150
150
|
idempotent: true
|
|
151
|
-
side_effects:
|
|
151
|
+
side_effects:
|
|
152
152
|
|
|
153
153
|
```
|
|
154
154
|
|
|
@@ -209,11 +209,11 @@ micro-contracts init users --skip-templates
|
|
|
209
209
|
#### Extensions
|
|
210
210
|
|
|
211
211
|
```yaml
|
|
212
|
-
x-agent:
|
|
212
|
+
x-agent:
|
|
213
213
|
risk_level: medium
|
|
214
214
|
requires_confirmation: false
|
|
215
215
|
idempotent: true
|
|
216
|
-
side_effects:
|
|
216
|
+
side_effects:
|
|
217
217
|
- file_write
|
|
218
218
|
- directory_create
|
|
219
219
|
```
|
|
@@ -277,13 +277,13 @@ micro-contracts check --list-gates
|
|
|
277
277
|
#### Extensions
|
|
278
278
|
|
|
279
279
|
```yaml
|
|
280
|
-
x-agent:
|
|
280
|
+
x-agent:
|
|
281
281
|
risk_level: low
|
|
282
282
|
requires_confirmation: false
|
|
283
283
|
idempotent: true
|
|
284
|
-
side_effects:
|
|
284
|
+
side_effects:
|
|
285
285
|
|
|
286
|
-
recommended_before_use:
|
|
286
|
+
recommended_before_use:
|
|
287
287
|
- Run generate first so generated files exist.
|
|
288
288
|
```
|
|
289
289
|
|
|
@@ -344,13 +344,13 @@ micro-contracts pipeline --contracts-only --skip-lint
|
|
|
344
344
|
#### Extensions
|
|
345
345
|
|
|
346
346
|
```yaml
|
|
347
|
-
x-agent:
|
|
347
|
+
x-agent:
|
|
348
348
|
risk_level: medium
|
|
349
349
|
requires_confirmation: false
|
|
350
350
|
idempotent: true
|
|
351
|
-
side_effects:
|
|
351
|
+
side_effects:
|
|
352
352
|
- file_write
|
|
353
|
-
recommended_before_use:
|
|
353
|
+
recommended_before_use:
|
|
354
354
|
- Ensure micro-contracts.config.yaml and guardrails.yaml exist.
|
|
355
355
|
- Verify OpenAPI specs are valid.
|
|
356
356
|
```
|
|
@@ -408,11 +408,11 @@ micro-contracts deps --validate
|
|
|
408
408
|
#### Extensions
|
|
409
409
|
|
|
410
410
|
```yaml
|
|
411
|
-
x-agent:
|
|
411
|
+
x-agent:
|
|
412
412
|
risk_level: low
|
|
413
413
|
requires_confirmation: false
|
|
414
414
|
idempotent: true
|
|
415
|
-
side_effects:
|
|
415
|
+
side_effects:
|
|
416
416
|
|
|
417
417
|
```
|
|
418
418
|
|
|
@@ -454,11 +454,11 @@ micro-contracts insights --format json --project-root .
|
|
|
454
454
|
#### Extensions
|
|
455
455
|
|
|
456
456
|
```yaml
|
|
457
|
-
x-agent:
|
|
457
|
+
x-agent:
|
|
458
458
|
risk_level: low
|
|
459
459
|
requires_confirmation: false
|
|
460
460
|
idempotent: true
|
|
461
|
-
side_effects:
|
|
461
|
+
side_effects:
|
|
462
462
|
|
|
463
463
|
```
|
|
464
464
|
|
|
@@ -501,11 +501,11 @@ micro-contracts guardrails-init -o custom-guardrails.yaml
|
|
|
501
501
|
#### Extensions
|
|
502
502
|
|
|
503
503
|
```yaml
|
|
504
|
-
x-agent:
|
|
504
|
+
x-agent:
|
|
505
505
|
risk_level: low
|
|
506
506
|
requires_confirmation: false
|
|
507
507
|
idempotent: false
|
|
508
|
-
side_effects:
|
|
508
|
+
side_effects:
|
|
509
509
|
- file_write
|
|
510
510
|
```
|
|
511
511
|
|
|
@@ -556,11 +556,11 @@ micro-contracts manifest -o custom-manifest.json
|
|
|
556
556
|
#### Extensions
|
|
557
557
|
|
|
558
558
|
```yaml
|
|
559
|
-
x-agent:
|
|
559
|
+
x-agent:
|
|
560
560
|
risk_level: low
|
|
561
561
|
requires_confirmation: false
|
|
562
562
|
idempotent: true
|
|
563
|
-
side_effects:
|
|
563
|
+
side_effects:
|
|
564
564
|
- file_write
|
|
565
565
|
```
|
|
566
566
|
|
|
@@ -629,10 +629,10 @@ micro-contracts audit-openapi --show-prompt
|
|
|
629
629
|
#### Extensions
|
|
630
630
|
|
|
631
631
|
```yaml
|
|
632
|
-
x-agent:
|
|
632
|
+
x-agent:
|
|
633
633
|
dsl_task: audit-openapi-design
|
|
634
634
|
expectedDurationMs: 120000
|
|
635
|
-
retryableExitCodes:
|
|
635
|
+
retryableExitCodes:
|
|
636
636
|
- 12
|
|
637
637
|
```
|
|
638
638
|
|
|
@@ -698,10 +698,10 @@ micro-contracts review-published --adapter claude --report-format json
|
|
|
698
698
|
#### Extensions
|
|
699
699
|
|
|
700
700
|
```yaml
|
|
701
|
-
x-agent:
|
|
701
|
+
x-agent:
|
|
702
702
|
dsl_task: audit-published-api
|
|
703
703
|
expectedDurationMs: 120000
|
|
704
|
-
retryableExitCodes:
|
|
704
|
+
retryableExitCodes:
|
|
705
705
|
- 12
|
|
706
706
|
```
|
|
707
707
|
|
|
@@ -767,10 +767,10 @@ micro-contracts propose-overlays --adapter openai --report-format json
|
|
|
767
767
|
#### Extensions
|
|
768
768
|
|
|
769
769
|
```yaml
|
|
770
|
-
x-agent:
|
|
770
|
+
x-agent:
|
|
771
771
|
dsl_task: propose-overlay-candidates
|
|
772
772
|
expectedDurationMs: 120000
|
|
773
|
-
retryableExitCodes:
|
|
773
|
+
retryableExitCodes:
|
|
774
774
|
- 12
|
|
775
775
|
```
|
|
776
776
|
|
|
@@ -833,10 +833,10 @@ micro-contracts audit-guardrails --adapter mock --report-format json
|
|
|
833
833
|
#### Extensions
|
|
834
834
|
|
|
835
835
|
```yaml
|
|
836
|
-
x-agent:
|
|
836
|
+
x-agent:
|
|
837
837
|
dsl_task: audit-guardrails-coverage
|
|
838
838
|
expectedDurationMs: 120000
|
|
839
|
-
retryableExitCodes:
|
|
839
|
+
retryableExitCodes:
|
|
840
840
|
- 12
|
|
841
841
|
```
|
|
842
842
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "micro-contracts",
|
|
3
|
-
"version": "0.17.
|
|
3
|
+
"version": "0.17.14",
|
|
4
4
|
"description": "Contract-first OpenAPI toolchain that keeps TypeScript UI and microservices aligned via code generation",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -75,7 +75,7 @@
|
|
|
75
75
|
"agent-contracts-analyzer": "file:vendor/agent-contracts-analyzer-0.1.1.tgz",
|
|
76
76
|
"agent-contracts-runtime": "^0.36.6",
|
|
77
77
|
"chalk": "^5.3.0",
|
|
78
|
-
"cli-contracts": "^0.
|
|
78
|
+
"cli-contracts": "^0.34.6",
|
|
79
79
|
"commander": "^12.1.0",
|
|
80
80
|
"embedoc": "^0.9.0",
|
|
81
81
|
"esbuild": "^0.28.0",
|