cli

Documentation

Overview

Package cli wires the command-line interface together and bootstraps the platform-go observability suite that the rest of the application builds on.

The CLI is tarp's single entrypoint: `analyze` reports the functions in a package that carry no direct unit test, `cover` renders the same verdict over a coverage profile, and new subcommands hang off the root command alongside them.

Index

• Constants
• func Execute(ctx context.Context) error

Constants

const ConfigFilePathEnvVar = config.EnvVarPrefix + "CONFIG_FILEPATH"

ConfigFilePathEnvVar names the environment variable that seeds the --config flag: when it points at a JSON config file, that file is loaded instead of the flag/environment defaults.

Functions

func Execute

func Execute(ctx context.Context) error

Execute builds the root command, runs it, and tears down the observability suite afterwards so buffered telemetry is flushed even when a command fails.

Errors are printed here rather than by cobra so that --fail-on-found can exit non-zero without also printing an error: the report it just wrote is the message, and CI does not need "Error:" stapled underneath it.