README.md

Tyrannoport

🦖 For processing TRX files into something more enjoyable 🦖

Installation

Tyrannoport is a dotnet tool. It can be installed either to a project's local dotnet-tools.json, or globally.

$ dotnet tool install tyrannoport

Or to install globally

$ dotnet tool install --global tyrannoport

The tool can then be run as either tyrannoport, or dotnet tool run tyrannoport.

Usage

Tyrannoport takes one or more TRX file names and generates HTML reports next to them.

$ tyrannoport [report.trx]+

Rendering can take place to a separate directory by specifying --output:

$ tyrannoport --output=<some/dir> [report.trx]+

If you are only rendering a single report then output can be a file path to the summary document instead.

Cake Build

Tyrannoport can be called directly from Cake build scripts. You will need to have both the Tyrannoport tool, and the Cake.Tyrannoport package installed:

#tool "dotnet:?package=Tyrannoport&version=0.3.21"
#addin "nuget:?package=Cake.Tyrannoport&version=0.3.21"

Then in your build.cake you can call Tyrannoport:

Task("Report")
    .IsDependentOn("Test")
    .Does(() =>
{
    Tyrannoport(trxPath);
});

For more details see the example Cake project.

NUKE Build

Tyrannoport can be called from NUKE by referencing it as a custom tool:

$ nuke :add-package Tyrannoport --version 0.3.21

Then in your Build.cs:

[PackageExecutable("Tyrannoport", "Tyrannoport.dll")]
readonly Tool Tyrannoport;

// ... 

Tyrannoport(trxPath);

License

Tyrannoport is licensed under the MIT license.