# Currents Documentation

## Currents

- [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
- [Overview](https://docs.currents.dev/ai/overview.md): Give AI agents your Playwright results from CI to fix tests and prove changes, and have agents record screenshots, video and traces of their own work
- [Agentic testing](https://docs.currents.dev/ai/agentic-testing.md): AI agents working with your CI test runs in Currents: fix failing tests, prove a change with the tests that cover it, and share a run
- [Fix failing CI tests](https://docs.currents.dev/ai/agentic-testing/fix-failing-tests.md): Hand a failing test to an AI agent with the full failure context, from the dashboard, Slack, the GitHub run comment, your editor or the MCP server
- [Prove a change with CI tests](https://docs.currents.dev/ai/agentic-testing/prove-a-change.md): Prove an AI agent's change works with the CI tests that cover it: before and after screenshots, videos and traces from the runs Currents already stores
- [Share a CI run](https://docs.currents.dev/ai/agentic-testing/share-a-run.md): Share a recording of a CI run with a colleague or an agent: one link to every test, with its screenshots, videos, traces and other files
- [Agent evidence](https://docs.currents.dev/ai/agent-evidence.md): Record screenshots, video, a Playwright trace and logs of what your AI agent did, and share them as one link: proof for a pull request, a bug report or a task that is not a test
- [Record a bug and its fix](https://docs.currents.dev/ai/agent-evidence/bug-and-fix.md): Have an AI agent record a bug and its fix in the browser, with screenshots, page snapshots and a Playwright trace, and post the before and after on the pull request as proof the change works
- [With Playwright MCP](https://docs.currents.dev/ai/agent-evidence/bug-and-fix/playwright-mcp.md): Record what an agent did with Playwright MCP, with a trace, screenshots and page snapshots, and share it as a Currents session
- [With Playwright CLI](https://docs.currents.dev/ai/agent-evidence/bug-and-fix/playwright-cli.md): Record what an agent did with Playwright CLI, with a trace, video, screenshots and page snapshots, and share it as a Currents session
- [Record any agent task](https://docs.currents.dev/ai/agent-evidence/any-agent-task.md): Record the logs, output files and screenshots of any task an AI agent did, not only testing, and share them as one link that outlives the machine it ran on
- [Record local test results](https://docs.currents.dev/ai/agent-evidence/local-test-results.md): Share the traces, screenshots and videos of a Playwright Test or Vitest run that is not reported to Currents, as one session
- [Record without the Currents CLI](https://docs.currents.dev/ai/agent-evidence/mcp-tools.md): Record a session with the Currents MCP tools when the agent cannot run the currents command
- [Agentic artifacts](https://docs.currents.dev/ai/agentic-artifacts.md): Let agents read Playwright traces in small steps, and post screenshots, traces and recordings from Currents to GitHub, Slack and Linear
- [Explore a trace](https://docs.currents.dev/ai/agentic-artifacts/explore-a-trace.md): Give an agent a trace API link, and let it read a Playwright trace in small steps instead of loading the whole file. Get images of the trace for people: filmstrip, animation, frames and the page at th
- [Post to GitHub, Slack, Linear](https://docs.currents.dev/ai/agentic-artifacts/post-evidence.md): Have an AI agent post what Currents recorded, such as a session, a shared run, a Fix link, or one screenshot, video or trace image from them, on a GitHub pull request, in Slack or on a Linear issue
- [Agent skills](https://docs.currents.dev/ai/agent-skills.md): The agent skills Currents provides, what each is for, and how to make an agent use one
- [Currents MCP server skills](https://docs.currents.dev/ai/agent-skills/agent-skill-currents-mcp.md): The skills the Currents MCP server gives a connected agent: fix-failing-tests, collect-evidence and browser-evidence
- [Currents CLI skill](https://docs.currents.dev/ai/agent-skills/agent-skill-currents-cli.md): The currents-cli skill teaches an agent with a shell to record sessions and use the currents command
- [Playwright best practices](https://docs.currents.dev/ai/agent-skills/agent-skill-playwright-best-practices.md): An agent skill that teaches AI agents to write, debug and maintain Playwright tests the way an experienced Playwright engineer would
- [Connect your agent](https://docs.currents.dev/ai/connect.md): Connect Claude, Cursor, Codex, ChatGPT, your editor or any other MCP client to Currents, and pick the setup that fits where you work
- [Claude Code](https://docs.currents.dev/ai/connect/claude-code.md): Connect Claude Code to Currents with one command and a browser sign-in, for yourself or for everyone working in a repository
- [Cursor](https://docs.currents.dev/ai/connect/cursor.md): Connect Cursor to the Currents MCP server with an install link and a browser sign-in, for yourself or for everyone working in a repository
- [Claude Desktop and Claude.ai](https://docs.currents.dev/ai/connect/claude.md): Connect Currents to Claude Desktop and Claude.ai from the Claude connectors directory, for yourself or for your whole Claude organization
- [Codex](https://docs.currents.dev/ai/connect/codex.md): Connect Codex (the CLI, the IDE extension and the ChatGPT desktop app) to Currents with one command and a browser sign-in
- [ChatGPT](https://docs.currents.dev/ai/connect/chatgpt.md): Add Currents to ChatGPT as a developer-mode app connected to the Currents MCP server
- [IDE Extension](https://docs.currents.dev/ai/connect/ide-extension.md): See CI runs and failures in VS Code or Cursor, and send a failure to your AI agent with its full context
- [Any MCP client](https://docs.currents.dev/ai/connect/remote.md): Connect any MCP client to the Currents MCP server with a sign-in or an API key, what a connection can reach, and the endpoint reference
- [Local MCP Server](https://docs.currents.dev/ai/connect/local.md): Run the Currents MCP server on your own machine with the @currents/mcp package and an API key
- [Reference](https://docs.currents.dev/ai/reference.md): Reference for Currents share links, sessions, the trace API, and the MCP server tools and permissions
- [Share links](https://docs.currents.dev/ai/reference/share-links.md): What a share link opens when you share a failing test, a run, a browser session, a file or a trace, who can open it, how long it lasts, and how to turn share links off
- [Sessions](https://docs.currents.dev/ai/reference/sessions.md): What a Currents session holds, which keys can create and read one, how to list and delete sessions with the API, and their limits
- [Trace API](https://docs.currents.dev/ai/reference/trace-api.md): Every route of the Currents trace API, with its options and real output: the trace summary, the player, screen frames, filmstrips and animations, the page at any time in five formats, network requests
- [MCP tools and permissions](https://docs.currents.dev/ai/reference/mcp-server.md): Every tool of the Currents MCP server, what it does and the permission it needs, and how the hosted and local servers differ
- [Record Key](https://docs.currents.dev/guides/record-key.md): Using record key to associate your runs with your organization
- [Reporting](https://docs.currents.dev/guides/parallelization-guide.md)
- [Reporting Strategy](https://docs.currents.dev/guides/parallelization-guide/reporting-strategy.md): How to structure and organize the reporting of CI test results to Currents
- [CI Build ID](https://docs.currents.dev/guides/parallelization-guide/ci-build-id.md): Using CI Build ID for reporting to Currents
- [Reporting in CI](https://docs.currents.dev/guides/parallelization-guide/playwright-sharding.md): Playwright Sharding and reporting the results to Currents
- [Step-Level Reporting](https://docs.currents.dev/guides/parallelization-guide/step-level-reporting.md): Live test results: near-realtime streaming of step-level progress from CI machines
- [Test Orchestration](https://docs.currents.dev/guides/test-orchestration.md): The better alternative to Playwright Sharding
- [CI Optimization](https://docs.currents.dev/guides/ci-optimization.md): A guide on optimizing Playwright tests in CI for better efficiency
- [Playwright Parallelization](https://docs.currents.dev/guides/ci-optimization/playwright-parallelization.md): A guide to Playwright Parallelization for speeding up Playwright tests in CI
- [Orchestration Setup](https://docs.currents.dev/guides/ci-optimization/playwright-orchestration.md): Setup instructions for Playwright Orchestration
- [Migration Guide](https://docs.currents.dev/guides/ci-optimization/playwright-orchestration/playwright-orchestration-migration-guide.md): Migration Guide for Currents Orchestration v1 -> v2
- [Orchestration (v1)](https://docs.currents.dev/guides/ci-optimization/playwright-orchestration/playwright-orchestration-v1.md): Playwright Orchestration Setup Guide for Currents v1
- [Fully Parallel Mode](https://docs.currents.dev/guides/ci-optimization/fully-parallel-mode.md): A guide on Playwright Fully Parallel mode
- [Re-run Only Failed Tests](https://docs.currents.dev/guides/ci-optimization/re-run-only-failed-tests.md): A guide on rerunning only failed Playwright tests in CI
- [Sharded runs](https://docs.currents.dev/guides/ci-optimization/re-run-only-failed-tests/re-run-only-failed-tests-sharded.md): Re-run only failed tests when using native Playwright sharding
- [Orchestrated runs](https://docs.currents.dev/guides/ci-optimization/re-run-only-failed-tests/re-run-only-failed-tests-orchestrated-v2.md): Re-run only failed Playwright tests when using Currents Orchestration
- [Cloud Spot Instances](https://docs.currents.dev/guides/ci-optimization/ci-tests-on-spot-instances.md): Running Playwright E2E tests on CI Spot Instances and using Currents Orchestration to automatically rerouting tests before an eviction.
- [Failing Fast](https://docs.currents.dev/guides/ci-optimization/fail-fast-strategy.md): Fail-fast or cancelling runs on first failure
- [Load Balancing](https://docs.currents.dev/guides/ci-optimization/load-balancing.md): Review of Orchestration strategies for Cypress and Playwright tests
- [Code Coverage](https://docs.currents.dev/guides/coverage.md): Collect Code Coverage reports for web applications using Playwright or Cypress
- [Code Coverage for Playwright](https://docs.currents.dev/guides/coverage/code-coverage-for-playwright.md): Learn how to enable Code Coverage reporting for Playwright
- [Code Coverage for Cypress](https://docs.currents.dev/guides/coverage/code-coverage-for-cypress.md): Learn how to setup Cypress to start reporting code coverage results
- [Currents Actions](https://docs.currents.dev/guides/currents-actions.md): Automate workflows by triggering actions based on flexible rules and conditions
- [Setting up Currents Actions](https://docs.currents.dev/guides/currents-actions/setup-currents-actions.md): Setting up Current Actions for your Playwright Project
- [Using Currents Actions](https://docs.currents.dev/guides/currents-actions/using-currents-actions.md): Create and Manage Currents Actions, trace action applications and outcomes
- [Affected Tests](https://docs.currents.dev/guides/currents-actions/affected-tests.md): Track what tests have been affected by Actions
- [Reference](https://docs.currents.dev/guides/currents-actions/reference.md): Currents Actions - condition, operations and actions reference documentation
- [Conditions](https://docs.currents.dev/guides/currents-actions/reference/conditions.md): Reference documentation of Conditions that are available for Currents Actions
- [Actions](https://docs.currents.dev/guides/currents-actions/reference/actions.md): Reference documentation for actions that apply as part for Currents Actions Engine
- [Lifecycle Notifications](https://docs.currents.dev/guides/currents-actions/lifecycle-notifications.md): Configure and receive action lifecycle notifications
- [Playwright Component Testing](https://docs.currents.dev/guides/playwright-component-testing.md): Using Currents with Playwright Component testing
- [Playwright Visual Testing](https://docs.currents.dev/guides/playwright-visual-testing.md): Integrating Playwright Visual Comparison tools with Currents - including Argos, Percy and Applitools.
- [Playwright Annotations](https://docs.currents.dev/guides/playwright-annotations.md): Using Playwright Annotations to enhance reporting to Currents dashboard
- [Playwright Tags](https://docs.currents.dev/guides/playwright-tags.md): How to tag Playwright executions in Currents
- [Environments](https://docs.currents.dev/guides/environments.md): How to label and filter Currents runs by environment (e.g. staging, production)
- [Missing Runs](https://docs.currents.dev/guides/missing-runs.md): What to check when test results don't reach Currents, on the first run or after runs stop arriving from CI
- [Troubleshooting](https://docs.currents.dev/guides/troubleshooting-playwright.md): Troubleshooting Playwright integration with Currents
- [Projects](https://docs.currents.dev/dashboard/projects.md)
- [Project Overview](https://docs.currents.dev/dashboard/projects/project-overview.md): Project health at a glance - run and test trends, latest runs and pull requests, and the tests and errors to fix first
- [Projects Summary view](https://docs.currents.dev/dashboard/projects/projects-summary-view.md): Customize how you visualize projects
- [Project Settings](https://docs.currents.dev/dashboard/projects/project-settings.md): Fine-tune your project settings
- [Archive and Unarchive Projects](https://docs.currents.dev/dashboard/projects/archive-and-unarchive-projects.md): Feature to better manage and visualize projects
- [Runs](https://docs.currents.dev/dashboard/runs.md)
- [Run Details](https://docs.currents.dev/dashboard/runs/run-details.md): Run details and metadata - git, environment, status
- [Pull Requests](https://docs.currents.dev/dashboard/runs/pull-requests.md): Browse a project's runs grouped by the pull request that triggered them
- [Commit Information](https://docs.currents.dev/dashboard/runs/commit-information.md): Displaying Commit Information on Currents
- [Tags](https://docs.currents.dev/dashboard/runs/tags.md): Using Tags in Currents Dashboard
- [Run Timeouts](https://docs.currents.dev/dashboard/runs/run-timeouts.md): Understand tests timeouts and how to avoid them
- [Run Attachments](https://docs.currents.dev/dashboard/runs/run-attachments.md): Find the screenshots, videos, traces and files of a run in one list on the Attachments tab of the run page
- [Cancelling Runs](https://docs.currents.dev/dashboard/runs/cancel-run.md): Cancelling CI tests runs
- [Deleting Runs](https://docs.currents.dev/dashboard/runs/deleting-runs.md): This feature allows you to permanently remove a run from our Dashboard
- [Run Progress](https://docs.currents.dev/dashboard/runs/run-progress.md): Run progress view show the detailed distribution of your test on CI machines
- [Tests](https://docs.currents.dev/dashboard/tests.md)
- [Test View](https://docs.currents.dev/dashboard/tests/test-view.md): Structured view of tests executed within each spec file.
- [Test Details](https://docs.currents.dev/dashboard/tests/run-details.md): Summary info for each executed test
- [Test Status](https://docs.currents.dev/dashboard/tests/test-status.md): Playwright and Cypress Test Status - detailed guide and explanation
- [Flaky Tests](https://docs.currents.dev/dashboard/tests/flaky-tests.md): Guide to Playwright Flaky Tests
- [Test History](https://docs.currents.dev/dashboard/tests/test-history.md): Explore historical Playwright and Cypress tests performance with Test History
- [Spec Files](https://docs.currents.dev/dashboard/spec-file-status.md)
- [Spec Files View](https://docs.currents.dev/dashboard/spec-file-status/spec-files-view.md): Structured view of spec file executions, tests, metrics, and history.
- [Spec File Details](https://docs.currents.dev/dashboard/spec-file-status/run-details.md): Summary info for each executed spec file
- [Spec Files Status](https://docs.currents.dev/dashboard/spec-file-status/spec-files-status.md): Playwright Spec files status in Currents Dashboard
- [Test Suite Explorer](https://docs.currents.dev/dashboard/test-suite-performance-explorer.md): Explore Test Suite Health and Performance with Currents Explorer
- [Test Explorer](https://docs.currents.dev/dashboard/test-suite-performance-explorer/tests-explorer.md): Test Health and Performance Dashboard - Flakiness, Failure Rate, Duration.
- [Spec Files Explorer](https://docs.currents.dev/dashboard/test-suite-performance-explorer/spec-files-explorer.md): Spec-level Health and Performance Dashboard - Flakiness, Failure Rate, Duration, Suite Size
- [Error Explorer](https://docs.currents.dev/dashboard/test-suite-performance-explorer/errors-explorer.md): Error Explorer helps discover the top errors, components and network request impacting your Playwright CI runs.
- [Reference](https://docs.currents.dev/dashboard/test-suite-performance-explorer/reference.md): How to read and use Test Explorer and Spec Files Explorer performance charts
- [Automated Reports](https://docs.currents.dev/dashboard/automated-reports.md): Proactively Detecting Test Performance Regressions
- [Analytics](https://docs.currents.dev/dashboard/analytics.md): Visualize test suite trends, track performance metrics, and identify patterns over time
- [Run Status](https://docs.currents.dev/dashboard/analytics/run-status.md): Track the distribution of run outcomes over time
- [Run Duration](https://docs.currents.dev/dashboard/analytics/run-duration.md): Track average run duration over time
- [Run Completion](https://docs.currents.dev/dashboard/analytics/run-completion.md): Track the distribution of runs by completion status
- [Run Size](https://docs.currents.dev/dashboard/analytics/run-size.md): Track maximum specs and tests per run
- [Test Results](https://docs.currents.dev/dashboard/analytics/test-results.md): Track the distribution of test outcomes over time
- [Test Flakiness](https://docs.currents.dev/dashboard/analytics/test-flakiness.md): Track flaky test distribution over time
- [Suite Size](https://docs.currents.dev/dashboard/analytics/suite-size.md): Track changes in test suite composition over time
- [Administration](https://docs.currents.dev/dashboard/administration.md)
- [Manage Projects](https://docs.currents.dev/dashboard/administration/manage-projects.md): Organize projects into folders, label them, control their ordering and appearance, and choose which run states count towards the project preview metrics
- [Manage Team](https://docs.currents.dev/dashboard/administration/manage-team.md): Allows managing the team members, invitations and roles
- [API Keys](https://docs.currents.dev/dashboard/administration/api-keys.md): Create and manage API keys to access the Currents REST API, MCP server, and integrations
- [Verified Domains](https://docs.currents.dev/dashboard/administration/email-domain-based-access.md): Verify an email domain so new users with an address on it join the organization automatically
- [SSO SAML2.0](https://docs.currents.dev/dashboard/administration/sso-saml2.0.md): SSO SAML2.0 Instructions for Currents
- [Setting Up SSO](https://docs.currents.dev/dashboard/administration/sso-saml2.0/setting-up-sso.md): Request SSO from the dashboard - a four-step wizard that collects the identity provider details Currents needs to connect it
- [SAML2.0 Configuration](https://docs.currents.dev/dashboard/administration/sso-saml2.0/saml2.0-configuration.md): Enabling SSO for Currents - manual SAML2.0 configuration
- [SCIM User Provisioning](https://docs.currents.dev/dashboard/administration/sso-saml2.0/scim-user-provisioning.md): Provision and de-provision users in Currents using SCIM v2
- [IdP-initiated Sessions](https://docs.currents.dev/dashboard/administration/sso-saml2.0/idp-initiated-sessions.md): IdP-initiated sign-in sessions for Currents
- [Azure AD / Entra ID](https://docs.currents.dev/dashboard/administration/sso-saml2.0/azure-ad.md): Setting up SAML2.0 SSO with Azure AD / Microsoft Entra ID as an IdP for Currents
- [JumpCloud](https://docs.currents.dev/dashboard/administration/sso-saml2.0/jumpcloud.md): Setting up SAML2.0 SSO with JumpCloud as an IdP for Currents
- [JumpCloud User provisioning](https://docs.currents.dev/dashboard/administration/sso-saml2.0/jumpcloud/jumpcloud-user-provisioning.md): Provision and de-provision users in Currents using JumpCloud
- [Okta](https://docs.currents.dev/dashboard/administration/sso-saml2.0/okta.md): Setting up SAML2.0 SSO with Okta as an IdP - Currents SSO
- [Okta User provisioning](https://docs.currents.dev/dashboard/administration/sso-saml2.0/okta/okta-user-provisioning.md): Provision and de-provision users in Currents using Okta
- [Troubleshooting SSO](https://docs.currents.dev/dashboard/administration/sso-saml2.0/troubleshooting-sso.md): Troubleshooting SSO connectivity to Currents
- [Billing](https://docs.currents.dev/dashboard/billing.md): Plans, pricing, usage and spend control for your organization
- [Plans & Pricing](https://docs.currents.dev/dashboard/billing/plans-and-pricing.md): How Currents Billing and Pricing Works
- [Usage & Spend Control](https://docs.currents.dev/dashboard/billing/usage-and-spend-control.md): Monitor usage, configure alerts and spend control for your organization
- [Overview](https://docs.currents.dev/authentication/authentication.md): How something outside Currents proves who it is - an API key for automation, an OAuth grant for an application a person drives, or a personal access token for a person's own scripts and tools
- [OAuth](https://docs.currents.dev/authentication/oauth.md): Authorize an application to act as a Currents user inside one organization - the connection flow, the permissions a grant carries, and how to review or revoke it
- [Personal Access Tokens](https://docs.currents.dev/authentication/personal-access-tokens.md): A credential that acts as one person inside one organization, carrying only the permissions it was created with - creating one, what each permission reaches, and when a token stops working
- [Reporters](https://docs.currents.dev/resources/reporters.md)
- [@currents/playwright](https://docs.currents.dev/resources/reporters/currents-playwright.md): Setup and usage instructions for Playwright integration with Currents Dashboard
- [Compatibility Guide](https://docs.currents.dev/resources/reporters/currents-playwright/compatibility.md): Discover the compatible versions of @currents/playwright
- [Configuration](https://docs.currents.dev/resources/reporters/currents-playwright/configuration.md): @currents/playwright configuration reference
- [pwc](https://docs.currents.dev/resources/reporters/currents-playwright/pwc.md): pwc command-line executable documentation
- [pwc-p (orchestration)](https://docs.currents.dev/resources/reporters/currents-playwright/pwc-p.md): Currents orchestration pwc-p command-line executable documentation
- [pwc-p discover](https://docs.currents.dev/resources/reporters/currents-playwright/pwc-p/pwc-p-discover.md): pwc-p discover command documentation - test discovery and filtering for Playwright orchestration
- [pwc-p run](https://docs.currents.dev/resources/reporters/currents-playwright/pwc-p/pwc-p-run.md): pwc-p run command documentation - orchestration execution for Playwright
- [Playwright Fixtures](https://docs.currents.dev/resources/reporters/currents-playwright/playwright-fixtures.md): Enhance Playwright functionality with Currents fixtures for Playwright
- [@currents/cmd](https://docs.currents.dev/resources/reporters/currents-cmd.md): The currents command line tool: upload test results, attach files to a run, get or cancel a run, capture sessions as evidence, cache files between CI jobs, and call the Currents REST API
- [currents run upload](https://docs.currents.dev/resources/reporters/currents-cmd/currents-upload.md): Upload test results of the Jest and Node.js test runner reporters, JUnit XML reports or Cypress run results to Currents with the currents run upload command, with environments and Currents Actions
- [Upload JUnit XML reports](https://docs.currents.dev/resources/reporters/currents-cmd/currents-convert.md): Convert JUnit XML reports of Cypress, Postman, Vitest, WebdriverIO or the Node.js test runner, or Cypress run results, to the Currents format and upload them with currents run upload
- [currents run attach](https://docs.currents.dev/resources/reporters/currents-cmd/currents-run-attach.md): Attach logs, screenshots and other files to a run recorded in CI, after the tests finished, with the currents run attach command
- [currents run get](https://docs.currents.dev/resources/reporters/currents-cmd/currents-run-get.md): Get the data of a Currents run by CI build ID, or the last run of a branch or tag, with the currents run get command
- [currents run cancel](https://docs.currents.dev/resources/reporters/currents-cmd/currents-cancel.md): Cancel a Currents run from CI, for example when the CI job is cancelled, with the currents run cancel command
- [currents session](https://docs.currents.dev/resources/reporters/currents-cmd/currents-session.md): Capture an agent or browser session as evidence in Currents, attach screenshots, Playwright traces and logs, and share a link, with the currents session commands
- [currents cache](https://docs.currents.dev/resources/reporters/currents-cmd/currents-cache.md): Save files to the Currents cache in one CI job and restore them in another with the currents cache command
- [currents api](https://docs.currents.dev/resources/reporters/currents-cmd/currents-api.md): Call any route of the Currents REST API from the command line with the currents api command
- [currents skill](https://docs.currents.dev/resources/reporters/currents-cmd/currents-skill.md): Install the currents-cli agent skill, which tells coding agents such as Claude Code, Codex and Cursor how to use the currents command
- [Upgrade to 2.0](https://docs.currents.dev/resources/reporters/currents-cmd/upgrade-to-v2.md): Upgrade @currents/cmd from 1.x to 2.0: the breaking changes and the commands to change in scripts and CI jobs
- [@currents/jest](https://docs.currents.dev/resources/reporters/currents-jest.md): Currents reporter for Jest
- [@currents/node-test-reporter](https://docs.currents.dev/resources/reporters/currents-node-test-reporter.md): Currents Reporter for Node.js Testing Framework
- [@currents/cli](https://docs.currents.dev/resources/reporters/currents-cli.md): Setup and usage instructions for Cypress integration with Currents Dashboard
- [cypress-cloud](https://docs.currents.dev/resources/reporters/cypress-cloud.md): Setup and usage instruction for cypress-cloud
- [Batched Orchestration](https://docs.currents.dev/resources/reporters/cypress-cloud/batched-orchestration.md): Batched orchestration for cypress-cloud
- [Migration to Cypress@13](https://docs.currents.dev/resources/reporters/cypress-cloud/migration-to-cypress-13.md): Use cypress-cloud with Cypress@13
- [Data Format Reference](https://docs.currents.dev/resources/reporters/data-format-reference.md): Currents Reporting API - Data Format Reference
- [Alternatives to Currents](https://docs.currents.dev/resources/reporters/alternatives-to-currents.md): How to chose the best Playwright Reporter
- [Integrations](https://docs.currents.dev/resources/integrations.md)
- [n8n](https://docs.currents.dev/resources/integrations/n8n.md): Integrate Currents in n8n ecosystem
- [GitHub](https://docs.currents.dev/resources/integrations/github.md): Integrating GitHub with Currents dashboard for running Playwright tests
- [GitHub App](https://docs.currents.dev/resources/integrations/github/github-app.md): Cypress and Playwright GitHub App integration for Currents dashboard
- [GitHub OAuth](https://docs.currents.dev/resources/integrations/github/github-oauth.md)
- [GitLab](https://docs.currents.dev/resources/integrations/gitlab.md): Integrating Currents dashboard with GitLab
- [Slack](https://docs.currents.dev/resources/integrations/slack.md): Integrating Slack with Currents dashboard for test notifications
- [Slack App](https://docs.currents.dev/resources/integrations/slack/slack-app.md): Slack App integration for Currents - test notifications and alerts
- [Slack Webhook](https://docs.currents.dev/resources/integrations/slack/slack-webhook.md): Send Playwright and Cypress tests results to Slack using Webhooks
- [Microsoft Teams](https://docs.currents.dev/resources/integrations/microsoft-teams.md): Send Cypress and Playwright tests results to Microsoft Teams
- [HTTP Webhooks](https://docs.currents.dev/resources/integrations/http-webhooks.md): HTTP Webhooks for getting runs information
- [Bitbucket](https://docs.currents.dev/resources/integrations/bitbucket.md): Send Cypress and Playwright tests results to Bitbucket
- [Jira](https://docs.currents.dev/resources/integrations/jira.md): Connect Currents with Jira to create new or link existing issues in Jira without leaving Currents
- [Setup](https://docs.currents.dev/resources/integrations/jira/setup.md): Setup instructions for Currents integration with Jira
- [Usage](https://docs.currents.dev/resources/integrations/jira/usage.md): Learn how to use Currents Jira Integration
- [Custom Fields](https://docs.currents.dev/resources/integrations/jira/custom-fields.md): Jira Custom fieds support
- [Linear](https://docs.currents.dev/resources/integrations/linear.md): Create and link issues from test failures in your Linear workspace
- [Setup](https://docs.currents.dev/resources/integrations/linear/setup.md): Setup instructions for Currents integration with Linear
- [Usage](https://docs.currents.dev/resources/integrations/linear/usage.md): Learn how to use Currents Linear Integration
- [Data Privacy](https://docs.currents.dev/resources/data-privacy.md)
- [Access to Customer Data](https://docs.currents.dev/resources/data-privacy/access-to-customer-data.md): Overview of Customer Data that Currents collects during its execution
- [Data Redaction](https://docs.currents.dev/resources/data-privacy/data-redaction.md): Learn how Currents automatically detects and removes sensitive information such as tokens, passwords, and API keys from trace files to ensure your data remains secure and compliant.
- [Bring Your Own Storage](https://docs.currents.dev/resources/data-privacy/byos.md): Learn how Currents can be integrated to your own S3-compatible object storage.
- [Data Retention](https://docs.currents.dev/resources/data-privacy/data-retention.md): Retention periods for different types of data collected by Currents
- [Cloud Endpoints](https://docs.currents.dev/resources/data-privacy/cloud-endpoints.md): A list of internet-facing Currents services and endpoints
- [Changelog](https://docs.currents.dev/resources/changelog.md): Currents resources changelog reference
- [Support](https://docs.currents.dev/resources/support.md): Users guide for reporting support and troubleshooting issues with Currents systems

## API

- [Intro](https://docs.currents.dev/api/readme.md)
- [Authentication](https://docs.currents.dev/api/get-started/authentication.md)
- [Pagination](https://docs.currents.dev/api/get-started/pagination.md)
- [Errors](https://docs.currents.dev/api/get-started/errors.md)
- [Integrations](https://docs.currents.dev/api/resources/integrations.md)
- [Actions](https://docs.currents.dev/api/resources/actions.md)
- [Context](https://docs.currents.dev/api/resources/context.md)
- [Projects](https://docs.currents.dev/api/resources/projects.md)
- [Runs](https://docs.currents.dev/api/resources/runs.md)
- [Sessions](https://docs.currents.dev/api/resources/sessions.md)
- [Instances](https://docs.currents.dev/api/resources/instances.md)
- [Test Results](https://docs.currents.dev/api/resources/test-results.md)
- [Tests Explorer](https://docs.currents.dev/api/resources/tests-explorer.md)
- [Errors Explorer](https://docs.currents.dev/api/resources/errors-explorer.md)
- [Spec Files](https://docs.currents.dev/api/resources/spec-files.md)
- [Organizations](https://docs.currents.dev/api/resources/organizations.md)
- [Signature](https://docs.currents.dev/api/resources/signature.md)
- [Webhooks](https://docs.currents.dev/api/resources/webhooks.md)


---

# 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
This site has an agentic ask interface you may use to query the documentation dynamically 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/index.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.