Skip to content

Commit 390b521

Browse files
Documentation for report command in keploy oss (#635)
* docs: report Signed-off-by: Asish Kumar <[email protected]> * fix: change full-body to body command Signed-off-by: Asish Kumar <[email protected]> --------- Signed-off-by: Asish Kumar <[email protected]>
1 parent 997016e commit 390b521

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

versioned_docs/version-3.0.0/running-keploy/cli-commands.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Here are some examples of how to use some common flags:
3030
| `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` |
3131
| `normailze` | `-p, --path`, `--test-run`, `--tests` |
3232
| `rerecord` | `--test-sets`, `-t` |
33+
| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` |
3334
| `config` | `--generate`,`-p, --path` |
3435

3536
## [record](#record)
@@ -323,6 +324,42 @@ This is useful if your application takes some time to start (for example, when r
323324
- Adjust the delay to match your app's startup time.
324325
- For example, use `--delay 10` to wait for 10 seconds.
325326

327+
## [report](#report)
328+
329+
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+
331+
<b> Usage: </b>
332+
333+
```bash
334+
keploy report [flags]
335+
```
336+
337+
<b> Available flags: </b>
338+
339+
- `-t, --test-sets strings` - Testsets to report, e.g., `--test-sets "test-set-1, test-set-2"`.
340+
341+
```bash
342+
keploy report -t "test-set-1"
343+
```
344+
345+
- `-p, --path string` - Path to the local directory where generated testcases/mocks are stored. Default is ".".
346+
347+
```bash
348+
keploy report -p "./keploy-tests"
349+
```
350+
351+
- `--report-path string` - Absolute path to a specific report file to display results from.
352+
353+
```bash
354+
keploy report --report-path "/home/user/my-app/keploy/reports/test-run-1.yaml"
355+
```
356+
357+
- `--body` - Show full expected/actual body diffs (colorized for JSON) instead of the default compact table diff.
358+
359+
```bash
360+
keploy report -t "test-set-1" --body
361+
```
362+
326363
## [templatize](#templatize)
327364

328365
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

Comments
 (0)