---
tags: Rapi Document English
---

# Rapi Runner
Rapi Runner is a command-line tool designed to play test cases recorded with Rapi.

## Quick Start
Prerequisite:
- [Java SE](https://www.oracle.com/java/technologies/javase-downloads.html)

### Step 1：Start Selenium Server
1. Download [Selenium Server](https://www.seleniumhq.org/download/) (Tested version: 4.9.0).
<!-- 2. Download [WebDriver](https://hackmd.io/@rapi/webdriver-zh#Here-are-the-browsers-currently-supported-by-Rapi) and put it in the same folder as```selenium-server-{version}.jar```. -->
2. Open the terminal and switch to the path to the selenium-server-standalone-{version}.jar.
3. Run

    java -jar selenium-server-{version}.jar standalone --selenium-manager true

### Step 2：Execute Rapi Runner
1. Download [Rapi Runner](https://github.com/RapiTest/rapi-runner/releases/)
2. Run ```rapi-runner --config {CONFIG_FILE_PATH}```. For example, when running with the following config file, all of the test cases in the test suite will be run with Chrome through WebDriver under command line mode. See [Rapi Runner Config Format](https://hackmd.io/@Rapi/rapi-runner-config-file) for the config file format.

{
    "input": {
        "testSuites": ["YOUR_TESTSUITE_FILE_PATH"]
    },

    "webdriver": {
        "configs": [
            {
                "serverUrl": "http://localhost:4444",
                "type": "selenium",
                "browsers":[
                    {
                        "active": true,
                        "capability": {
                            "browserName": "chrome"
                        }
                    }
                ]
            }
        ]
    }
}

### Step 3：View or Parse Test Reports
* View Test Reports: The test reports will be generated under the directory specified in the config file. The file format can be HTML or JSON. The HTML files can directly opened in Browser for human inspection. The JSON files are intended for being parsed by programs.
* Output Data: The test reports will contain the latest values of all local and global variables defined in test cases. Sometimes these values are useful for debugging and can be further processed by the other programs. See Test Report Specification.