Skip to main content
Kane CLI is published to the public npm registry as @testmuai/kane-cli and to a Homebrew tap. Install it with npm or brew to get the kane-cli command on your PATH.

​
Install

Requires Node.js 18 or higher.
npm installs the native binary for your OS automatically, with no extra configuration. This works on every platform in the Platform Support table, including Linux arm64 (aarch64).If your global npm prefix is not on PATH, add it before you run kane-cli. Find the prefix with npm config get prefix. The kane-cli binary is in <prefix>/bin on macOS and Linux, and in <prefix> on Windows.
Kane CLI requires Google Chrome on your system. Chrome is the automation browser, and Kane CLI launches it automatically when you run a test. The npm install also requires Node.js 18 or higher. The Homebrew install bundles Chrome for you and needs no Node.js.

​
Install with pnpm or yarn

Kane CLI does not support installation with pnpm. pnpm keeps packages in a nested node_modules/.pnpm/ store, which puts the project-root node_modules/ deeper on disk than npm does. Kane CLI looks for its platform-specific v16-runner binary by searching up the directory tree, and that search does not reach far enough in a pnpm layout. The runner is never found and the CLI stops. You see a silent exit with status 2 shortly after startup. See CLI exits with code 2 and no output in the troubleshooting guide. Issue #24 tracks this limitation. Install Kane CLI with one of the supported methods instead:
  • npm, globally (npm install -g @testmuai/kane-cli, above).
  • Homebrew on macOS or Linux (brew install LambdaTest/kane/kane-cli). Does not require Node.
  • The shell installer on any POSIX system (curl -fsSL https://raw.githubusercontent.com/LambdaTest/kane-cli/main/install.sh | sh).
yarn (classic and Berry) is not verified end to end. If you use yarn, install with Homebrew or the shell installer instead.

​
Verify

Confirm the install by printing the version:
Expected output:
If the command is not found, your shell is not seeing the npm global bin directory. Open a new terminal or update PATH, then try again.

​
Platform Support

Kane CLI ships native binaries for the following platforms. When you install the main package, the matching binary is installed automatically.
Mobile testing, the iOS Simulator and the Android Emulator, runs on your own machine on macOS Apple Silicon (arm64) only. See Mobile Testing for the simulator and emulator prerequisites. On every other platform, mobile suites run on the cloud grid with testrun run --remote, which needs no mobile tooling on your machine.

​
Update

When you launch Kane CLI, it checks the npm registry for a newer version, at most once every 24 hours. If one is available, the CLI prints a one-line notice at startup with the current and latest versions. The check runs in the background and never delays startup. If the network is unavailable, Kane CLI skips the check silently. Upgrade with:
After upgrading, run kane-cli --version to confirm the new version is active.

​
Uninstall

Remove the global package:
This removes the kane-cli binary but keeps your local data. Kane CLI stores credentials, configuration, sessions, and Chrome profile data under ~/.testmuai/kaneai/. To delete that data too:
Do this only if you want a clean reset. It logs you out of all profiles and deletes saved configuration, session history, and command history.

​
Troubleshooting Installation

kane-cli: command not found after install Your npm global bin directory is not in your PATH. Find it and add it:
Installation fails on Node 16 Kane CLI requires Node.js 18+. Check your version and upgrade if needed:

​
Plugins

Some capabilities ship as plugins. Kane CLI installs them under ~/.testmuai/kaneai/plugins/, with each version kept separately. The plugin you are most likely to need is remote-execution. It provides the HyperExecute binary that kane-cli testrun run --remote uses:

​
Next Step

Quick Start: Authenticate and run your first test.