Skip to main content

​
How does it look like?

Example of octomind cli tool, 08/2025

Example of octomind cli tool, 08/2025

​
Installation

Install the Octomind CLI globally using npm: 
npm install -g @octomind/octomind
This is the simplest and recommended way to install the CLI. It makes the octomind command available globally on your system.

​
2. Use via npx (no installation required)

You can run the CLI without installing it by using npx: 
npx @octomind/octomind -h
This is useful for one-off commands or trying out the CLI without installing it.

​
Updating

If you installed globally: 
npm update -g @octomind/octomind
If you used the advanced installation method: 
cd ~/.local/packages
npm install @octomind/octomind@latest

​
Initializing the CLI

After installing the CLI, you need to initialize it by setting up your API key and optionally a test target ID. This configuration allows you to avoid passing these parameters for subsequent commands. 
octomind init \
  [--api-key <key>] \
  [--test-target-id <id>] \
  [--force]

​
Options

  • -k, --api-key: Your Octomind API key (will prompt if not provided)
  • -t, --test-target-id: Test target ID (optional)
  • -f, --force: Force overwrite existing configuration

​
Getting Your API Key

The option to create your API key can be found within the settings menu.
project setting

Project settings menu icon, 12/2025

Click on Create an API key.
Link to create an API key in the Octomind app

Create an API key button, 12/2025

You then will be navigated to our auth provider where you can create a new organization-level API key. Add the API key to your CI provider as a secret to run test reports from the CI.

​
Example

# Initialize with API key
octomind init --api-key your-api-key-here

# Initialize with API key and test target ID
octomind init --api-key your-api-key-here --test-target-id your-test-target-id

# Force overwrite existing configuration
octomind init --force
Once initialized, you can use other CLI commands without having to specify your API key or test target ID with each command.

​
Autocompletion

On macOS and linux you can enable autocompletion by running the following command (works for bash, zsh & fish): 
npx @octomind/octomind install-completion
You can disable autocompletion by running the following command: 
npx @octomind/octomind uninstall-completion
Autocompletion will only work if you have installed the package globally and created a config file with npx @octomind/octomind init. This way even entityIds like environmentIds or testCaseIds will be autocompleted.

​
Source

The source code for the CLI is available on GitHub .