Generating LivingDoc using CLI

SpecFlow+LivingDoc Generator allows you to generate a local or self-hosted HTML of your Gherkin Feature Files without the need of Azure DevOps. You also have the option to generate documentation with or without test results.

Generation excluding test results

In order to generate your living documentation without test execution results, you need to:

  1. Install the command line tool

  2. Execute the command line tool to generate the documentation.

Generation including test results

In order to generate your living documentation with test execution results, you need to:

  1. Setup the SpecFlow.Plus.LivingDocPlugin for your SpecFlow project (if you have created the project using the SpecFlow Visual Studio project template, this dependency should already be there).

  2. Build your project.

  3. Run your tests. This will generate a TestExecution.json next to your TestAssembly which is needed in the next step.

  4. Install the command line tool

  5. Execute the command line tool and make sure to pass the test execution JSON files to the CLI.