Skip to content

docs: json reporter writes a file and progress goes to stderr (checkly-cli 10.0.0) #749

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

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

docs: json reporter writes a file and progress goes to stderr (checkly-cli 10.0.0) #749

Show file tree
Hide file tree
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
6 changes: 4 additions & 2 deletions cli/checkly-test.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,8 @@ npx checkly test --reporter ci
# GitHub Actions reporter
npx checkly test --reporter github

# JSON output for programmatic use
npx checkly test --reporter json > results.json
# JSON report, written to checkly-json-report.json in the current directory
npx checkly test --reporter json

# Multiple reporters using comma-separated values
npx checkly test --reporter list,json
Expand All @@ -297,6 +297,8 @@ npx checkly test --reporter list --reporter json
npx checkly test -r github -r json
```

The `json` reporter writes its report to `checkly-json-report.json` in the current directory and prints a summary and the path of that file. From CLI v10.0.0 on, `checkly test` writes only the reporter output to stdout. Progress messages such as `Parsing your project...` and `Running 1 checks in eu-west-1.` go to stderr. Earlier versions print them to stdout, mixed with the reporter output.

</ResponseField>

<ResponseField name="--[no-]record" type="boolean" default="true">
Expand Down
6 changes: 4 additions & 2 deletions cli/checkly-trigger.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ npx checkly trigger --reporter ci
# GitHub Actions reporter
npx checkly trigger --reporter github

# JSON output for programmatic use
npx checkly trigger --reporter json > results.json
# JSON report, written to checkly-json-report.json in the current directory
npx checkly trigger --reporter json

# Multiple reporters using comma-separated values
npx checkly trigger --reporter list,json
Expand All @@ -279,6 +279,8 @@ npx checkly trigger --reporter list --reporter json
npx checkly trigger -r github -r json
```

The `json` reporter writes its report to `checkly-json-report.json` in the current directory and prints a summary and the path of that file. From CLI v10.0.0 on, `checkly trigger` writes only the reporter output to stdout. The progress message `Running 1 checks in eu-west-1.` goes to stderr. Earlier versions print it to stdout, mixed with the reporter output.

</ResponseField>

<ResponseField name="--verbose, -v" type="boolean">
Expand Down
Loading