This is no longer the canonical repo -- it has moved to
Ruby Shell
Pull request Compare This branch is 2 commits ahead, 618 commits behind vcr:master.
Latest commit d35bd49 Jan 10, 2014 @myronmarston myronmarston Merge pull request #5 from JonahMoses/patch-1
Update readme to include irc server/channel with link
Failed to load latest commit information.
benchmarks Add quality spec that enforces whitespace policy. Feb 26, 2012
features Skip cukes that have been intermittently failing on 1.8.7 on travis. Oct 30, 2012
gemfiles Add regression spec for typhoeus/VCR bug found by @jeg2. Nov 23, 2012
lib Fix YAML serialization on ruby 2.0. Nov 23, 2012
script Add -x flag so it gives me more info. Oct 30, 2012
spec Add regression spec for typhoeus/VCR bug found by @jeg2. Nov 23, 2012
vendor Update vendored rspec 1 to my fork that ignored rubinius .rbc files. Oct 12, 2010
.gemtest Add support for Feb 28, 2011
.gitignore Put Gemfile.lock under source control. Nov 20, 2012
.gitmodules Update vendored rspec 1 to my fork that ignored rubinius .rbc files. Oct 12, 2010
.limited_red Setup limited red. Feb 22, 2012
.rspec Use fuubar rspec formatter. Nov 25, 2010
.travis.yml Build all branches. Oct 12, 2012
.yardopts Add additional files to yard listing. Feb 13, 2012
Appraisals Update to released versions of things. Nov 20, 2012 2.3.0 release. Oct 30, 2012 Fix links in to use markdown format rather than githu… Nov 22, 2011
Gemfile Update to released versions of things. Nov 20, 2012
Gemfile.lock Add regression spec for typhoeus/VCR bug found by @jeg2. Nov 23, 2012
LICENSE Update copyright years. Jan 29, 2012 Update readme to include irc server and channel Jan 10, 2014
Rakefile Add back support for Typhoeus 0.4. Oct 30, 2012 Clarify a few things in the Upgrade doc. Mar 3, 2012
cucumber.yml Add cukes documenting new http request hooks. Nov 28, 2011
vcr.gemspec Add regression spec for typhoeus/VCR bug found by @jeg2. Nov 23, 2012


Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.

Build Status


require 'rubygems'
require 'test/unit'
require 'vcr'

VCR.configure do |c|
  c.cassette_library_dir = 'fixtures/vcr_cassettes'
  c.hook_into :webmock # or :fakeweb

class VCRTest < Test::Unit::TestCase
  def test_example_dot_com
    VCR.use_cassette('synopsis') do
      response = Net::HTTP.get_response(URI(''))
      assert_match /Example Domains/, response.body

Run this test once, and VCR will record the http request to fixtures/vcr_cassettes/synopsis.yml. Run it again, and VCR will replay the response from when the http request is made. This test is now fast (no real HTTP requests are made anymore), deterministic (the test will continue to pass, even if you are offline, or goes down for maintenance) and accurate (the response will contain the same headers and body you get from a real request).


  • Automatically records and replays your HTTP interactions with minimal setup/configuration code.
  • Supports and works with the HTTP stubbing facilities of multiple libraries. Currently, the following are supported:
  • Supports multiple HTTP libraries:
  • Request matching is configurable based on HTTP method, URI, host, path, body and headers, or you can easily implement a custom request matcher to handle any need.
  • The same request can receive different responses in different tests--just use different cassettes.
  • The recorded requests and responses are stored on disk in a serialization format of your choice (currently YAML and JSON are built in, and you can easily implement your own custom serializer) and can easily be inspected and edited.
  • Dynamic responses are supported using ERB.
  • Automatically re-records cassettes on a configurable regular interval to keep them fresh and current.
  • Disables all HTTP requests that you don't explicitly allow.
  • Simple cucumber integration is provided using tags.
  • Includes convenient RSpec macro and integration with RSpec 2 metadata.
  • Known to work well with many popular ruby libraries including RSpec 1 & 2, Cucumber, Test::Unit, Capybara, Mechanize, Rest-Client and HTTParty.
  • Includes Rack and Faraday middleware.


The docs come in two flavors:

  • The relish docs contain example-based documentation (VCR's cucumber suite, in fact). It's a good place to look when you are first getting started with VCR, or if you want to see an example of how to use a feature.
  • The docs contain API documentation. The API docs contain detailed info about all of VCR's public API.

See the Upgrade doc for info about what's new and changed in VCR 2.0.

Release Policy

VCR follows the principles of semantic versioning. The API documentation define VCR's public API. Patch level releases contain only bug fixes. Minor releases contain backward-compatible new features. Major new releases contain backwards-incompatible changes to the public API.

Ruby Interpreter Compatibility

VCR has been tested on the following ruby interpreters:

  • MRI 1.8.7
  • MRI 1.9.2
  • MRI 1.9.3
  • REE 1.8.7
  • JRuby
  • Rubinius

Note that as of VCR 2, 1.8.6 and 1.9.1 are not supported.


  • Source hosted on GitHub.
  • Direct questions and discussions to the IRC channel ( #vcr) or the mailing list.
  • Report issues on GitHub Issues.
  • Pull requests are very welcome! Please include spec and/or feature coverage for every patch, and create a topic branch for every separate change you make.
  • See the Contributing guide for instructions on running the specs and features.
  • Code quality metrics are checked by Code Climate.
  • Documentation is generated with YARD (cheat sheet). To generate while developing:
yard server --reload


Thanks also to the following people who have contributed patches or helpful suggestions:

Ports in other languages

Similar Libraries in Ruby


Copyright (c) 2010-2012 Myron Marston. Released under the terms of the MIT license. See LICENSE for details.