cli

Documentation

Overview

Package cli wires up the limitping command-line interface.

Index

• Constants
• Variables
• func Execute() error

Constants

const BinaryAlias = "lmp"

BinaryAlias is the short name installed alongside the binary, so `lmp` is interchangeable with `limitping`. install.sh creates it as a symlink and `uninstall` removes it. It deliberately avoids the `lp*` namespace, which belongs to CUPS: `lp`, `lpq`, `lpr`, `lprm`, `lpstat` and friends ship on macOS and most Linux distributions, and installing into a directory that precedes /usr/bin on PATH would shadow the system printing commands.

const DevVersion = "dev"

DevVersion is reported for a build with no release identity. It is not a version number on purpose, so it can never compare as newer or older than a real release.

Variables

var Version = ""

Version is set at build time via -ldflags by the release pipeline. Leaving it empty everywhere else is deliberate: version() then derives the value from the module's own build info, so the tag is the single source of truth and there is no second copy to forget to bump. DevVersion marks a build that came from neither, which is any local `go build`.

Functions

func Execute

func Execute() error

Execute runs the root command.