> For the complete documentation index, see [llms.txt](https://docs.currents.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.currents.dev/resources/reporters/currents-cmd.md).

# @currents/cmd

### Requirements

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

{% hint style="info" %}
Get familiar with [CI Build ID](/guides/parallelization-guide/ci-build-id.md) 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`](/resources/reporters/currents-cmd/currents-api.md) - retrieve data from Currents [Resources](/api/resources/integrations.md) entities
* [`currents upload`](/resources/reporters/currents-cmd/currents-upload.md) - upload the test results into the Currents Dashboard
* [`currents cache`](/resources/reporters/currents-cmd/currents-cache.md) - manage test artifacts and configuration cache
* [`currents convert`](/resources/reporters/currents-cmd/currents-convert.md) - 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.