Testomat.io

https://docs.testomat.io/
Admin
Testomat.io is a modern test management system that improves software testing efficiency through...
Tokens:158,759
Snippets:2,491
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Command Examples

Source: https://docs.testomat.io/test-reporting/cli

Various examples of starting a test run with different configurations and filters.

```bash
npx @testomatio/reporter start
npx @testomatio/reporter start --kind manual
npx @testomatio/reporter start --kind mixed
npx @testomatio/reporter start --filter "testomatio:tag-name=smoke"
```

--------------------------------

### Install Testomat.io Reporter CLI

Source: https://docs.testomat.io/test-reporting/cli

Global installation command for the reporter CLI.

```bash
npm install -g @testomatio/reporter
```

--------------------------------

### Run command examples

Source: https://docs.testomat.io/test-reporting/cli

Various examples of running tests with different filters, environment files, and run types.

```bash
npx @testomatio/reporter run "npm test"
npx @testomatio/reporter run "npx jest" --filter-list "testomatio:tag-name=frontend"
npx @testomatio/reporter run "npx jest" --filter "testomatio:tag-name=frontend"
npx @testomatio/reporter run "npx jest" --filter "testomatio:label=Smoke"
npx @testomatio/reporter run "npx jest" --filter "testomatio:jira=TC-123"
npx @testomatio/reporter run "npx jest" --filter "testomatio:plan=a123fb12"
npx @testomatio/reporter run "npx jest" --filter-list "coverage:file=coverage.yml,diff=user-branch"
npx @testomatio/reporter run --filter-list "coverage:file=coverage.yml" --format grep
npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage.yml,diff=user-branch"
npx @testomatio/reporter run "npx jest" --filter "coverage:file=coverage/coverage.yml"
npx @testomatio/reporter run "mocha tests/" --env-file .env.test
npx @testomatio/reporter run "npm test" --kind manual
npx @testomatio/reporter run "npx jest" --kind mixed
```

--------------------------------

### Install development dependencies

Source: https://docs.testomat.io/test-reporting/python

Installs the project dependencies required for development.

```bash
pip install ".[dev]"
```

--------------------------------

### Install pytestomatio via pip

Source: https://docs.testomat.io/test-reporting/python

Install the required package using pip.

```bash
pip install pytestomatio
```

--------------------------------

### Example Usage with Frameworks

Source: https://docs.testomat.io/project/runs/runs/reporter/pipes/testomatio.md

Examples of applying a label filter when running CodeceptJS or Playwright tests.

```bash
TESTOMATIO={API_KEY} npx @testomatio/reporter run 'npx codeceptjs run' --filter 'testomatio:label=new-label'
```

```bash
TESTOMATIO={API_KEY} npx @testomatio/reporter run 'npx playwright test' --filter 'testomatio:label=new-label'
```

--------------------------------

### Install Vitest Reporter

Source: https://docs.testomat.io/test-reporting/frameworks

Install the Testomat.io reporter package as a development dependency.

```bash
npm install @testomatio/reporter --save-dev
```

--------------------------------

### Start a Test Run

Source: https://docs.testomat.io/test-reporting/cli

Command syntax for initiating a new test run.

```bash
npx @testomatio/reporter start [options]
```

--------------------------------

### Install Testomat.io Reporter

Source: https://docs.testomat.io/reference/reporter

Commands to install the @testomatio/reporter package using common Node.js package managers.

```bash
npm install @testomatio/reporter --save-dev
```

```bash
pnpm install @testomatio/reporter --save-dev
```

```bash
yarn add @testomatio/reporter --dev
```

--------------------------------

### Start with additional parameters

Source: https://docs.testomat.io/test-reporting/cli

Captures the run ID while applying specific run configurations.

```bash
RUN_ID=$(npx @testomatio/reporter start --kind manual --format id)
RUN_ID=$(npx @testomatio/reporter start --filter "testomatio:tag-name=smoke" --format id)
```

--------------------------------

### Install Testomat.io Reporter with yarn

Source: https://docs.testomat.io/test-reporting/junit

Install the reporter package using yarn. This is a development dependency.

```bash
yarn add @testomatio/reporter --dev
```

--------------------------------

### start

Source: https://docs.testomat.io/test-reporting/cli

Starts a new test run and returns its ID. This command requires the TESTOMATIO environment variable to be set.

