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:

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

Supported Frameworks

Value	Framework
`playwright_ts`	Playwright (TypeScript/JavaScript)
`testng_java`	TestNG (Java)

Options

Option	Required	Description
`--framework`	Yes	Test framework (see table above)
`--project`	Yes	Project name (must match project in OyaCloud)
`--environment`	Yes	Environment under test (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`)
`--branch`	No	Branch name
`--commit`	No	Commit SHA
`--pr-number`	No	PR or MR number
`--target-branch`	No	Target branch for PR builds (e.g. `main`)
`--author`	No	Author or user who triggered the run
`--suite-name`	No	Suite name label

CI/CD Integration

Pass your application's branch and commit — not the test automation repo's.

PR build

# GitHub Actions
- name: Upload test results
  run: |
    oyacloud upload \
      --framework playwright_ts \
      --project my-app \
      --environment staging \
      --results-dir ./playwright-report \
      --branch ${{ github.head_ref }} \
      --commit ${{ github.event.pull_request.head.sha }} \
      --pr-number ${{ github.event.pull_request.number }} \
      --target-branch ${{ github.base_ref }} \
      --api-key ${{ secrets.OYACLOUD_API_KEY }}

// Jenkins
sh """
  oyacloud upload \
    --framework playwright_ts \
    --project my-app \
    --environment staging \
    --results-dir ./playwright-report \
    --branch ${APP_BRANCH} \
    --commit ${APP_COMMIT} \
    --pr-number ${APP_PR_NUMBER} \
    --target-branch ${APP_TARGET_BRANCH} \
    --api-key ${OYACLOUD_API_KEY}
"""

Post-merge build

# GitHub Actions
- name: Upload test results
  run: |
    oyacloud upload \
      --framework playwright_ts \
      --project my-app \
      --environment staging \
      --results-dir ./playwright-report \
      --branch ${{ github.ref_name }} \
      --commit ${{ github.sha }} \
      --api-key ${{ secrets.OYACLOUD_API_KEY }}

Regression / nightly build

No branch or commit needed — just the environment you are testing against:

# GitHub Actions (scheduled)
- name: Upload test results
  run: |
    oyacloud upload \
      --framework playwright_ts \
      --project my-app \
      --environment prod \
      --results-dir ./playwright-report \
      --api-key ${{ secrets.OYACLOUD_API_KEY }}

Build type detection

OyaCloud automatically classifies each build — no configuration needed:

What you pass	Detected as
`--pr-number`	PR build
`--commit` + `--branch` matching your base branch	Post-merge build
No commit (regression / nightly)	Regression build

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