Skip to content
This repository was archived by the owner on Jul 14, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This way even entityIds like environmentIds or testCaseIds will be autocompleted

# octomind

Octomind cli tool. Version: 4.1.0. Additional documentation see https://octomind.dev/docs/api-reference/
Octomind cli tool. Version: 4.2.0. Additional documentation see https://octomind.dev/docs/api-reference/

**Usage:** `octomind [options] [command]`

Expand Down Expand Up @@ -220,7 +220,7 @@ Execute test cases to create a test report
| `-t, --test-target-id [id]` | Test target ID, if not provided will use the test target id from the config | No | |
| `-e, --environment-name [name]` | Environment name | No | default |
| `-d, --description [text]` | Test description | No | |
| `-g, --tags [tags]` | comma separated list of tags | No | |
| `-g, --tags [tags]` | Comma separated list of tags | No | |
| `-v, --variables-to-overwrite [variables]` | JSON object of variables to overwrite | No | |
| `-b, --browser [type]` | Browser type [CHROMIUM, FIREFOX, SAFARI] | No | CHROMIUM |
| `-r, --breakpoint [name]` | Breakpoint [DESKTOP, MOBILE, TABLET] | No | DESKTOP |
Expand All @@ -236,11 +236,12 @@ Execute local YAML test cases
| Option | Description | Required | Default |
|:-------|:----------|:---------|:--------|
| `-j, --json` | Output raw JSON response | No | |
| `-u, --url <url>` | url the tests should run against | Yes | |
| `-e, --environment-id [uuid]` | id of the environment you want to run against, if not provided will run all test cases against the default environment | No | |
| `-t, --test-target-id [uuid]` | id of the test target of the test case, if not provided will use the test target id from the config | No | |
| `--headless` | if we should run headless without the UI of playwright and the browser | No | |
| `--bypass-proxy` | bypass proxy when accessing the test target | No | |
| `-u, --url <url>` | Url the tests should run against | Yes | |
| `-c, --test-case-id [uuid]` | Id of the test case you want to run, if not provided will run all test cases in the test target | No | |
| `-e, --environment-id [uuid]` | Id of the environment you want to run against, if not provided will run all test cases against the default environment | No | |
| `-t, --test-target-id [uuid]` | Id of the test target of the test case, if not provided will use the test target id from the config | No | |
| `--headless` | If we should run headless without the UI of playwright and the browser | No | |
| `--bypass-proxy` | Bypass proxy when accessing the test target | No | |
| `--browser [CHROMIUM, FIREFOX, SAFARI]` | Browser type | No | CHROMIUM |
| `--breakpoint [DESKTOP, MOBILE, TABLET]` | Breakpoint | No | DESKTOP |

Expand Down Expand Up @@ -445,19 +446,33 @@ Push local YAML test cases to the test target
| `-j, --json` | Output raw JSON response | No | |
| `-t, --test-target-id [id]` | Test target ID, if not provided will use the test target id from the config | No | |

## create-test-case

Create a new test case

**Usage:** `create-test-case [options]`

### Options

| Option | Description | Required | Default |
|:-------|:----------|:---------|:--------|
| `-j, --json` | Output raw JSON response | No | |
| `-t, --test-target-id [id]` | Test target ID, if not provided will use the test target id from the config | No | |
| `-n, --name <string>` | The name of the test case you want to create | Yes | |
| `-d, --dependency-path <path>` | The path of to test case you want to use as dependency | Yes | |

## edit-test-case

Edit yaml test case

**Usage:** `edit-test-case [options]`
**Usage:** `edit-test-case [options] <file-path>`

### Options

| Option | Description | Required | Default |
|:-------|:----------|:---------|:--------|
| `-j, --json` | Output raw JSON response | No | |
| `-t, --test-target-id [id]` | Test target ID, if not provided will use the test target id from the config | No | |
| `-f, --file-path <path>` | The path to the local yaml file you want to edit | Yes | |

## Test Reports

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "4.2.0",
"description": "a command line client for octomind apis",
"main": "./dist/index.js",
"packageManager": "pnpm@10.26.0+sha512.3b3f6c725ebe712506c0ab1ad4133cf86b1f4b687effce62a9b38b4d72e3954242e643190fc51fa1642949c735f403debd44f5cb0edd657abe63a8b6a7e1e402",
"packageManager": "pnpm@10.28.0+sha512.05df71d1421f21399e053fde567cea34d446fa02c76571441bfc1c7956e98e363088982d940465fd34480d4d90a0668bc12362f8aa88000a64e83d0b0e47be48",
"files": ["dist", "src", "README.md", "LICENSE", "package.json"],
"engines": {
"node": ">=22.0.0"
Expand Down Expand Up @@ -63,7 +63,7 @@
"@types/which": "3.0.4",
"genversion": "3.2.0",
"openapi-typescript": "7.10.1",
"orval": "7.18.0",
"orval": "8.0.0",
"tsx": "4.21.0",
"typescript": "5.9.3",
"vite-tsconfig-paths": "6.0.4",
Expand Down
Loading