htmlcov

README

Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License

htmlcov is utility for converting coverage profiles into HTML pages.

Installation

From source

To build the htmlcov from scratch, make sure you have a working Go 1.17+ workspace (instructions), then:

go install github.com/essentialkaos/htmlcov@latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository:

bash <(curl -fsSL https://apps.kaos.st/get) htmlcov

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

sudo htmlcov --completion=bash 1> /etc/bash_completion.d/htmlcov

ZSH:

sudo htmlcov --completion=zsh 1> /usr/share/zsh/site-functions/htmlcov

Fish:

sudo htmlcov --completion=fish 1> /usr/share/fish/vendor_completions.d/htmlcov.fish

Man documentation

You can generate man page using next command:

htmlcov --generate-man | sudo gzip > /usr/share/man/man1/htmlcov.1.gz

Usage

Usage: htmlcov {options} coverage-file

Options

  --output, -o file    Output file (default: coverage.html)
  --remove, -r         Delete input file after successful generation
  --no-color, -nc      Disable colors in output
  --help, -h           Show this help message
  --version, -v        Show version

CI Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0