You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versioned_docs/version-3.0.0/running-keploy/cli-commands.md
+16-21Lines changed: 16 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -327,7 +327,7 @@ This is useful if your application takes some time to start (for example, when r
327
327
328
328
## [report](#report)
329
329
330
-
The `report` command in Keploy is used to display a detailed summary of test results. It provides a human-readable diff for failed test cases from the latest test run or a specified report file.
330
+
The `report` command in Keploy is used to display a detailed summary of test results. It can show a compact table-style diff or full body diffs (with colorized JSON), and it can read from the latest test run or a specific report file.
-`-t, --test-sets strings` - Testsets to report, e.g., `--test-sets "test-set-1, test-set-2"`. If omitted, all test sets in the latest run are considered.
341
341
342
342
```bash
343
343
keploy report -t "test-set-1"
@@ -349,42 +349,37 @@ keploy report [flags]
349
349
keploy report -p "./keploy-tests"
350
350
```
351
351
352
-
-`--report-pathstring` - Absolute path to a specific report file to display results from.
352
+
-`--report-path, -r string` - **Absolute** path to a specific report file to display results from (must point to a file, not a directory). You can still combine this with other flags like `--summary` or `--test-case`.
-`--body` - Show full expected/actual body diffs (colorized for JSON) instead of the default compact table diff.
358
+
-`--full` - Show full diffs instead of the default compact table view. For JSON bodies, this produces colorized expected/actual comparisons.
359
359
360
360
```bash
361
-
keploy report -t "test-set-1" --body
361
+
keploy report -t "test-set-1" --full
362
362
```
363
363
364
-
## [sanitize](#sanitize)
365
-
366
-
The `sanitize` command helps remove sensitive data from recorded test cases. It scans test files for potential secrets (like API keys, tokens, etc.), replaces them with template placeholders, and stores the original values in a separate `secret.yaml` file. This allows for sharing test cases without exposing sensitive information.
367
-
368
-
<b> Usage: </b>
369
-
370
-
```bash
371
-
keploy sanitize [flags]
372
-
```
373
-
374
-
<b> Available flags: </b>
375
-
376
-
-`-t, --test-sets strings` - Testsets to sanitize, e.g., `-t "test-set-1, test-set-2"`. If not specified, all test sets will be sanitized.
364
+
-`--summary` - Print only a summarized view (grand totals and per–test-set table with time taken). Useful for a quick dashboard-style overview. Can be combined with `-t/--test-sets` and `--report-path`.
377
365
378
366
```bash
379
-
keploy sanitize -t "test-set-1"
367
+
keploy report --summary
380
368
```
381
369
382
-
-`-p, --path string` - Path to the local directory where generated testcases/mocks are stored. Default is ".".
370
+
-`--test-case strings` (alias: `--tc`) - Filter output to specific test case IDs.
383
371
384
372
```bash
385
-
keploy sanitize -p "./keploy-tests"
373
+
keploy report --test-case "test-1"
386
374
```
387
375
376
+
> **Notes**
377
+
>
378
+
> - By default, `report` shows only **failed** tests with a compact, human-readable diff (status, headers—including trailers/content-length where applicable—and body changes).
379
+
> - Use `--full` to see the complete expected vs actual bodies (with JSON colorization).
380
+
> -`--summary` prints just the totals and a per–test-set table, optionally restricted with `-t/--test-sets`.
381
+
> - When `--report-path` is provided, Keploy reads that file directly. Legacy files that contain only a `tests` list are supported.
382
+
388
383
## [templatize](#templatize)
389
384
390
385
The `templatize` cmd allows the user to templatize important fields in the testcases who's values are used in the request of testcases and that may change in the future.
0 commit comments