PepperBDD.CLI 1.0.3

dotnet add package PepperBDD.CLI --version 1.0.3

NuGet\Install-Package PepperBDD.CLI -Version 1.0.3

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="PepperBDD.CLI" Version="1.0.3">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="PepperBDD.CLI" Version="1.0.3" />
                    

                            Directory.Packages.props

<PackageReference Include="PepperBDD.CLI">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add PepperBDD.CLI --version 1.0.3

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: PepperBDD.CLI, 1.0.3"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package PepperBDD.CLI@1.0.3

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=PepperBDD.CLI&version=1.0.3
                    

                            Install as a Cake Addin

#tool nuget:?package=PepperBDD.CLI&version=1.0.3
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Pepper

BDD-style test documentation generator for .NET. Generate living documentation from your automated tests without step definitions or complex workflows.

Features

Framework Support: NUnit, xUnit, and MSTest
Multiple Output Formats: PDF, HTML, and JSON
Step Extraction: Automatically documents test steps from method calls
Custom Attributes: Add metadata using Pepper attributes
Category Filtering: Generate reports for specific test categories
Customizable Reports: Multiple styles, fonts, and custom logos

Installation

dotnet add package PepperBDD

Quick Start

1. Add Attributes to Your Tests

using Pepper.Attributes;

[Test]
[CaseDescription("Verify user can log in with valid credentials")]
public void Login_WithValidCredentials_ShouldSucceed()
{
    NavigateToLoginPage();
    EnterCredentials("testuser", "password123");
    ClickLoginButton();
    VerifyDashboardIsDisplayed();
}

[StepDescription("Navigate to the login page")]
public void NavigateToLoginPage() { /* ... */ }

[StepDescription("Enter username '{username}' and password")]
public void EnterCredentials(string username, string password) { /* ... */ }

[StepDescription("Click the login button")]
public void ClickLoginButton() { /* ... */ }

[StepDescription("Verify the dashboard is displayed")]
public void VerifyDashboardIsDisplayed() { /* ... */ }

2. Generate Documentation

pepper -generateReport -project "path/to/TestProject" -output "TestReport.pdf"
pepper -generateReport -project "path/to/TestProject" -output "TestReport.html"

Available Attributes

Attribute	Description
`[CaseDescription("...")]`	Describes what a test case validates
`[StepDescription("...")]`	Describes what a method does (supports `{parameter}` templates)
`[StepIgnore]`	Excludes a method from documentation
`[CustomAttribute("Key", "Value")]`	Adds custom metadata (e.g., TestRail IDs)

CLI Options

Option	Description
`-generateReport`	Generate report (PDF or HTML based on output extension)
`-generateJson`	Generate JSON export
`-project`	Path to test project directory
`-output`	Output file path
`-reportName`	Custom report title
`-font`	Font family (calibri, arial, times, courier, consolas)
`-reportStyle`	Layout style (structured, simple)
`-categories`	Filter by categories (e.g., "Smoke,Regression")
`-logoSource`	Path to custom logo image
`-includeCustoms`	Include custom attributes in report
`-config`	Path to configuration file

Configuration File

Create a pepper.config.json file:

{
  "project": "./",
  "output": "TestDocumentation.pdf",
  "reportName": "My Test Suite",
  "font": "calibri",
  "reportStyle": "structured",
  "generateJson": true,
  "categories": "Smoke,Regression"
}

License

MIT - see LICENSE for details.

Support

If you find Pepper useful, consider sponsoring the project on GitHub.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on PepperBDD.CLI:

Package	Downloads
PepperBDD BDD-style test documentation generator for .NET. Installs both PepperBDD.Attributes and PepperBDD.CLI in one package.	721

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.3	128	3/9/2026
1.0.2	119	3/9/2026
1.0.1	130	3/9/2026
1.0.0	126	3/8/2026