```APIDOC
## CLI Command: start

### Description
Starts a new test run and returns its ID. The run is created as 'pending' in Testomat.io.

### Usage
`npx @testomatio/reporter start [options]`

### Environment Variables
- **TESTOMATIO** (string) - Required - Your Testomat.io API project key (format: tstmt_*).

### Options
- **--env-file** (string) - Optional - Load environment variables from a specific file.
- **--kind** (string) - Optional - Specify run type: automated, manual, or mixed.
- **--filter** (string) - Optional - Scope the prepared run to tests matching the filter.
- **--format** (string) - Optional - Print only the run id to stdout.
- **--warn** (boolean) - Optional - Exit 0 instead of 1 when the filter matches no tests.
```

--------------------------------

### Karate scenario logging example

Source: https://docs.testomat.io/test-reporting/java-reporter

Complete example showing manual step marking and automatic logging via the @LogSteps annotation.

```gherkin

  Background:
      * url 'https://jsonplaceholder.typicode.com'
      * def assertStatus = Java.type('helpers.AssertStatus')
      * def stepMarker = Java.type('io.testomat.karate.marker.StepMarker')
      * def step = stepMarker.mark


  @Title:Get_all_posts @TestId:Tpost0001 @attachments:logs/karate.log
  Scenario: Get all posts
    * step()
    Given path 'posts'
    * step('Send get request')
    When method get
    Then eval assertStatus.checkStatusCode(responseStatus, 200)
    * step("Check response id is not null")
    And match response[0].id != null


  @Title:Get_single_post @TestId:Tpost0002 @LogSteps
  Scenario: Get single post
    Given path 'posts', 1
    When method get
    Then eval assertStatus.checkStatusCode(responseStatus, 200)
    And match response.id == 1

```

--------------------------------

### Starting an Empty Run

Source: https://docs.testomat.io/project/runs/runs/reporter/pipes/testomatio.md

Initialize a new run and capture its ID using the start command with the --format id flag.

```bash
RUN_ID=$(TESTOMATIO={API_KEY} npx @testomatio/reporter start --format id)
```

--------------------------------

### Install Testomat.io Reporter with pnpm

Source: https://docs.testomat.io/test-reporting/junit

Install the reporter package using pnpm. This is a development dependency.

```bash
pnpm install @testomatio/reporter --save-dev
```

--------------------------------

### Display File Path with Package

Source: https://docs.testomat.io/test-reporting/allure

Example of a file path when the --with-package option is enabled.

```text
com/example/app/tests/ui/LoginTest.kt
```

--------------------------------

### Install Newman Reporter

Source: https://docs.testomat.io/test-reporting/frameworks

Install the required reporter package for Newman.

```bash
npm i newman-reporter-testomatio --save-dev
```

--------------------------------

### Install PHP List Tests

Source: https://docs.testomat.io/project/import-export/import/import-php

Install the testomatio/php-list-tests package as a development dependency using Composer.

```bash
composer require testomatio/list-tests --dev
```

--------------------------------

### TQL Syntax Requirements

Source: https://docs.testomat.io/advanced/tql

Examples demonstrating correct string quoting and equality operator usage.

```text
tag == A <- won't work !!!


tag == 'A' <- will work
```

```text
tag = 'A' <- won't work !!!!


tag == 'A' <- will work
```

--------------------------------

### Install and Run Yarn 4 CLI Wrapper

Source: https://docs.testomat.io/test-reporting/reporter

Installation and usage commands specifically for Yarn 4 (Berry) environments.

```bash
yarn add testomatio-reporter-cli --dev
npx testomatio-reporter <command> [options]
```

--------------------------------

### Playwright Manual Run Example

Source: https://docs.testomat.io/test-reporting/linking-tests

Demonstrates initializing a manual run and executing Playwright tests with the captured ID.

```bash
RUN_ID=$(TESTOMATIO=tstmt_xxxx npx @testomatio/reporter start --kind manual --format id)




TESTOMATIO=tstmt_xxxx TESTOMATIO_RUN=$RUN_ID npx playwright test
```

--------------------------------

### TestNG Test Examples

Source: https://docs.testomat.io/tutorials/java

Examples of TestNG tests using DataProvider and standard test methods for import.

```java
@Test(dataProvider = "users")
public void createUser(String userName) {
    Assert.assertNotNull(userName);
}


@DataProvider
public Object[][] users() {
    return new Object[][]{
        {"John"},
        {"Kate"},
        {"Mike"}
    };
}


@Test
public void userShouldBeFine() {
    Assert.assertEquals(user.getStatus(), "fine");
}
```

