Package Exports

oyacloud
oyacloud/bin/oyacloud.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (oyacloud) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

oyacloud

OyaCloud CLI for uploading test results from CI/CD pipelines and local runs.

Installation

npm install -g oyacloud

Setup

Save your API key once after installation — you won't need to pass it on every command:

oyacloud config set-key YOUR_API_KEY

Your API key is included in your welcome email when your account is approved.

Usage

oyacloud upload \
  --framework playwright_ts \
  --project my-app \
  --environment staging \
  --results-dir ./playwright-report

The CLI automatically detects whether it's running in CI or locally:

In CI — reads branch, PR number, author, build type from CI environment variables
Locally — reads branch, commit, author from git

Supported Frameworks

Value	Framework
`playwright_ts`	Playwright (TypeScript)
`playwright_py`	Playwright (Python)
`testng_java`	TestNG (Java)
`pytest_python`	PyTest (Python)
`junit_java`	JUnit (Java)
`cypress_js`	Cypress (JavaScript)

Options

Option	Required	Description
`--framework`	Yes	Test framework (see table above)
`--project`	Yes	Project name (must match project in OyaCloud)
`--environment`	Yes	Target environment (e.g. `staging`, `qa`, `prod`)
`--results-dir`	Yes	Directory containing test result files
`--api-key`	No*	API key (*skip if set via `oyacloud config set-key`)
`--build-type`	No	Override auto-detected build type (`pr\|post-merge\|regression\|local`)
`--branch`	No	Override detected branch name
`--author`	No	Override detected author
`--suite-name`	No	Suite name
`--browser`	No	Browser used (default: `chrome`)
`--env`	No	API stage (`prod\|qa\|dev`, default: `prod`)

CI/CD Integration

GitHub Actions

- name: Upload test results
  run: |
    oyacloud upload \
      --framework playwright_ts \
      --project my-app \
      --environment staging \
      --results-dir ./playwright-report \
      --api-key ${{ secrets.OYACLOUD_API_KEY }}

GitLab CI

upload_results:
  script:
    - oyacloud upload
        --framework testng_java
        --project $CI_PROJECT_NAME
        --environment staging
        --results-dir ./target/surefire-reports
        --api-key $OYACLOUD_API_KEY

Jenkins

sh """
  oyacloud upload \
    --framework pytest_python \
    --project ${JOB_NAME} \
    --environment staging \
    --results-dir ./test-results \
    --api-key ${OYACLOUD_API_KEY}
"""

Azure DevOps

- script: |
    oyacloud upload \
      --framework junit_java \
      --project $(Build.Repository.Name) \
      --environment staging \
      --results-dir ./target/surefire-reports \
      --api-key $(OYACLOUD_API_KEY)
  displayName: Upload test results to OyaCloud

AWS CodeBuild

post_build:
  commands:
    - oyacloud upload
        --framework pytest_python
        --project my-app
        --environment staging
        --results-dir ./test-results
        --api-key $OYACLOUD_API_KEY

Supported CI Systems

Auto-detection works out of the box for:

GitHub Actions
GitLab CI
Jenkins
CircleCI
Azure DevOps
AWS CodeBuild

Commands

`oyacloud config set-key <apiKey>`

Save API key locally. Run once after installation.

`oyacloud config show`

Show current saved configuration (API key is masked).

Help

oyacloud --help
oyacloud upload --help

License

MIT