Getting Started

This guide walks you through installing Scampi and writing your first test.

Requirements

Add Scampi to your Gemfile:

gem "scampi"

Or install it directly:

gem install scampi

Create a file called greet.rb:

def greet(name) = "hello #{name}"

test do
  it "greets by name" do
    greet("world").should == "hello world"
  end
end

Run it directly:

ruby greet.rb

Or with the scampi runner:

scampi greet.rb

When invoked without arguments, scampi uses rg to find every file containing a test do block and runs them all:

bundle exec scampi