--------------------------------

### Setup step logging for Karate

Source: https://docs.testomat.io/test-reporting/java-reporter

Initialize the StepMarker in the Background section of a Karate feature file.

```gherkin

  Background
    * def stepMarker = Java.type('io.testomat.karate.marker.StepMarker')
    * def step = stepMarker.mark

```

--------------------------------

### Install Cypress Grep Plugin

Source: https://docs.testomat.io/test-reporting/frameworks

Install the @cypress/grep plugin to enable test filtering functionality.

```bash
npm install --save-dev @cypress/grep
```

--------------------------------

### Install Testomat Reporter

Source: https://docs.testomat.io/test-reporting/frameworks

Initialize and install the required NodeJS reporter package for processing JUnit XML reports.

```bash
npm init -y
npm install @testomatio/reporter --save-dev
```

--------------------------------

### Replay Command Examples

Source: https://docs.testomat.io/test-reporting/cli

Various ways to execute the replay command, including dry runs and environment file loading.

```bash
TESTOMATIO=<your-api-key> DEBUG=1 npx playwright test




TESTOMATIO=<your-api-key> npx @testomatio/reporter replay




TESTOMATIO=<your-api-key> npx @testomatio/reporter replay /path/to/debug.json




TESTOMATIO=<your-api-key> npx @testomatio/reporter replay --dry-run




npx @testomatio/reporter replay --env-file .env.staging
```

--------------------------------

### Install Testomatio Reporter for PHP

Source: https://docs.testomat.io/test-reporting/php

Use Composer to install the Testomatio reporter package as a development dependency.

```bash
composer require testomatio/reporter --dev
```

--------------------------------

### Report Parameterized Test with Example Data

Source: https://docs.testomat.io/test-reporting/api

Use the `example` parameter to identify specific data sets for parameterized tests. This clearly shows the input data used for each test execution.

```http
POST https://app.testomat.io/api/reporter/run-id-12345/testrun?api_key=tstmt_your_api_key
Content-Type: application/json


{
  "title": "User login with different roles",
  "status": "passed",
  "test_id": "T1",
  "rid": "login-admin-role",
  "example": {
    "username": "admin",
    "role": "administrator",
    "expectedPermissions": ["read", "write", "delete"]
  }
}
```

--------------------------------

### JSONL Debug File Example

Source: https://docs.testomat.io/test-reporting/debug-file-format

Example of the JSONL structure where each line represents a distinct action or data entry.

```json
{"t":"+0ms","datetime":"2024-01-15T10:30:00.000Z","timestamp":1705315800000}
{"t":"+5ms","data":"variables","testomatioEnvVars":{"TESTOMATIO":"abc123"}}
{"t":"+10ms","action":"createRun","params":{"title":"Test Run"}}
```

--------------------------------

### Report String Example Data

Source: https://docs.testomat.io/test-reporting/api

When the example data is a simple string, it will be reported as such. This is useful for simple test cases.

```json
{ "example": "your string" }
```

--------------------------------

### Complete Example: Table-Driven Test Reporting

Source: https://docs.testomat.io/test-reporting/api

This example demonstrates reporting a table-driven test with multiple inputs for email validation. It includes passed and failed cases with detailed messages and stacks for failures.

```http
POST https://app.testomat.io/api/reporter/run-id-12345/testrun?api_key=tstmt_your_api_key
Content-Type: application/json
```

```json
{
  "tests": [
    {
      "title": "Email validation",
      "status": "passed",
      "test_id": "@T01010101",
      "example": {
        "email": "user@example.com",
        "expectedValid": true
      }
    },
    {
      "title": "Email validation",
      "status": "passed",
      "test_id": "@T01010101",
      "example": {
        "email": "user@subdomain.example.com",
        "expectedValid": true
      }
    },
    {
      "title": "Email validation",
      "status": "passed",
      "test_id": "@T01010101",
      "example": {
        "email": "userexample.com",
        "expectedValid": false
      }
    },
    {
      "title": "Email validation",
      "status": "failed",
      "test_id": "@T01010101",
      "example": {
        "email": "user+code@example.com",
        "expectedValid": true
      },
      "message": "Valid email with + character was rejected",
      "stack": "Error: Expected validation to pass but got false\n    at validateEmail (/tests/validation.js:45:7)"
    }
  ],
  "batch_index": 1
}
```

