# @currents/cmd

### Requirements

* Create an account at <https://app.currents.dev>
* Obtain the Project Id (see [project-settings](https://docs.currents.dev/dashboard/projects/project-settings "mention")) and the [record-key](https://docs.currents.dev/guides/record-key "mention")

{% hint style="info" %}
Get familiar with [ci-build-id](https://docs.currents.dev/guides/parallelization-guide/ci-build-id "mention") before using `currents` in CI.

It is <mark style="color:yellow;">**important**</mark> 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 set to a random value and it will affect your reporting.
{% endhint %}

### Setup

```sh
npm install @currents/cmd --save-dev
```

### Subcommands

* [`currents api`](https://docs.currents.dev/resources/reporters/currents-cmd/currents-api) - retrieve data from Currents [Resources](https://app.gitbook.com/s/lcxad7NaXT7D2V6owvHN/resources "mention") entities
* [`currents upload`](https://docs.currents.dev/resources/reporters/currents-cmd/currents-upload) - upload the test results into the Currents Dashboard
* [`currents cache`](https://docs.currents.dev/resources/reporters/currents-cmd/currents-cache) - manage test artifacts and configuration cache
* [`currents convert`](https://docs.currents.dev/resources/reporters/currents-cmd/currents-convert) - convert test reports to Currents internal format

### Troubleshooting

Run the CLI command with the `--debug` argument or prefix it with `DEBUG="currents*"` to obtain detailed information about the command execution process.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.currents.dev/resources/reporters/currents-cmd.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.