How to install the ClearRun CLI

Run npm install -g @clearrun/cli, then clearrun --version to check it worked. You need Node.js 18 or newer.

Last updated

Steps

  1. Check Node.js

    node --version

    It should print 18 or higher.

  2. Install the CLI

    npm install -g @clearrun/cli

  3. Check the version

    clearrun --version

Next

Save your key with clearrun login. See How to save your API key with clearrun login.

Don't want a global install? Use npx. See How to run the ClearRun CLI without installing it (npx).

If clearrun is not found

npm's global folder is not on your PATH. Run npm prefix -g and add its bin folder to PATH, or use npx @clearrun/cli instead.