@oyacloud/cli

OyaCloud CLI for uploading test results from CI/CD pipelines and standalone executions.

Installation

npm install -g @oyacloud/cli

Setup

After installation, save your API key once — you won't need to pass it on every command:

oyacloud config set-key YOUR_API_KEY

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

Quick Start

CI/CD Pipeline

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

Standalone / Local

oyacloud upload standalone \
  --framework pytest_python \
  --project my-app \
  --environment local \
  --results-dir ./test-results \
  --suite-name "Unit Tests"

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) | | unknown | Other frameworks |

Commands

oyacloud config set-key <apiKey>

Save your API key locally so you don't need --api-key on every command.

oyacloud config set-key oya_xxxxxxxxxxxx

oyacloud config show

Show your current saved configuration (API key is masked).

oyacloud upload cicd

Upload test results from a CI/CD pipeline. Automatically detects branch, PR number, author, and build type from the CI environment.

Required:

• --framework <framework> - Test framework
• --project <project> - Project name (must match project created in OyaCloud)
• --environment <env> - Target environment (e.g. staging, qa, prod)
• --results-dir <dir> - Directory containing test result files

Optional:

• --api-key <key> - API key (skip if set via oyacloud config set-key)
• --build-type <type> - Override auto-detected build type (pr|post-merge|regression|local)
• --branch <branch> - Override detected branch name
• --author <author> - Override detected author
• --suite-name <name> - Override suite name
• --browser <browser> - Browser used (default: chrome)
• --env <stage> - API stage (prod|qa|dev, default: prod)

oyacloud upload standalone

Upload test results with manually specified metadata. Use this outside of CI/CD.

Required:

• --framework <framework> - Test framework
• --project <project> - Project name
• --environment <env> - Target environment
• --results-dir <dir> - Results directory

Optional:

• --api-key <key> - API key (skip if set via oyacloud config set-key)
• --branch <branch> - Branch name
• --author <author> - Author name
• --suite-name <name> - Suite name
• --browser <browser> - Browser used (default: chrome)
• --env <stage> - API stage (prod|qa|dev, default: prod)

oyacloud frameworks

List all supported framework values.

CI/CD Integration

GitHub Actions

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

GitLab CI

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

Jenkins

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

Supported File Types

• .xml — JUnit / TestNG reports
• .json — Test result files
• .html — HTML reports
• .png, .jpg, .jpeg — Screenshots
• .log, .txt — Log files

File Size Limits

• Maximum per file: 10MB
• Maximum per upload: 100MB

Help

oyacloud --help
oyacloud upload --help
oyacloud frameworks

License

MIT