What does Pickles do?

Pickles is a Living Documentation generator: it takes your Specification (written in Gherkin, with Markdown descriptions) and turns them into an always up-to-date documentation of the current state of your software - in a variety of formats.

Additionally, you can provide Pickles with the results of your Executable Specification. Pickles will show a pass/fail mark next to each scenario.

Read more about the what and why of Pickles in our documentation, or have a look at the example output in the next section.

Example Output

Pickles can generate your documentation in the following formats:


Version 2 needs .NET 4.5 - this may be a breaking change for some, but the download sizes are much smaller now. Pickles should run faster too.

Each runner has a link when you can find download information:

If you prefer to download the .zip files, you can so from the Github release page.

Release Notes

Check out the release notes to see what's new.

Source Code

Build status

Previous Versions

You can find previous versions of Pickles on the Release page on GitHub.

Pickles is copyrighted:

  • Jeffrey Cameron 2011-2012
  • PicklesDoc and community contributors 2012-present

Pickles is licensed under the Apache License, Version 2.0.

Pickles uses several open source libraries that are governed by their own licenses.