Skip to content

Installation (Ruby)

Terminal window
gem install executable-stories-ruby

Or add it to your bundle:

gem "executable-stories-ruby"

If you want the formatter package in the same workflow, add executable-stories-formatters to your Node project or CI job that renders the raw run JSON.

require "minitest/autorun"
require "executable_stories/minitest"

The Minitest plugin writes .executable-stories/raw-run.json by default after the suite finishes.

require "rspec"
require "executable_stories/rspec"
ExecutableStories::RSpecPlugin.install!

Install the plugin once before your specs run, then call story(...) inside describe blocks to record scenarios.

Both plugins write a raw run JSON file that executable-stories-formatters can render directly to Markdown, HTML, JUnit XML, or Cucumber formats.

First Story (Ruby) — write your first Ruby scenario.

Ruby story & doc API — steps, docs, and adapter options.