tool
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Report a Vulnerability
Open Source Insights
Documentation¶
Overview¶
Package tool is a harness for writing Go tools.
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcCommandLineErrorf¶
CommandLineErrorf is like fmt.Errorf except that it returns a value thattriggers printing of the command line help.In general you should use this when generating command line validation errors.
Types¶
typeApplication¶
type Application interface {// Name returns the application's name. It is used in help and error messages.Name()string// Most of the help usage is automatically generated, this string should only// describe the contents of non flag arguments.Usage()string// ShortHelp returns the one line overview of the command.ShortHelp()string// DetailedHelp should print a detailed help message. It will only ever be shown// when the ShortHelp is also printed, so there is no need to duplicate// anything from there.// It is passed the flag set so it can print the default values of the flags.// It should use the flag sets configured Output to write the help to.DetailedHelp(*flag.FlagSet)// Run is invoked after all flag processing, and inside the profiling and// error handling harness.Run(ctxcontext.Context, args ...string)error}Application is the interface that must be satisfied by an object passed to Main.
typeProfile¶
type Profile struct {CPUstring `flag:"profile.cpu" help:"write CPU profile to this file"`Memorystring `flag:"profile.mem" help:"write memory profile to this file"`Allocstring `flag:"profile.alloc" help:"write alloc profile to this file"`Tracestring `flag:"profile.trace" help:"write trace log to this file"`Blockstring `flag:"profile.block" help:"write block profile to this file"`}Profile can be embedded in your application struct to automaticallyadd command line arguments and handling for the common profiling methods.
typeSubCommand¶added inv0.1.10
type SubCommand interface {Parent()string}
Source Files