Try our conversational search powered by Generative AI!

Shoma Gujjar
Jan 29, 2016
(2 votes)

Pickles : Living documentation generator

Recently there came a requirement from the business,they wanted to know a high level view of the specification/requirements of an Project. A colleague suggested that feature files written in gherkin statements where ideal for this purpose.

Therefore we had to look for a tool that would translate the feature files to a more business-friendly format (word,pdf,html), so that the business could have a look at it at their convenience without having to reach out developers.

There were 2 main tools that suited this requirement namely:

  1. Relish
  2. Pickles

Relish is based on Ruby plus it comes with a subscription fee. They do have a Free plan, but all your projects will be public!

Pickles is open-source and easily installed via nuget. The documentation can be found here. Pickles can be run via commandline, GUI,PowerShell or MSBuild

Sample Example using CommandLine

Pickle supports Html, Dhtml,word,JSON and Excel formats.

Install Pickles in your project:

using nuget console manager : Install-Package Pickles.CommandLine

Open Command Prompt in Administrator mode – > Navigate to your Specs project and execute the below command

..\packages\Pickles.CommandLine.2.3.0\tools\pickles.exe --feature-directory=C:\BitBucket\TestProj.Specs --output-directory=c:\my-features-output --documentation-format=dhtml

where --feature-directory =  is the path to your test project

--output-directory =  path to your output file

--documentation-format =  format of the output (optional) . The default output is html

If you want the output in word format then set --documentation-format=word


The above command can be copied to a .bat-file.

Pickles can also be integrated into automated build or continuous integration tool like TeamCity.

Jan 29, 2016


Please login to comment.
Latest blogs
Optimizely Web... 6 Game Changing Features in 2024

If you are interested in learning about what's new within Optimizely Web, you are in the right place. Carry on reading to learn about the 6 greates...

Jon Jones | Mar 3, 2024 | Syndicated blog

Headless forms reloaded (beta)

Forms is used on the vast majority of CMS installations. But using Forms in a headless setup is a bit of pain since the rendering pipeline is based...

MartinOttosen | Mar 1, 2024

Uploading blobs to Optimizely DXP via PowerShell

We had a client moving from an On-Prem v11 Optimizely instance to DXP v12 and we had a lot of blobs (over 40 GB) needing uploading to DXP as a part...

Nick Hamlin | Mar 1, 2024 | Syndicated blog

DbLocalizationProvider v8.0 Released

I’m pleased to announce that Localization Provider v8.0 is finally out.

valdis | Feb 28, 2024 | Syndicated blog

Epinova DXP deployment extension – With Octopus deploy

Example how you can use Epinova DXP deployment extension in Octopus deployment.

Ove Lartelius | Feb 28, 2024 | Syndicated blog

Identify Azure web app instance id's for an Optimizely CMS site

When running Optimizely CMS in Azure, you will be using an instance bound cloud license. What instances are counted, and how can you check them? Le...

Tomas Hensrud Gulla | Feb 27, 2024 | Syndicated blog