Skip to content
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

Add documentation on CLI Output report #199

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation on CLI Output report #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions documentation/clients/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,12 @@ If requests in a collection consists of secret variables we recommend either of
| ------ | ---------------------------------------------------------- |
| `-h` | Gives a list of associated commands and their descriptions |
| `-v` | Displays the curremt version of the CLI |

## Output Report

After Hoppscotch CLI is run, it will return the following information.
- Request name, method, url, return status code, duration
- Within each request the test result is provided. Any errors are found after the requests.
- A summary and count of failed and passed tests is at the end with `Test Cases` being the number of `pw.expect` methods, `Test Suites` being the number of `pw.test` methods, and `Test Scripts` being the number of total pre and post scripts performed.
- Total requests and total request duration
- The count of failed and passed pre-request scripts