HI AGAIN!

Installation

gem install ruby_raider

Create a New Project

Run the interactive project creator:

raider new [PROJECT_NAME]

Or skip the interactive menu with parameters:

raider new my_project -p framework:rspec automation:selenium

Optional Features

Add extra capabilities when creating a project:

raider new my_project --accessibility    # Add axe gem for a11y testing
raider new my_project --visual           # Add visual regression (chunky_png)
raider new my_project --performance      # Add Lighthouse performance testing

Skip Options

raider new my_project --skip_ci          # Skip CI/CD setup
raider new my_project --skip_video       # Skip video recording setup

Web Testing

Test frameworks: RSpec, Cucumber, Minitest

Automation drivers: Selenium, Watir, Capybara

Mobile Testing (Appium)

Test frameworks: RSpec, Cucumber, Minitest

Platforms: iOS, Android, Cross-Platform

Add-ons

• Accessibility testing (axe gem)
• Visual regression (chunky_png)
• Performance testing (Lighthouse)
• CI/CD: GitHub Actions, GitLab CI/CD
• Reporters: allure, junit, json, both, all, or none

Use raider generate (or raider g) to scaffold test files:

Command	Description
raider g page [NAME]	Create a page object
raider g spec [NAME]	Create an RSpec test
raider g feature [NAME]	Create a Cucumber feature file
raider g steps [NAME]	Create step definitions
raider g helper [NAME]	Create a helper class
raider g component [NAME]	Create a component class
raider g scaffold [NAME(S)]	Create page + test + steps together
raider g destroy [NAME(S)]	Delete scaffolded files
raider g from_url [URL]	Generate page & spec from a live URL

Scaffolding Options

• --from [FILE] — Generate spec from an existing page object
• --ai — Use LLM for intelligent test scenario generation
• --dry_run — Preview files without creating them
• --uses [PAGES] — Specify page dependencies
• --path [PATH] — Custom output path
• --crud — Generate full CRUD scaffold (list, create, detail, edit + tests)

Use raider utility (or raider u) to configure your project:

Command	Description
raider u browser [BROWSER]	Set default browser
raider u browser_options [OPTS]	Set browser options
raider u url [URL]	Set default project URL
raider u path [PATH]	Set default paths for scaffolding
raider u raid	Run all tests
raider u timeout [SECONDS]	Set test timeout
raider u viewport [DIMENSIONS]	Set viewport (e.g. 1920x1080)
raider u platform [PLATFORM]	Set platform for cross-platform tests
raider u debug [on/off]	Toggle debug mode
raider u start_appium	Start Appium server
raider u llm [PROVIDER]	Configure LLM (openai, anthropic, ollama)

Command	Description
raider adopt	Import an existing test project into Ruby Raider
raider version	Show current version
raider help [COMMAND]	Describe available commands or one specific command
raider pm add [NAME]	Add a plugin
raider pm delete [NAME]	Remove a plugin
raider pm list	List available plugins
raider pm local	List installed plugins

Prerequisites

• Ruby 3.0.0+ installed via rbenv (macOS/Linux) or RubyInstaller (Windows)
• The ruby_raider gem: gem install ruby_raider

Installation

Download the installer for your OS from the download section above, or from the GitHub releases page.

macOS Note

On first launch, macOS may block the app. Go to System Settings → Privacy & Security and click "Open Anyway".

1. Launch Raider Desktop and click "Create a new project"
2. Enter a project name
3. Select your automation framework: Selenium, Capybara, Watir, or Appium
4. Select your test framework: RSpec, Cucumber, or Minitest
5. For Appium, also select a mobile platform: iOS or Android
6. Click "Create" — the project is generated on your filesystem

You can also open an existing project or adopt an external project into Ruby Raider.

The Recorder lets you record user interactions and generate test scripts automatically.

1. Navigate to the Recorder tab
2. Enter a test name and the URL you want to test
3. Click "Record" to start recording browser interactions
4. Interact with the page — clicks, typing, navigation are all captured
5. Click "Stop" when finished
6. The recorded steps are converted into test code in your chosen framework

The Tests tab shows your project's test files in a tree view.

• Browse test suites and individual test files
• Select tests using the checkboxes
• Click the play button to run selected tests
• Results are shown with pass/fail status indicators

The Dashboard provides an overview of your project's test health:

• Total Tests — number of tests in the project
• Pass Rate — percentage of passing tests
• Average Duration — mean test execution time
• Failed — count of failing tests needing attention
• Recent Test Runs — history with pass/fail breakdown and progress bars

Configure your project via the Settings tab:

General

• Display language
• Theme (light/dark mode)

Project

• Base URL — default URL for browser tests
• Browser — default browser for automation
• Proxy Settings — HTTP/HTTPS proxy configuration
• File Opener Preferences — preferred code editor
• Experiments — enable experimental features
• Plugin Manager — manage installed plugins

Recording

• Implicit Wait — default timeout for element discovery
• Explicit Wait — timeout for explicit wait conditions
• Selector Priorities — order of attribute selectors to try

rbenv not found

Make sure rbenv is installed and in your PATH. On macOS: brew install rbenv

Permission denied errors

Run chmod +x on the app binary, or re-download from the releases page.

macOS "developer cannot be verified"

Go to System Settings → Privacy & Security and click "Open Anyway" next to the Raider Desktop entry.

Ruby not detected (Windows)

Install Ruby via RubyInstaller or Chocolatey (choco install ruby). Restart Raider Desktop after installing.