# OxygenHQ

Last updated on : 09 Jan 2026

Overview

Oxygen is an open-source test automation framework that significantly simplifies writing and running automation tests of any kind. Built on top of Selenium, Appium, WebdriverIO, and WinAppDriver, it provides a comprehensive tool-set for automated testing.

## Key Features:

- Test scripts written in JavaScript (ECMAScript 6 compatible)
- Built on industry-standard tools: Selenium, Appium, WebdriverIO, and WinAppDriver
- Native support for BDD (Behavior-Driven Development) with built-in Cucumber implementation
- Modular architecture with numerous modules for different functionalities
- Supports mobile app testing on both iOS and Android platforms via Pcloudy
- Simplifies test creation and execution across multiple platforms

### Prerequisites

Before setting up OxygenHQ for mobile testing, ensure you have:

1.  Node.js and NPM - Node.js v14 recommended
2.  Pcloudy Account - Active account with valid credentials
3.  API Access Key - Available in your account profile or Quick Actions tab
4.  Mobile App Upload - Your Android (.apk) or iOS (.ipa) application uploaded to Pcloudy via the web interface

### Setup Instructions

1. Install Oxygen CLI

Install the Oxygen CLI tool globally using npm:

```java
npm install -g oxygen-cli
```

For Linux users (if admin permission is required):

```java
sudo npm install -g oxygen-cli
```

2. Configure Test Environment

Edit the oxygen.conf.js file with your credentials. The sample below shows the basic structure—refer to the Capability Generator page for a complete customized configuration tailored to your needs:

```java
Pcloudy_Username = "your-email@example.com"
Pcloudy_ApiKey = "your-api-access-key"
```

Configuration Parameters:

- Pcloudy_Username: Your registered email address
- Pcloudy_ApiKey: Your API access key (found in account profile or Quick Actions tab)

Important: Do not change the name of the configuration file (oxygen.conf.js)

### Running Tests

### Execute Test Suite

Open the terminal in your project directory and execute:

```java
oxygen oxygen.conf.js
```

This command will launch the Oxygen test suite on mobile devices in the Pcloudy cloud.

### Troubleshooting

Common Issues:

- Authentication failed - Verify your username and API key are correct in the configuration file
- App not found - Ensure the app is uploaded and filename matches exactly in configuration
- Device not available - Check device name spelling or try a different device
- Oxygen CLI not found - Ensure oxygen-cli is installed globally with the -g flag
- Permission denied - Use sudo for installation on Linux/Mac systems

### Additional Resources

- Complete samples and documentation: Pcloudy GitHub Repository
- Support: support@pcloudy.com