A command-line interface for interacting with the Octomind API. This CLI allows you to execute tests, retrieve test reports, and manage private locations as well as environments. See API documentation

Installation

Use the cli through npx e.g.

npx @octomind/octomind -h

For global installation see installation

Octomind

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

octomind [options] [command]

Options

Option	Description	Required	Default
`-V, --version`	output the version number	No

octomind CLI Documentation

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

Setup

init

Initialize configuration by setting up API key. This will create a config file in ~/.config/octomind.json Usage:

octomind init [options]

Example:

octomind init --test-target-id 3435918b-3d29-4ebd-8c68-9a540532f45a --api-key your-api-key

Options

Option	Description	Required
`-t, --test-target-id <id>`	Test target ID	Yes
`-k, --api-key <key>`	the api key for authentication	Yes
`-f, --force`	Force overwrite existing configuration	No

switch-test-target

Switch to a different test target. This will list all available test targets and update the config file in ~/.config/octomind.json Usage:

octomind switch-test-target [options]

Example:

octomind switch-test-target

Completion

install-completion

Install tab completion Usage:

octomind install-completion [options]

Example:

octomind install-completion

uninstall-completion

Uninstall tab completion Usage:

octomind uninstall-completion [options]

Example:

octomind uninstall-completion

completion

Tab completion Usage:

octomind completion [options]

Example:

octomind completion

Environments

list-environments

List all environments Usage:

octomind list-environments [options]

Example:

octomind list-environments

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

create-environment

Create a new environment Usage:

octomind create-environment [options]

Example:

octomind create-environment --name "Production" --discovery-url https://example.com

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-n, --name <name>`	Environment name	Yes
`-d, --discovery-url <url>`	Discovery URL	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No
`--test-account-username [username]`	Test account username	No
`--test-account-password [password]`	Test account password	No
`--test-account-otp-initializer-key [key]`	Test account OTP initializer key	No
`--basic-auth-username [username]`	Basic auth username	No
`--basic-auth-password [password]`	Basic auth password	No
`--private-location-name [name]`	Private location name	No

environment

Get an environment Usage: environment [options]

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-e, --environment-id <id>`	Environment ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No

update-environment

Update an existing environment Usage: update-environment [options]

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-e, --environment-id <id>`	Environment ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No
`-n, --name [name]`	Environment name	No
`-d, --discovery-url [url]`	Discovery URL	No
`--test-account-username [username]`	Test account username	No
`--test-account-password [password]`	Test account password	No
`--test-account-otp-initializer-key [key]`	Test account OTP initializer key	No
`--basic-auth-username [username]`	Basic auth username	No
`--basic-auth-password [password]`	Basic auth password	No
`--private-location-name [name]`	Private location name	No

delete-environment

Delete an environment Usage:

octomind delete-environment [options]

Example:

octomind delete-environment --environment-id 826c15af-644b-4b28-89b4-f50ff34e46b7

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-e, --environment-id <id>`	Environment ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No

Execute

debug

run test cases against local build Usage: debug [options]

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	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
`--persist`	if we should write playwright config and files to current directory, you can then run ‘npx playwright test’ to run them again	No
`--grep [substring]`	filter test cases by substring	No

execute

Execute test cases to create a test report Usage:

octomind execute [options]

Example:

octomind execute --url https://example.com

Options

Option	Description	Required	Default
`-j, --json`	Output raw JSON response	No
`-u, --url <url>`	URL to test	Yes
`-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
`-v, --variables-to-overwrite [variables]`	JSON object of variables to overwrite	No

create-discovery

Create a new test case discovery Usage:

octomind create-discovery [options]

Example:

octomind create-discovery --name "Login Test" --prompt "Test the login functionality"

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-n, --name <name>`	Discovery name	Yes
`-p, --prompt <prompt>`	Discovery prompt	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No
`-e, --entry-point-url-path [path]`	Entry point URL path	No
`--prerequisite-id [id]`	Prerequisite test case ID	No
`--external-id [id]`	External identifier	No
`--assigned-tag-ids [ids]`	Comma-separated list of tag IDs	No
`--folder-id [id]`	Folder ID	No

Notifications

notifications

Get notifications for a test target Usage:

octomind notifications [options]

Example:

octomind notifications

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

Private Locations

register-location

octomind register-location [options]

Example:

octomind register-location --name "Office Network" --address 192.168.1.100 --username user --password pass

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-n, --name <name>`	Location name	Yes
`-p, --password <password>`	Proxy password	Yes
`-u, --username <user>`	Proxy user	Yes
`-a, --address <address>`	Location address	Yes

unregister-location

Unregister a private location Usage:

octomind unregister-location [options]

Example:

octomind unregister-location --location-id 7f8d6e5c-4b3a-2a1c-0f9e-8d7c6b5a4b3a

Options

Option	Description	Required	Default
`-j, --json`	Output raw JSON response	No
`-n, --name <name>`	Location name	Yes

list-private-locations

List all private locations Usage:

octomind list-private-locations [options]

Example:

octomind list-private-locations

Options

Option	Description	Required	Default
`-j, --json`	Output raw JSON response	No

start-private-location

Start a private location worker, see https://octomind.dev/docs/proxy/private-location Usage:

octomind start-private-location [options]

Example:

octomind start-private-location --name "Office Network"

Options

Option	Description	Required	Default
`-n, --name [name]`	Location name	No
`-u, --username [username]`	Proxy user	No
`-p, --password [password]`	Proxy password	No
`-l, --host-network`	Use host network (default: false). If set you can use localhost directly	No	false

stop-private-location

Stop a private location worker, see https://octomind.dev/docs/proxy/private-location Usage:

octomind stop-private-location [options]

Example:

octomind stop-private-location

Test Cases

delete-test-case

Delete a test case Usage: delete-test-case [options]

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-c, --test-case-id <id>`	Test case ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No

