> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# katalon/katalon-studio

Executing Katalon tests with your CircleCI CI/CD pipeline easily with the Katalon orb


## Commands

### execute

Defining command arguments to execute your Katalon tests with API Key required

| Parameter | Type | Default | Description |
|---|---|---|---|
| `command_arguments` | string |  | The defined command arguments used for executing your Katalon tests |
| `KATALON_API_KEY` | env_var_name |  | The name of the environment variable containing the API key used for authentication with Katalon Server |

## Jobs

### run

Executing your Katalon tests in the Katalon Studio's Docker Image with the provided command arguments

| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | latest | Specifying the Katalon Studio version your tests will be executed with (Only version 7+ supported). By default, it's the latest version. |
| `KATALON_API_KEY` | env_var_name | KATALON_API_KEY | The API KEY used for authentication with the Katalon Server. Learn how to get the API KEY via https://docs.katalon.com/katalon-analytics/docs/ka-api-key.html. |
| `command_arguments` | string |  | The command arguments used for executing the tests. See the supported Command Syntax via https://docs.katalon.com/katalon-studio/docs/console-mode-execution.html. |

## Executors

### default

Ubuntu based Docker Image for Katalon Studio

| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | latest | Specifying the Katalon Studio version your tests will be executed with (Only version 7+ supported) |

## Examples

### execute_sample_test

Executing a test suite with the latest version of Katalon Studio

```yaml
version: 2.1
orbs:
  katalon-studio: katalon/katalon-studio@23.0.12
workflows:
  build:
    jobs:
      - katalon-studio/run:
          version: latest
          command_arguments: >-
            -browserType='Chrome' -retry=0 -statusDelay=15 -testSuitePath='Test
            Suites/TS_RegressionTest'
```