> 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/getting-started.md).

# Getting Started

- [Overview](https://docs.currents.dev/getting-started/readme.md): Currents is a cloud platform, dashboard and test orchestrator aimed to help SDET and Software Teams to manage the complexity of running automated tests in CI.
- [Quick Start](https://docs.currents.dev/getting-started/your-first-playwright-run.md): Running Playwright tests with Currents Dashboard
- [Set Up with an AI Agent](https://docs.currents.dev/getting-started/setup-with-an-agent.md): Set up Currents with Claude Code, Cursor, Codex or another coding agent, locally and in CI
- [CI Setup](https://docs.currents.dev/getting-started/ci-setup.md): Learn how to integrate Currents with your CI provider.
- [GitHub Actions](https://docs.currents.dev/getting-started/ci-setup/github-actions.md): Running tests with Currents in GitHub Actions
- [Quick Start](https://docs.currents.dev/getting-started/ci-setup/github-actions/playwright-github-actions.md): Running Playwright tests in Parallel in GitHub Actions using Matrix Workflow
- [Re-run Only Failed Tests](https://docs.currents.dev/getting-started/ci-setup/github-actions/re-run-failed-only-tests.md): How to set up failed test re-runs on GitHub Actions
- [Sharded runs](https://docs.currents.dev/getting-started/ci-setup/github-actions/re-run-failed-only-tests/re-run-failed-only-tests-sharded.md): How to set up failed test reruns for sharded Playwright runs on GitHub Actions
- [Orchestrated runs](https://docs.currents.dev/getting-started/ci-setup/github-actions/re-run-failed-only-tests/re-run-failed-only-tests-orchestrated-v2.md): How to set up failed test reruns for Orchestration on GitHub Actions
- [Custom CI Build ID for Re-runs](https://docs.currents.dev/getting-started/ci-setup/github-actions/re-run-failed-only-tests/custom-ci-build-id-for-reruns.md): How to configure custom CI build IDs for failed test reruns on GitHub Actions
- [Cancel Runs on Workflow Cancellation](https://docs.currents.dev/getting-started/ci-setup/github-actions/cancel-runs.md): Cancel the Currents run when a GitHub Actions workflow is cancelled
- [Commit data for GitHub Actions](https://docs.currents.dev/getting-started/ci-setup/github-actions/commit-data-for-github-actions.md): How to get correct git commit information when using GitHub Actions
- [Custom Docker runners](https://docs.currents.dev/getting-started/ci-setup/github-actions/custom-docker-runners.md): Self hosted/managed docker runners
- [Named Runners](https://docs.currents.dev/getting-started/ci-setup/github-actions/named-runners.md): Github Actions provides the ability to use human-readable runner names, and Currents displays these in the dashboard, allowing you to see which runner executed each spec file.
- [GitLab](https://docs.currents.dev/getting-started/ci-setup/gitlab.md)
- [Quick Start](https://docs.currents.dev/getting-started/ci-setup/gitlab/playwright-gitlab-ci-cd.md): Running Playwright test in parallel using GitLab CI/CD
- [Re-run Only Failed Tests](https://docs.currents.dev/getting-started/ci-setup/gitlab/re-run-failed-only-tests.md): How to setup failed tests re-run on GitLab
- [Custom Docker runners](https://docs.currents.dev/getting-started/ci-setup/gitlab/custom-docker-runners.md): Self hosted/managed docker runners
- [Jenkins](https://docs.currents.dev/getting-started/ci-setup/jenkins.md): Running Playwright tests in parallel with Jenkins and Currents Dashboard
- [CircleCI](https://docs.currents.dev/getting-started/ci-setup/playwright-circleci.md): Running Playwright Tests in Parallel on CircleCI and Currents
- [Buildkite](https://docs.currents.dev/getting-started/ci-setup/buildkite.md): Running Playwright tests in parallel on Buildkite with Currents
- [Azure DevOps](https://docs.currents.dev/getting-started/ci-setup/playwright-azure-devops.md): Running Playwright test in parallel on Azure DevOps and Currents Dashboard
- [AWS Code Build](https://docs.currents.dev/getting-started/ci-setup/playwright-aws-code-build.md): Running Playwright Tests in Parallel on AWS CodeBuild and Currents
- [Harness](https://docs.currents.dev/getting-started/ci-setup/playwright-harness.md): Running Playwright tests on Harness CI with Currents reporting and parallel sharding
- [NX](https://docs.currents.dev/getting-started/ci-setup/nx.md): Running Playwright tests with NX
- [Other Frameworks](https://docs.currents.dev/getting-started/other-frameworks.md)
- [JUnit](https://docs.currents.dev/getting-started/other-frameworks/others.md): Integrate Currents with any framework by using JUnit compatible XML reporters
- [CI Setup](https://docs.currents.dev/getting-started/other-frameworks/others/ci-setup.md)
- [Node.js - GitHub Actions](https://docs.currents.dev/getting-started/other-frameworks/others/ci-setup/node-github-actions.md): Running Node.js Tests on GitHub Actions
- [Jest](https://docs.currents.dev/getting-started/other-frameworks/jest.md)
- [Your First Jest Run](https://docs.currents.dev/getting-started/other-frameworks/jest/your-first-jest-run.md): Running Jest tests with Currents dashboard
- [Detox + Jest](https://docs.currents.dev/getting-started/other-frameworks/jest/detox-+-jest.md): Send the results of Detox + Jest tests to Currents
- [Troubleshooting Jest](https://docs.currents.dev/getting-started/other-frameworks/jest/troubleshooting.md): Troubleshooting Jest integration with Currents
- [CI Setup](https://docs.currents.dev/getting-started/other-frameworks/jest/ci-setup.md)
- [Jest - GitHub Actions](https://docs.currents.dev/getting-started/other-frameworks/jest/ci-setup/jest-github-actions.md): Running Jest in Parallel on GitHub Actions using Matrix Workflow
- [Vitest](https://docs.currents.dev/getting-started/other-frameworks/vitest.md): Integrate Vitest with Currents using the JUnit XML reporter
- [Your First Vitest Run](https://docs.currents.dev/getting-started/other-frameworks/vitest/your-first-vitest-run.md): Running Vitest tests with Currents dashboard
- [Troubleshooting Vitest](https://docs.currents.dev/getting-started/other-frameworks/vitest/troubleshooting.md): Troubleshooting Vitest integration with Currents
- [CI Setup](https://docs.currents.dev/getting-started/other-frameworks/vitest/ci-setup.md)
- [Vitest - GitHub Actions](https://docs.currents.dev/getting-started/other-frameworks/vitest/ci-setup/vitest-github-actions.md): Running Vitest in Parallel on GitHub Actions using Matrix Workflow
- [Cypress](https://docs.currents.dev/getting-started/other-frameworks/cypress.md)
- [Your First Cypress Run](https://docs.currents.dev/getting-started/other-frameworks/cypress/you-first-cypress-run.md): Running Cypress tests in parallel with Currents Dashboard
- [Upload Cypress 13+ Results](https://docs.currents.dev/getting-started/other-frameworks/cypress/upload-cypress-13-results.md): Report Cypress 13 and later results to Currents by uploading Cypress's run results or JUnit reports with currents run upload, from the same or a later CI job
- [Integrating with Cypress](https://docs.currents.dev/getting-started/other-frameworks/cypress/integrating-with-cypress.md): Overview of tools available for integrating cypress with Currents or Sorry Cypress
- [Compatibility](https://docs.currents.dev/getting-started/other-frameworks/cypress/integrating-with-cypress/compatibility.md): Integrating Cypress with Currents - compatibility table
- [Alternative Cypress Binaries](https://docs.currents.dev/getting-started/other-frameworks/cypress/integrating-with-cypress/alternative-cypress-binaries.md): Using alternative Cypress Binaries
- [CI Setup](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup.md)
- [Cypress - GitHub Actions](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-github-actions.md): Using GitHub Actions Matrix for parallelizing Cypress tests
- [Cypress - GitLab CI/CD](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-gitlab-ci-cd.md): Running Cypress test in parallel on GitLab
- [Cypress - Jenkins](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-jenkins.md): Running Cypress tests in parallel with Jenkins and Currents Dashboard
- [Cypress - CircleCI](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-circleci.md): Running Cypress tests in parallel on CircleCI and Currents dashboard
- [Cypress - Bitbucket Pipelines](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-bitbucket-pipelines.md): Running Cypress tests in parallel on Bitbucket Pipelines and Currents dashboard
- [Cypress - Azure DevOps](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-azure-devops.md): Running Cypress test in parallel on Azure DevOps and Currents Dashboard
- [Cypress - AWS Code Build](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-aws-code-build.md): Running Cypress in parallel on AWS CodeBuild
- [Cypress - NX](https://docs.currents.dev/getting-started/other-frameworks/cypress/ci-setup/cypress-nx.md): Running Cypress tests with NX
- [Troubleshooting Cypress](https://docs.currents.dev/getting-started/other-frameworks/cypress/troubleshooting-cypress.md): Troubleshooting Currents integration with Cypress


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.currents.dev/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
