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

# testimio/runner

Easily run your tests and suits from Testim.io


## Commands

### run_tests

Run tests on Testim.io

| Parameter | Type | Default | Description |
|---|---|---|---|
| `grid_name` | string | Public |  |
| `options` | string |  |  |
| `project_id` | string |  |  |
| `report_file` | string | reports.xml |  |
| `report_store_path` | string | /tmp/circleci-test-results |  |
| `token` | env_var_name | TESTIMIO_TOKEN |  |

## Jobs

### run_tests

Run tests on Testim.io

| Parameter | Type | Default | Description |
|---|---|---|---|
| `grid_name` | string | Public |  |
| `options` | string |  |  |
| `project_id` | string |  |  |
| `report_file` | string | report.xml |  |
| `report_store_path` | string | /tmp/circleci-test-results |  |
| `token` | env_var_name | TESTIMIO_TOKEN |  |

## Executors

### default

The default executor for jobs in this orb.

## Examples

### test-cli-with-workflow

Run tests on Testim.io

```yaml
orbs:
  testimio: testimio/runner@x.y
version: 2.1
workflows:
  build-and-test:
    jobs:
      - testimio/run_tests:
          grid_name: 'grid name (optional, default: Public)'
          options: '--<option_name> <parameter> (optional)'
          project_id: project id (required)
          token: 'token environment variable name. default: TESTIMIO_TOKEN'
```