Quickstart

This guide takes you from a new account to a test you can run again. You need the address of a web app. If the app runs only on your computer, you also need Node.js 24 or newer for the CLI.

Set up your workspace #Link to Set up your workspace

1. 1

   Step 1: Sign up

   Go to app.rehearsal.dev and sign up with Google or with your email address.

2. 2

   Step 2: Name yourself and your workspace

   Rehearsal asks for your name, then for a name and an address for your workspace. The workspace holds your projects, tests and runs.

3. 3

   Step 3: Add your app

   Enter your app's address, such as app.example.com. An address on your computer, such as localhost:3000, works too. Setup then asks you to connect your computer, as the next section shows.

4. 4

   Step 4: Create your first test

   Press Create my first test. Re:agent opens your app in a browser and checks that it loads. You can watch the browser beside the chat.

   When the test is done, Rehearsal says whether it passed. Press Continue to finish setup.

If your app runs on your computer #Link to If your app runs on your computer

Rehearsal's browsers run on its servers. They reach an app on your computer through the Rehearsal CLI, while the CLI is connected. Setup shows these three commands after you enter a local address.

1. 1

   Step 1: Install the CLI

   $ npm install -g @rehearsal-labs/cli

2. 2

   Step 2: Log in

   $ rehearsal login

   Your browser opens. Approve the request there.

3. 3

   Step 3: Connect your app

   $ rehearsal connect http://localhost:3000

   Use your app's own port. If you have more than one project or app, the CLI asks which one to connect.

Keep the terminal open. The setup page moves on by itself once your computer connects. Press Ctrl+C in the terminal when you want to disconnect.

Test a real flow #Link to Test a real flow

Your first test checks that your app loads. Next, test a flow your users rely on.

1. 1

   Step 1: Describe the flow

   Open Re:agent in the sidebar and say what to check, in plain words. For example: "Sign in, create a project called Launch and check that it appears in the list."

2. 2

   Step 2: Add a test account if the flow signs in

   Under Re:agent uses, add the account Re:agent should sign in with. The password is saved encrypted and never goes in the chat.

3. 3

   Step 3: Watch Re:agent work

   Re:agent opens your app in a browser and works through the flow. Each step appears in the chat as it happens. If Re:agent needs something from you, it asks and waits for your answer.

4. 4

   Step 4: Let Rehearsal write and check the test

   When the flow works, Re:agent saves it. A card in the chat follows the test as Rehearsal writes it, runs it once and checks it again in a fresh browser.

Run the test #Link to Run the test

Open Tests, find your test and press Run. If its app has more than one address, Rehearsal asks where to run it.

Open the run to follow it. When a test finishes, you can watch its recording step by step. If a test fails, the run shows the step where it stopped and what the page showed.

Next steps #Link to Next steps

• Install the CLI to run tests from your terminal.
• Read the Introduction to see where else tests can run.