errtrace

Documentation

Overview

errtrace instruments Go code with error return tracing.

Installation

Install errtrace with:

go install braces.dev/errtrace/cmd/errtrace@latest

Usage

errtrace [options] <source files | patterns>

This will transform source files and write them to the standard output.

If instead of source files, Go package patterns are given, errtrace will transform all the files that match those patterns. For example, 'errtrace ./...' will transform all files in the current package and all subpackages.

Use the following flags to control the output:

-format
      whether to format ouput; one of: [auto, always, never].
      auto is the default and will format if the output is being written to a file.
-w    write result to the given source files instead of stdout.
-l    list files that would be modified without making any changes.