code

Get the code of a specific test case Usage: code [options]

Options

Option	Description	Required	Default
`-c, --test-case-id <id>`	Test case ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No
`-e, --environment-id [id]`	Environment ID	No	default
`-u, --url <url>`	URL to execute the test case against	Yes

Usage:

octomind code [options]

Example:

octomind code --test-case-id 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d --url https://example.com

Output:

import {
  test,
  expect,
  chromium,
  Browser,
  type CDPSession,
  type TestInfo,
  type Locator,
  type Page,
  type Response,
  type BrowserContext,
  type FileChooser,
} from "@playwright/test";
import fs from "fs";
import os from "os";
import path from "path";
import fsPromises from "fs/promises";
import { setTimeout } from "timers/promises";
import { Readable } from "stream";
import { finished } from "stream/promises";
import { URL } from "url";

declare global {
  interface Window {
    octomindWrittenValueTracker?: WeakMap<HTMLElement, string>;
  }
}

const handleHydrationIssues = async (
...

test-case

Get details of a specific test case Usage:

octomind test-case [options]

Example:

octomind test-case --test-case-id 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-c, --test-case-id <id>`	Test case ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No

list-test-cases

List all test cases Usage:

octomind list-test-cases [options]

Example:

octomind list-test-cases

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

Test Reports

test-report

Get test report details Usage:

octomind test-report [options]

Example:

octomind test-report --test-report-id 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d

Options

Option	Description	Required
`-j, --json`	Output raw JSON response	No
`-r, --test-report-id <id>`	Test report ID	Yes
`-t, --test-target-id [id]`	Test target ID, if not provided will use the test target id from the config	No

Test Targets

list-test-targets

List all test targets Usage:

octomind list-test-targets [options]

Example:

octomind list-test-targets

Options

Option	Description	Required	Default
`-j, --json`	Output raw JSON response	No

Output Formats

By default, the CLI provides formatted text output for better readability. Add the --json flag to any command to get the raw JSON response instead. This is useful for scripting or when you need to process the output programmatically. Example of JSON output:

{
  "id": "826c15af-644b-4b28-89b4-f50ff34e46b7",
  "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
  "status": "PASSED",
  "executionUrl": "https://example.com",
  "testResults": [
    {
      "id": "abc-123-456",
      "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
      "testCaseId": "test-1",
      "status": "PASSED",
      "traceUrl": "https://storage.googleapis.com/automagically-traces/abc-123-trace.zip"
    },
    {
      "id": "def-456-789",
      "testTargetId": "3435918b-3d29-4ebd-8c68-9a540532f45a",
      "testCaseId": "test-2",
      "status": "PASSED",
      "traceUrl": "https://storage.googleapis.com/automagically-traces/def-456-trace.zip"
    }
  ]
}

Development

Clone the repository
Install dependencies:

pnpm install

The CLI is written in TypeScript and uses the following dependencies:

commander: For command-line argument parsing
openapi-fetch: For making openapi API calls
openapi-typescript: For generating types from openapi spec

To build from source:

pnpm run build

Command Line Interface

​Installation

​Octomind

​Options

​octomind CLI Documentation

​Setup

​init

​Options

​switch-test-target

​Completion

​install-completion

​uninstall-completion

​completion

​Environments

​list-environments

​Options

​create-environment

​Options

​environment

​Options

​update-environment

​Options

​delete-environment

​Options

​Execute

​debug

​Options

​execute

​Options

​create-discovery

​Options

​Notifications

​notifications

​Options

​Private Locations

​register-location

​Options

​unregister-location

​Options

​list-private-locations

​Options

​start-private-location

​Options

​stop-private-location

​Test Cases

​delete-test-case

​Options

​code

​Options

​test-case

​Options

​list-test-cases

​Options

​Test Reports

​test-report

​Options

​Test Targets

​list-test-targets

​Options

​Output Formats

​Development

Installation

Octomind

Options

octomind CLI Documentation

Setup

init

Options

switch-test-target

Completion

install-completion

uninstall-completion

completion

Environments

list-environments

Options

create-environment

Options

environment

Options

update-environment

Options

delete-environment

Options

Execute

debug

Options

execute

Options

create-discovery

Options

Notifications

notifications

Options

Private Locations

register-location

Options

unregister-location

Options

list-private-locations

Options

start-private-location

Options

stop-private-location

Test Cases

delete-test-case

Options

code

Options

test-case

Options

list-test-cases

Options

Test Reports

test-report

Options

Test Targets

list-test-targets

Options

Output Formats

Development