> For the complete documentation index, see [llms.txt](https://docs.oxygenhq.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oxygenhq.org/download-installation-start/download-and-installation/cli-installation.md).

# Oxygen CLI Installation

## CLI Installation <a href="#cli-installation" id="cli-installation"></a>

Oxygen CLI - Command-line application for running tests and generating reports.

To start working with Oxygen Command-line (cli) - you must first install the following programs:

1. [Node.js](https://nodejs.org/) 8 or later.
2. [Java 8](https://www.java.com/en/download/)

After installing the above programs you should do the following steps:

1. Open the command line (cmd command)
2. Type the following command in the command line:

   ```bash
   npm install -g oxygen-cli
   ```

   After installation is finished, re-open your command-line.

In some cases you may need to run the installation command using sudo to provide the super-user do elevated permission

```bash
sudo install -g oxygen-cli
```

In case you encounter some permission errors during installation, you can try the following:

```bash
sudo npm install --unsafe-perm --verbose -g oxygen-cli
```

### Configuration <a href="#configuration" id="configuration"></a>

Oxygen CLI doesn't come bundled with Selenium nor Appium and requires installing them manually.

#### Desktop web applications automation <a href="#desktop-web-applications-automation" id="desktop-web-applications-automation"></a>

Download [Selenium Standalone Server](http://www.seleniumhq.org/download/) and the drivers for browsers you wish to use:

* Chrome - <https://sites.google.com/a/chromium.org/chromedriver/downloads>
* Internet Explorer - <http://www.seleniumhq.org/download/>
* Firefox - <https://github.com/mozilla/geckodriver/releases>

Place everything into a single directory and launch with (update selenium version if necessary):

```bash
java -Dwebdriver.chrome.driver=chromedriver.exe -Dwebdriver.ie.driver=IEDriverServer.exe -jar selenium-server-standalone-3.141.59.jar -port 4444 -timeout 320 -browserTimeout 320
```

#### Mobile applications automation <a href="#mobile-applications-automation" id="mobile-applications-automation"></a>

If you wish to execute CLI on mobile devices you should first read Oxygen for mobile guide and installation  instructions: <https://docs.oxygenhq.org/download-and-installation/mobile-installation>

Download a [simulator](https://www.genymotion.com/) for the devices (optional).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.oxygenhq.org/download-installation-start/download-and-installation/cli-installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.