Skip to content

Commit 1385733

Browse files
committed
docs: fix exit codes, remove --format flag, mark --snapshot optional
1 parent bf7d9f2 commit 1385733

File tree

2 files changed

+6
-20
lines changed

2 files changed

+6
-20
lines changed

docs/user/cli-reference.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -431,11 +431,10 @@ aicr validate [flags]
431431
| Flag | Short | Type | Description |
432432
|------|-------|------|-------------|
433433
| `--recipe` | `-r` | string | Path/URI to recipe file containing constraints (required) |
434-
| `--snapshot` | `-s` | string | Path/URI to snapshot file containing measurements (required) |
434+
| `--snapshot` | `-s` | string | Path/URI to snapshot file containing measurements (omit to capture live) |
435435
| `--phase` | | string | Validation phase to run: deployment, performance, conformance, all (default: all) |
436436
| `--fail-on-error` | | bool | Exit with non-zero status if any constraint fails (default: true) |
437437
| `--output` | `-o` | string | Output destination (file or stdout, default: stdout) |
438-
| `--format` | `-t` | string | Output format: json, yaml, table (default: yaml) |
439438
| `--kubeconfig` | `-k` | string | Path to kubeconfig file (for ConfigMap URIs) |
440439

441440
**Input Sources:**
@@ -525,12 +524,6 @@ aicr validate \
525524
--snapshot snapshot.yaml \
526525
--phase performance
527526

528-
# JSON output format
529-
aicr validate \
530-
--recipe recipe.yaml \
531-
--snapshot snapshot.yaml \
532-
--format json
533-
534527
# With custom kubeconfig
535528
aicr validate \
536529
--recipe recipe.yaml \
@@ -618,8 +611,8 @@ Results are output in CTRF (Common Test Report Format) — an industry-standard
618611
| Code | Description |
619612
|------|-------------|
620613
| `0` | All checks passed |
621-
| `1` | One or more checks failed (when `--fail-on-error` is set) |
622-
| `2` | Invalid input (bad flags, missing recipe/snapshot) |
614+
| `2` | Invalid input (bad flags, missing recipe) |
615+
| `8` | One or more checks failed (when `--fail-on-error` is set) |
623616

624617
---
625618

site/docs/user/cli-reference.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -433,11 +433,10 @@ aicr validate [flags]
433433
| Flag | Short | Type | Description |
434434
|------|-------|------|-------------|
435435
| `--recipe` | `-r` | string | Path/URI to recipe file containing constraints (required) |
436-
| `--snapshot` | `-s` | string | Path/URI to snapshot file containing measurements (required) |
436+
| `--snapshot` | `-s` | string | Path/URI to snapshot file containing measurements (omit to capture live) |
437437
| `--phase` | | string | Validation phase to run: deployment, performance, conformance, all (default: all) |
438438
| `--fail-on-error` | | bool | Exit with non-zero status if any constraint fails (default: true) |
439439
| `--output` | `-o` | string | Output destination (file or stdout, default: stdout) |
440-
| `--format` | `-t` | string | Output format: json, yaml, table (default: yaml) |
441440
| `--kubeconfig` | `-k` | string | Path to kubeconfig file (for ConfigMap URIs) |
442441

443442
**Input Sources:**
@@ -527,12 +526,6 @@ aicr validate \
527526
--snapshot snapshot.yaml \
528527
--phase performance
529528

530-
# JSON output format
531-
aicr validate \
532-
--recipe recipe.yaml \
533-
--snapshot snapshot.yaml \
534-
--format json
535-
536529
# With custom kubeconfig
537530
aicr validate \
538531
--recipe recipe.yaml \
@@ -620,8 +613,8 @@ Results are output in CTRF (Common Test Report Format) — an industry-standard
620613
| Code | Description |
621614
|------|-------------|
622615
| `0` | All checks passed |
623-
| `1` | One or more checks failed (when `--fail-on-error` is set) |
624-
| `2` | Invalid input (bad flags, missing recipe/snapshot) |
616+
| `2` | Invalid input (bad flags, missing recipe) |
617+
| `8` | One or more checks failed (when `--fail-on-error` is set) |
625618

626619
---
627620

0 commit comments

Comments
 (0)