Ruby Raider

Getting started

This page takes you from a fresh install to a test that passes.

What you need

Raider Desktop runs your tests with Ruby Raider, so three things must be on your computer first:

If any of these is missing, the app shows a setup guide when it starts. The app does not install Ruby for you.

Install on macOS

  1. Install Homebrew if you do not have it.
  2. Install rbenv. In Terminal, run:
    brew install rbenv ruby-build && rbenv init
    Follow what rbenv init prints to add rbenv to your shell (.zshrc or .bash_profile), then open a new Terminal window.
  3. Install Ruby and make it the default:
    rbenv install 3.4.1 && rbenv global 3.4.1
  4. Install Ruby Raider:
    gem install ruby_raider
  5. Download Raider Desktop from the releases page and move it to your Applications folder. The app is called Ruby Raider there and in its window title.

The version number in the app's footer is the version of the ruby_raider gem you installed, not of the app.

The first time you open the app

The app is not yet signed with an Apple developer certificate, so macOS stops it the first time:

You only do this once. More fixes are on Troubleshooting.

Windows and Linux

macOS is the only platform that is fully tested. Windows and Linux builds exist, but treat them as experimental. On Windows, the recommended route is to install inside WSL and follow the Linux steps the app's setup guide shows.

Your first project

You have two ways to start.

For a first try, use Quick record:

  1. On the welcome screen, click Quick record.
  2. Enter the Website address where the test should start, for example https://example.com.
  3. Give it a Test name, for example "Checkout works".
  4. Click Start.

You can keep a quick recording in a folder of your own later with Save project to…. To create a full project instead, see Projects.

Your first recording

When recording starts, the page opens on the right and a short guide appears above the steps.

  1. Use the page as you normally would. Each click and each thing you type becomes a step in the list.
  2. To check something on the page, for example that a message appears, press Add validation…, click the thing on the page, and choose what to check.
  3. When you are done, press Stop & save, or ⌘⇧R (Ctrl+Shift+R).

Your test is now saved, and any change you make to it from here on saves itself. Read more in Recording tests.

Your first run

Open the test and press Run, or ⌘R (Ctrl+R). Raider opens the browser, replays every step and shows the result below the steps. If it failed, the app shows the step that failed and ways to fix it; see Recording tests.

Where to go next