--------------------------------

### Dynamic Parameters Example

Source: https://docs.testomat.io/project/import-export/export-tests/download-manual-tests-as-files

Structure for test cases with dynamic parameters. An '<!-- example -->' comment block is followed by a Markdown table defining parameters and their values for testing.

```markdown
<!-- example -->
```

```markdown
| Header 1 | Header 2 |
| --- | --- |
| Param name 1 | Param name 2 |
| Param name 3 | Param name 4 |
```

--------------------------------

### Handle ES2023 Resource Management

Source: https://docs.testomat.io/project/import-export/import/import-js

Example of modern JavaScript syntax using 'using' declarations supported by the tool.

```javascript
const getResource = () => ({
  [Symbol.dispose]: () => { /* cleanup code */ },
});


test('resource management', () => {
  using resource = getResource();
  // resource will be automatically disposed at the end of the scope
});
```

--------------------------------

### Configure CORS Policy for R2 Bucket

Source: https://docs.testomat.io/project/runs/reporter/artifacts

Example CORS policies for Cloudflare R2 buckets. Ensure 'Object...' permissions are set for manual CORS policy setup.

```json
[
  {
    "AllowedOrigins": ["https://app.testomat.io"],
    "AllowedMethods": ["GET"],
    "AllowedHeaders": ["*"],
    "ExposeHeaders": ["Access-Control-Allow-Origin"],
    "MaxAgeSeconds": 3000
  },
  {
    "AllowedOrigins": ["https://trace.playwright.dev"],
    "AllowedMethods": ["GET"],
    "AllowedHeaders": ["*"],
    "ExposeHeaders": ["Access-Control-Allow-Origin"],
    "MaxAgeSeconds": 3000
  }
]
```

--------------------------------

### Test Steps Format Example

Source: https://docs.testomat.io/project/import-export/export-tests/classical-tests-markdown-format

Illustrates the format for defining test steps using a '## Steps' header followed by a nested markdown list.

```markdown
## Steps

* Step 1
* Step 2
```

--------------------------------

### Prepare and launch a run in two phases

Source: https://docs.testomat.io/test-reporting/cli

Split the process into creating a scheduled run and triggering it on CI later using the TESTOMATIO_RUN environment variable.

```bash
RUN_ID=$(npx @testomatio/reporter start --filter "testomatio:tag-name=smoke" --format id)
```

```bash
TESTOMATIO_RUN=$RUN_ID npx @testomatio/reporter run --remote github
```

--------------------------------

### Install WebdriverIO Hooks Enhancer

Source: https://docs.testomat.io/test-reporting/frameworks

Install the enhancer package to properly handle beforeEach hook failures.

```bash
npm install @testomatio/webdriver-hooks-enhancer
```

--------------------------------

### Run Stakeholder Demo

Source: https://docs.testomat.io/test-reporting/java-reporter

Execute tests and publish a public report link for stakeholder visibility.

```bash
# Public report for sharing with stakeholders
mvn test \
  -Dtestomatio=tstmt_your_key \
  -Dtestomatio.run.title="Demo for Product Team" \
  -Dtestomatio.publish=1
```

--------------------------------

### JUnit 5 Test Examples

Source: https://docs.testomat.io/tutorials/java

Examples of parameterized and standard JUnit 5 tests that can be imported into Testomat.io.

```java
@ParameterizedTest(name = "Create user {0}")
@ValueSource(strings = {"John", "Kate", "Mike"})
void createUser(String userName) {
    assertNotNull(userName);
}


@Test
void userShouldBeFine() {
    assertEquals("fine", user.getStatus());
}
```

--------------------------------

### Configure CI Parameters

Source: https://docs.testomat.io/test-reporting/configuration

Pass comma-separated key=value pairs to the CI profile configuration at launch time.

```bash
TESTOMAT={API_KEY} TESTOMATIO_CI_PROFILE=github TESTOMATIO_CI_PARAMS="branch=develop,REGION=eu" <actual run command>
```

--------------------------------

### Prepare and launch a run on CI

Source: https://docs.testomat.io/test-reporting/cli

A two-phase process to first create a scheduled run and then trigger it on a CI profile.

```APIDOC
## CLI Command: Two-Phase Run Execution

### Description
Splits the process into creating a run (capturing scope) and launching it on CI. This allows for flexible execution of prepared test runs.

### Step 1: Prepare
`RUN_ID=$(npx @testomatio/reporter start --filter "testomatio:tag-name=smoke" --format id)`

### Step 2: Launch
`TESTOMATIO_RUN=$RUN_ID npx @testomatio/reporter run --remote <profile>`
```

