Skip to content

Documentation for report command in keploy oss #635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 28, 2025
Merged

Documentation for report command in keploy oss #635

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
226264d
docs: report
officialasishkumar Aug 27, 2025
ac30414
fix: change full-body to body command
officialasishkumar Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions versioned_docs/version-3.0.0/running-keploy/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Here are some examples of how to use some common flags:
| `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` |
| `normailze` | `-p, --path`, `--test-run`, `--tests` |
| `rerecord` | `--test-sets`, `-t` |
| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` |
| `config` | `--generate`,`-p, --path` |

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

## [report](#report)

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.

<b> Usage: </b>

```bash
keploy report [flags]
```

<b> Available flags: </b>

- `-t, --test-sets strings` - Testsets to report, e.g., `--test-sets "test-set-1, test-set-2"`.
Copy link

Copilot AI Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term 'Testsets' should be 'Test sets' (two words) for proper grammar and consistency with the rest of the documentation.

Suggested change
- `-t, --test-sets strings` - Testsets to report, e.g., `--test-sets "test-set-1, test-set-2"`.
- `-t, --test-sets strings` - Test sets to report, e.g., `--test-sets "test-set-1, test-set-2"`.

Copilot uses AI. Check for mistakes.

```bash
keploy report -t "test-set-1"
```

- `-p, --path string` - Path to the local directory where generated testcases/mocks are stored. Default is ".".

```bash
keploy report -p "./keploy-tests"
```

- `--report-path string` - Absolute path to a specific report file to display results from.

```bash
keploy report --report-path "/home/user/my-app/keploy/reports/test-run-1.yaml"
```

- `--body` - Show full expected/actual body diffs (colorized for JSON) instead of the default compact table diff.

```bash
keploy report -t "test-set-1" --body
```

## [templatize](#templatize)

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.
Expand Down