Skip to content

Commit

Permalink
chore: .. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
agoldis committed Jul 10, 2024
1 parent 0043841 commit 93545ea
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions packages/cmd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ npm install @currents/cmd --save-dev

## Usage

- Generate test results with one of the reporters (see [documentation](https://docs.currents.dev) for the list of supporter reporters)
- Generate test results with one of the [supported](https://docs.currents.dev) reporters
- Upload the results

```sh
npx currents upload --project-id=xxx --key=yyy
```

ℹ️ Get familiar with [CI Build ID 📖](https://docs.currents.dev/guides/ci-build-id) (`--ci-build-id`) before using the tool in CI.
ℹ️ Get familiar with [CI Build ID 📖](https://docs.currents.dev/guides/ci-build-id) before using `currents` in CI. It is **important** to set the `CI Build ID` explicitly using `--ci-build-id` option, if you are using CI sharding or multiple CI machines to parallelize your tests. If not set explicitly, the `CI Build ID` will be generated automatically if not set.

## Notes

Expand All @@ -28,10 +28,6 @@ Obtain `--project-id` and [--key](https://docs.currents.dev/guides/record-key) f
- use `process.env.CURRENTS_REPORT_DIR` or `--reportDir` to read the results previosly generated by one of supported reporters, otherwise
- use the most recently created directory named as `.currents-report-[timestamp]-[uuidv4()]` in the current working directory

> ℹ️ Get familiar with [CI Build ID 📖](https://docs.currents.dev/guides/ci-build-id) before using `currents` in CI. It is **important** to set the `CI Build ID` explicitly if you are using sharding or multiple machines for the same test run.
> ℹ️ The `CI Build ID` will be generated automatically if not set.
## Configuration

Please note that all options apart from `--project-id` and `--key` are optional.
Expand Down

0 comments on commit 93545ea

Please sign in to comment.