Install the CLI

The Rehearsal CLI runs your saved tests, reads their results and connects an app on your computer to Rehearsal. You create tests in the app, with Re:agent.

The CLI needs Node.js 24 or newer. Check your version with node --version.

Install #Link to Install

$ npm install -g @rehearsal-labs/cli

This installs two commands, rehearsal and rhl. They are the same program, and rhl is shorter to type. Help, examples and JSON output always say rehearsal.

Other package managers #Link to Other package managers

The CLI runs on Node.js whichever one installs it, so it still needs Node.js 24 or newer.

Check that it works #Link to Check that it works

$ rehearsal --version

This prints the version you installed. To see every command, run rehearsal help. Help works offline and without signing in.

$ rehearsal help$ rehearsal help runs$ rehearsal help agent-workflow

rehearsal help agent-workflow is a page written for coding agents. It tells an agent how to find your tests, run them and read the results.

Log in #Link to Log in

$ rehearsal login

Your browser opens. Approve the request there, and the CLI is signed in. On a machine without a browser, run rehearsal login --no-browser. It prints a link that you open somewhere else.

Update #Link to Update

Run the install command again. npm replaces the version you have with the newest one.

$ npm install -g @rehearsal-labs/cli$ rehearsal --version

Remove #Link to Remove

Log out first. That ends the sign-in and deletes the file that holds it. Then remove the package.

$ rehearsal logout$ npm uninstall -g @rehearsal-labs/cli

Next steps #Link to Next steps

• Log in with only the access a task needs.
• Connect a local app so Rehearsal can test it.
• Run tests from the terminal and read their results.