Arguments

Introduction

This page lists the various arguments available to the user when using Pickles. A detailed explanation of the parameter, list of possible values and an example of how it is used with each one of the test runners is provided.

Feature Directory

Explanation

Allows the user to tell Pickles the root directory where the feature files are located. All files underneath this root directory will be added to the output documentation.

Default Value

None as yet.

Possible Values

Any valid directory path, either absolute or relative.

Usage

• Console

Pickles.exe --feature-directory=C:\MyProject\Features Pickles.exe -f=C:\MyProject\Features

• Powershell

Pickle-Features -FeatureDirectory C:\MyProject\Features

• MSBuild

• NAnt

Output Directory

Explanation

Allows the user to customize where the generated output will go.

Default Value

None as yet.

Possible Values

Any valid directory path, either absolute or relative.

Usage

• Console

Pickles.exe --output-directory=C:\GeneratedDocs Pickles.exe -o=C:\GeneratedDocs

• Powershell

Pickle-Features -OutputDirectory C:\GeneratedDocs

• MSBuild

• NAnt

Test Results Format

Explanation

If the user decides to weave test results into the generated output then this specifies what format the test results are in

Default Value

NUnit

Possible Values

NUnit, xUnit

Usage

• Console
• Powershell
• MSBuild
• NAnt

Link Results File

Explanation

If the user decides to weave test results into the generated output then this specifies what format the test results are in

Default Value

NUnit

Possible Values

NUnit, xUnit

Usage

• Console
• Powershell
• MSBuild
• NAnt

System Under Test Name

Explanation

If the user decides to weave test results into the generated output then this specifies what format the test results are in

Default Value

NUnit

Possible Values

NUnit, xUnit

Usage

• Console
• Powershell
• MSBuild
• NAnt

System Under Test Version

Explanation

If the user decides to weave test results into the generated output then this specifies what format the test results are in

Default Value

NUnit

Possible Values

NUnit, xUnit

Usage

• Console
• Powershell
• MSBuild
• NAnt

Language

Explanation

If the user decides to weave test results into the generated output then this specifies what format the test results are in

Default Value

NUnit

Possible Values

NUnit, xUnit

Usage

• Console
• Powershell
• MSBuild
• NAnt

Documentation Format

Explanation

If the user decides to weave test results into the generated output then this specifies what format the test results are in

Default Value

NUnit

Possible Values

NUnit, xUnit

Usage

• Console
• Powershell
• MSBuild
• NAnt