# livingdoc test-assembly

`livingdoc test-assembly` - Generates living documentation from a compiled SpecFlow test assembly.

## Synopsis

``` powershell
  livingdoc test-assembly
      [--project-language <projectLanguage>]
      [-t|--test-execution-json <testExecutionJson>]
      [--title <title>]
      [--project-name <project-name>]
      [--work-item-url-template <workItemUrlTemplate>]
      [--work-item-prefix <workItemPrefix>]
      [--binding-assemblies <bindingAssembly1 [bindingAssembly2 ...]>]
      [-o|--output <output>]
      [--output-type <HTML|JSON>]
    <testAssembly>
```

## Arguments

`<testAssembly>`

  Relative (from the working directory) or absolute path of the SpecFlow test assembly.

  ***If the path to the file contains a space, make sure to enclose it in quotes.**

## Options

* `--project-language <projectLanguage>`

  The language used in your feature files. See [Gherkin languages](https://docs.cucumber.io/gherkin/reference/#overview).

---

* `-t|--test-execution-json <testExecutionJson>`

  Relative (from the working directory) or absolute path of the test execution JSON files generated by the SpecFlow.Plus.LivingDocPlugin during test execution.


>**_NOTE:_** If you used the SpecFlow+ Runner with its [parallel execution features](https://docs.specflow.org/projects/specflow-runner/en/latest/Usage/Parallel-Execution-Features.html) you may end up with multiple JSON files.   
   You can include multiple JSON files separated by a space in the command-line tool as per below
* `-t|--test-execution-json <testExecutionJson_1 testExecutionJson_2 ... >`  

  OR

  Use a wild card (*) to include them all:

* `-t|--test-execution-json <testExecutionJson*>`
  
  *Check [this guide](https://docs.specflow.org/projects/specflow-livingdoc/en/latest/Guides/Merging-Multiple-test-results.html) for further info on this subject.*

---

* `--binding-assemblies <bindingAssembly1 [bindingAssembly2 ...]>`

  Relative (from the working directory) or absolute path of the SpecFlow binding assemblies separated by space. The <*TestAssembly*> does not have to be specified as a binding assembly because it is always scanned for SpecFlow bindings.

---

* `-o|--output <output>`

  Relative (from the working directory) or absolute path to the generated output file. Default value: `LivingDoc.html`

 >**_NOTE:_** If the directory given in the "--output" path does not already exist, LivingDoc CLI will automatically create the output directories in the given output path.

 >The last element in a path ending in a slash or backslash is treated as a directory (not a file name),if a directory with the same name does not exist.   
 >For example, **report** in --output ./out/out2/**report**/ is treated as a directory if it does not exist yet.
 However, if a directory named **report** does exist in the path, then **report** is treated as a directory regardless of the path ending in a slash/backslash or not.

---

* `--output-type <HTML|JSON>`

  The type of output file to be generated. The `HTML` output is the living documentation report. The `JSON` output contains the pre-parsed feature data optionally extended with further information (test execution results, binding information, etc.). Default value: `HTML`

---

* `--work-item-prefix <workItemPrefix>`

  The name of the special tag you mark the scenarios with to link them to the corresponding work items.

---

* `--work-item-url-template <workItemTemplate>`

  The URL template to use to generate the [external links](../../Viewing/Linking.html#linking-to-external-alm-systems-in-livingdoc-generator). e.g: `https://dev.azure.com/fabrikam/FabrikamProj/_workitems/edit/{id}`

---

* `--title <title>`

  The title/header of the generated document.
  Default value: The root folder node's name.

---

* `--project-name <project-name>`

  This name is used by the root node in the tree.
  Default value: The name of the SpecFlow test assembly.