Currents Documentation
Currents.devGitHubChangelog
  • Getting Started
    • What is Currents?
    • Playwright
      • Playwright: Quick Start
      • Troubleshooting Playwright
    • Cypress
      • Your First Cypress Run
      • Integrating with Cypress
        • Compatibility
        • Alternative Cypress Binaries
      • Troubleshooting Cypress
    • Jest
      • Your First Jest Run
      • Detox + Jest
      • Troubleshooting Jest
    • Others
    • CI Setup
      • GitHub Actions
        • Cypress - GitHub Actions
        • Playwright - GitHub Actions
        • Jest - GitHub Actions
        • Node.js - GitHub Actions
        • Commit data for GitHub Actions
        • Custom Docker runners
        • Named Runners
      • GitLab
        • Cypress - GitLab CI/CD
        • Playwright - GitLab CI/CD
        • Custom Docker runners
      • Jenkins
        • Cypress - Jenkins
        • Playwright - Jenkins
      • CircleCI
        • Cypress - CircleCI
        • Playwright - CircleCI
      • Bitbucket
        • Cypress - Bitbucket Pipelines
      • Azure DevOps
        • Cypress - Azure DevOps
        • Playwright - Azure DevOps
      • AWS Code Build
        • Cypress - AWS Code Build
        • Playwright - AWS Code Build
      • NX
        • Playwright - NX
        • Cypress - NX
  • Guides
    • Record Key
    • CI Build ID
    • Reporting
      • Reporting Strategy
      • Reporting in CI
      • Step-Level Reporting
    • CI Optimization
      • Playwright Parallelization
      • Orchestration Setup
      • Fully Parallel Mode
      • Re-run Only Failed Tests
      • Cloud Spot Instances
      • Failing Fast
      • Load Balancing
    • Code Coverage
      • Code Coverage for Playwright
      • Code Coverage for Cypress
    • Currents Actions
      • Setup Currents Actions
      • Using Currents Actions
      • Reference
        • Conditions
        • Actions
    • Playwright Component Testing
    • Playwright Visual Testing
    • Playwright Annotations
    • Playwright Tags
    • MCP Server
  • Dashboard
    • Projects
      • Projects Summary view
      • Project Settings
      • Archive and Unarchive Projects
    • Runs
      • Run Status
      • Run Details
      • Commit Information
      • Tags
      • Run Timeouts
      • Cancelling Runs
      • Deleting Runs
      • Run Progress
    • Tests
      • Spec File Status
      • Test Status
      • Flaky Tests
      • Test History
    • Test Suite Explorer
      • Test Explorer
        • Tests Performance
      • Spec Files Explorer
        • Spec Files Performance
      • Errors Explorer
  • Automated Reports
  • Insights and Analytics
  • Administration
    • Email Domain Based Access
    • SSO SAML2.0
      • SAML2.0 Configuration
      • SCIM User Provisioning
      • IdP-initiated Sessions
      • JumpCloud
        • JumpCloud User provisioning
      • Okta
        • Okta User provisioning
      • Troubleshooting SSO
    • Billing & Usage
  • Billing and Pricing
  • Resources
    • Reporters
      • cypress-cloud
        • Batched Orchestration
        • Migration to Cypress@13
      • @currents/cli
      • @currents/playwright
        • Configuration
        • pwc
        • pwc-p (orchestration)
        • Playwright Fixtures
      • @currents/jest
      • @currents/node-test-reporter
      • @currents/cmd
        • currents api
        • currents upload
        • currents cache
        • currents convert
      • Data Format Reference
    • Integrations
      • GitHub
        • GitHub App
        • GitHub OAuth
      • GitLab
      • Slack
      • Microsoft Teams
      • HTTP Webhooks
      • Bitbucket
    • API
      • Introduction
      • Authentication
      • API Keys
      • Errors
      • Pagination
      • API Resources
        • Instances
        • Runs
        • Projects
        • Spec Files
        • Test Signature
        • Test Results
    • Data Privacy
      • Access to Customer Data
      • Data Retention
      • Cloud Endpoints
    • Support
Powered by GitBook
On this page
  • Supported formats
  • Usage
  • Configuration

Was this helpful?

  1. Resources
  2. Reporters
  3. @currents/cmd

currents convert

CLI tool for converting reports from various formats to Currents-compatible format

currents convert allows converting test reports created by various frameworks to a format compatible with Currents API. A typical workflow is:

  • Run tests using your preferred framework and save the results in a file

  • Convert the report using currents convert command

  • Upload the report to Currents using currents upload command

Supported formats

The command converts files of one of the supported format, generated by the one of the supported frameworks.

Support frameworks

Framework
Supported

Postman

✅

Vitest

✅

WebdriverIO

✅

NodeJS Testing

Cypress

👷🏾‍♀️ work in progress

If you're interested in enabling support for more frameworks, please get in touch with our support team.

Usage

npx currents convert \
  --input-format=<format> \
  --input-file=<pattern> \
  --output-dir=<path> \
  --framework=<string> \
  --framework-version=<string>

Example:

npx currents convert \
  --input-format=junit \
  --input-file=./tests.xml \ 
  --output-dir=.currents/report-01 \ 
  --framework=postman \
  --framework-version=v11.20
# Reading the configuration
[currents] Convertion files: tests.xml
# Creating the config.json file...
# Converting files to internal Currents format
[currents] Conversion completed, report saved to: .currents/report-01

Configuration

currents convert options apart from --framework-version are required. Use --help flag to list the available options.

  • --input-format

    • The format of the input test reports. Use the --help flag to see the supported formats

    • Type: junit

  • --input-file

    • Comma-separated glob patterns to match the test results files (e.g., "report1.xml,report2.xml)

    • The multi-file match is only available starting on version 1.6.8 of @currents/cmd package.

    • Type: string

  • -o, --output-dir

    • The directory to save the converted test reports

    • Type: string

  • --framework

    • The testing framework used to generate the test reports

    • Type: postman, vitest, wdio

  • --framework-version

    • The version of the testing framework used to generate the test reports

    • Type: string

  • --debug

    • Enable debug logs

    • Environment variable: DEBUG=currents*

    • Type: boolean

Previouscurrents cacheNextData Format Reference

Last updated 12 days ago

Was this helpful?

✅ (see )

@currents/node-test-reporter