Skip to content

Commit

Permalink
chore: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
agoldis committed Jul 16, 2024
1 parent 510dbfd commit ef0c4a0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/cmd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Obtain `--project-id` and [--key](https://docs.currents.dev/guides/record-key) f

`currents` will upload the results, as follows:

- use `process.env.CURRENTS_REPORT_DIR` or `--reportDir` to read the results previosly generated by one of supported reporters, otherwise
- use `process.env.CURRENTS_REPORT_DIR` or `--reportDir` to read the results previously generated by one of supported reporters, otherwise
- use the most recently created directory named as `.currents-report-[timestamp]-[uuidv4()]` in the current working directory

## Configuration
Expand All @@ -37,9 +37,9 @@ Please note that all options apart from `--project-id` and `--key` are optional.
| `-k, --key` | `string` | The record key to record the results to Currents. Read more: https://currents.dev/readme/guides/record-key | `CURRENTS_RECORD_KEY` | - |
| `-p, --project-id` | `string` | The id of the project for reporting | `CURRENTS_PROJECT_ID` | - |
| `--machine-id` | `string` | Unique identifier of the machine running the tests. If not provided, it will be generated automatically. See: https://currents.dev/readme/readme?q=machineId | `CURRENTS_MACHINE_ID` | `[random-string]` |
| `--report-dir` | `string` | The directory containng the test results created with one of the [supported](https://docs.currents.dev) reporters | `CURRENTS_REPORT_DIR` | `.currents-report-[timestamp]-[uuidv4]` |
| `--report-dir` | `string` | The directory containing the test results created with one of the [supported](https://docs.currents.dev) reporters | `CURRENTS_REPORT_DIR` | `.currents-report-[timestamp]-[uuidv4]` |
| `--ci-build-id` | `string` | The id of the build to record the test run. Read more: https://currents.dev/readme/guides/ci-build-id | `CURRENTS_CI_BUILD_ID` | `auto:[random-string]` |
| `--debug` | `boolean` | Enable debug logs | `DEBUG="currents,currents:*"` | `falseu` |
| `--debug` | `boolean` | Enable debug logs | `DEBUG="currents,currents:*"` | `false` |
| `-t, --tag` | `string` | Comma-separated tag(s) for recorded runs in Currents | `CURRENTS_TAG` | - |
| `--disable-title-tags` | `boolean` | Disable extracting tags from test title, e.g. `Test name @smoke` would not be tagged with `smoke` | `CURRENTS_DISABLE_TITLE_TAGS` | `false` |
| `--remove-title-tags` | `boolean` | Remove tags from test names in Currents, e.g. `Test name @smoke` becomes `Test name` in the dashboard | `CURRENTS_REMOVE_TITLE_TAGS` | `false` |
Expand Down

0 comments on commit ef0c4a0

Please sign in to comment.