--------------------------------

### Configure API Key and Run Options

Source: https://docs.testomat.io/test-reporting/java-reporter

Methods for providing the project API key and optional run title to the reporter.

```bash

export testomatio=tstmt_your_project_api_key

```

```properties

testomatio=tstmt_your_project_api_key
testomatio.run.title=Nightly Regression

```

```bash

mvn test \
  -Dtestomatio=tstmt_your_project_api_key \
  -Dtestomatio.run.title="Nightly Regression"

```

--------------------------------

### Compare Allure and Testomat.io workflows

Source: https://docs.testomat.io/test-reporting/allure

Comparison of standard Allure report generation versus Testomat.io reporting commands.

```bash
mvn test
allure generate allure-results
```

```bash
mvn test
npx @testomatio/reporter allure allure-results
```

--------------------------------

### NUnit Result Files Example

Source: https://docs.testomat.io/test-reporting/junit

Example of the `<ResultFiles>` section in an NUnit XML report, which is used to upload artifacts like screenshots or data files.

```xml
<Results>
  <UnitTestResult>
    <ResultFiles>
      <ResultFile path="screenshot2.png" />
      <ResultFile path="data.zip" />
    </ResultFiles>
  </UnitTestResult>

```

--------------------------------

### Start a Test Run Manually

Source: https://docs.testomat.io/project/runs/running-automated-tests

Initiate a test run by creating a run and capturing its ID. This ID is then used to proceed with test execution.

```bash
export TESTOMATIO_RUN=$(TESTOMATIO=xxx npx @testomatio/reporter start | tail -1)
```

--------------------------------

### Implement Test Steps in Pytest

Source: https://docs.testomat.io/test-reporting/python

Full example demonstrating how to use decorators and context managers to report steps in a test suite.

```python
import pytest
from pytestomatio.utils.steps import step, step_function


class Book:
    def __init__(self, author, text):
        self.author = author
        self.text = text


    def read(self):
        return self.text


# decorator
@step_function(title='Check author step', category='user')
def check_author(author_name, expected_name):
    assert author_name == expected_name


def test_book_create():
    author_name = 'David Ket'
    # context manager
    with step(title='Book create', category='user'):
        book = Book(author_name, 'text')
        assert book
        check_author(book.author, author_name)


# nested steps also supported
def test_book_read():
    text = 'book text'
    author_name = 'David Ket'


    with step(title='Read book'):
        with step(title='Book create', category='user'):
            book = Book(author_name, 'text')
            assert book
            check_author(book.author, author_name)
        assert book.read() == text
```

--------------------------------

### Upload Artifacts with WebdriverIO

Source: https://docs.testomat.io/test-reporting/cli

Example workflow for WebdriverIO integration.

```bash
TESTOMATIO=tstmt_* TESTOMATIO_DISABLE_ARTIFACTS=1 npx @testomatio/reporter run "npx wdio"
TESTOMATIO=tstmt_* npx @testomatio/reporter upload-artifacts
```

--------------------------------

### Visualize Suite to Folder Conversion

Source: https://docs.testomat.io/project/tests/other-features-for-test-case-design

Illustrates the structural change in the test tree before and after converting a suite into a folder.

```text
Notifications (Suite)
|-- Test 1
|-- Test 2
```

```text
Notifications (Folder)
└── Notifications (Suite)
    ├── Test 1
    └── Test 2
```

--------------------------------

### Execute test runner in BitBucket job

Source: https://docs.testomat.io/integrations/continuous-integration/bitbucket/index.md

Example command to include in a BitBucket job step to run tests with parameters.

```bash
- npx codeceptjs run-workers 2 --grep "${grep}"
```

--------------------------------

### Link tests in CodeceptJS

Source: https://docs.testomat.io/test-reporting/linking-tests

Example of integrating linkTest within a CodeceptJS scenario.

```javascript

// CodeceptJS example
import { linkTest } from '@testomatio/reporter';


Feature('Authentication');


Scenario('user login functionality', ({ I }) => {
  // Link this automated test to related manual test cases
  linkTest('T12345678', 'T87654321', 'T11223344', 'T55667788', 'T99887766');


  // Your test implementation here
  I.amOnPage('/login');
  I.fillField('[data-testid="username"]', 'testuser');
  I.fillField('[data-testid="password"]', 'password123');
  I.click('[data-testid="login-button"]');
  I.see('Welcome', '[data-testid="welcome-message"]');
});

```

