For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content

Installing Kane CLI

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 install -g @testmuai/kane-cli

Platform-specific native binaries are installed automatically for your OS. No additional configuration is needed.

note

Kane CLI requires Google Chrome installed on your system. Chrome is used as the automation browser and is launched automatically when you run a test. The npm install additionally requires Node.js 18 or higher. The Homebrew install bundles Chrome for you and needs no Node.js.

Verify​

kane-cli --version

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​

PlatformArchitectureSupported
macOSApple Silicon (ARM)✅
macOSIntel (x64)✅
Linuxx64✅
Windowsx64✅
note

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​

Kane CLI checks the npm registry once every 24 hours when you launch it. When a newer version is available, the CLI prints a one-line notification on startup with the current and latest versions. The check runs in the background and never blocks startup.

Upgrade with:

npm install -g @testmuai/kane-cli@latest

After upgrading, run kane-cli --version to confirm the new version is active.

Uninstall​

npm uninstall -g @testmuai/kane-cli

This removes the kane-cli binary but leaves your local data in place. Kane CLI stores credentials, configuration, sessions, and Chrome profile data under ~/.testmuai/kaneai/. To wipe that state as well:

rm -rf ~/.testmuai/kaneai

Only do this 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:

# Find your npm global bin directory
npm config get prefix

# The kane-cli binary lives in <prefix>/bin on macOS/Linux, and <prefix> on Windows
# Add it to your PATH in ~/.zshrc or ~/.bashrc
export PATH="$(npm config get prefix)/bin:$PATH"

Installation fails on Node 16

Kane CLI requires Node.js 18+. Check your version and upgrade if needed:

node --version

Plugins​

Some capabilities ship as plugins that Kane CLI installs into a versioned local layout under ~/.testmuai/kaneai/plugins/. The one you are most likely to need is remote-execution, which owns the HyperExecute binary behind kane-cli testrun run --remote:

Verified
kane-cli plugin install remote-execution      # install (add --version <v> to pin one)
kane-cli plugin list # what is installed, with versions
kane-cli plugin doctor remote-execution # readiness: installed, binary present, logged in
kane-cli plugin remove remote-execution

Next Step​

Quick Start: Authenticate and run your first test.

Terminal First Testing With Kane CLI

Natural language browser & mobile app tests right from terminal.

×
Schedule Your Personal Demo
Kane CLI terminal

Help and Support

Related Articles