--------------------------------

### Import QUnit Tests

Source: https://docs.testomat.io/project/import-export/import/import-js

Commands to check QUnit test files.

```bash
npx check-tests qunit "tests/**/*.js"
```

```bash
npx check-tests qunit "tests/**/*.ts" --typescript
```

--------------------------------

### GET /api/{project_id}/testruns

Source: https://docs.testomat.io/advanced/api-access

Retrieve all test results from a specific run.

```APIDOC
## GET /api/{project_id}/testruns

### Description
Retrieve all test results from a specific run.

### Method
GET

### Endpoint
/api/{project_id}/testruns

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The unique identifier of the project.

#### Query Parameters
- **run_id** (string) - Required - The unique identifier of the run to filter results.
```

--------------------------------

### GET /api/{project_id}/runs

Source: https://docs.testomat.io/advanced/api-access

Retrieve all test runs associated with a project.

```APIDOC
## GET /api/{project_id}/runs

### Description
Retrieve all test runs associated with a project.

### Method
GET

### Endpoint
/api/{project_id}/runs

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The unique identifier of the project.
```

--------------------------------

### Capture run ID

Source: https://docs.testomat.io/test-reporting/cli

Captures the new run ID generated by the start command.

```bash
RUN_ID=$(npx @testomatio/reporter start --format id)
echo "$RUN_ID"   # e.g. a1b2c3d4
```

--------------------------------

### Import Manual Tests from Markdown

Source: https://docs.testomat.io/project/import-export/export-tests/download-manual-tests-as-files

This is the command to run in your project directory after selecting 'Manual tests (markdown files)' and 'Markdown' as project framework and language in Testomat.io. It syncs tests back to Testomat.io.

```bash
copy the displayed push command
```

--------------------------------

### Attach screenshot in test method

Source: https://docs.testomat.io/test-reporting/java-reporter

Example of attaching a screenshot within a test method.

```java
@Test
public void loginTest() {
    Path screenshot = takeScreenshot();


    attachTestomatScreenshot(screenshot);
}
```

--------------------------------

### Link tests in Playwright

Source: https://docs.testomat.io/test-reporting/linking-tests

Example of integrating linkTest within a Playwright test suite.

```typescript

// Playwright example
import { test, expect } from '@playwright/test';
import { linkTest } from '@testomatio/reporter';


test.describe('Authentication', () => {
  test('user login functionality', async ({ page }) => {
    // Link this automated test to related manual test cases
    linkTest('T12345678', 'T87654321', 'T11223344', 'T55667788', 'T99887766');


    // Your test implementation here
    await page.goto('/login');
    await page.fill('[data-testid="username"]', 'testuser');
    await page.fill('[data-testid="password"]', 'password123');
    await page.click('[data-testid="login-button"]');
    await expect(page.locator('[data-testid="welcome-message"]')).toContainText('Welcome');
  });
});

```

--------------------------------

### Create New Suite Folder and Import Tests

Source: https://docs.testomat.io/project/import-export/import/import-bdd

Use TESTOMATIO_PREPEND_DIR to create a new suite folder and import all tests into it, preserving the original file structure within the new folder.

```bash
TESTOMATIO_PREPEND_DIR="MyTESTS" TESTOMATIO=API_KEY npx check-cucumber -d example/cucumber
```

--------------------------------

### GET /api/{project_id}/run/{id}

Source: https://docs.testomat.io/advanced/api-access

Retrieve details of a specific run by ID.

```APIDOC
## GET /api/{project_id}/run/{id}

### Description
Retrieve details of a specific run by ID.

### Method
GET

### Endpoint
/api/{project_id}/run/{id}

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The unique identifier of the project.
- **id** (string) - Required - The unique identifier of the run.
```

--------------------------------

### GET /api/<project_name>/suites

Source: https://docs.testomat.io/advanced/api-access

Retrieves the root test suites for a specific project.

```APIDOC
## GET /api/<project_name>/suites

### Description
Fetches the root-level test suites for the specified project.

### Method
GET

### Endpoint
/api/<project_name>/suites

### Parameters
#### Path Parameters
- **project_name** (string) - Required - The name of the project.
```
Tokens:
Raw