Documentation
¶
Overview ¶
Package cli implements the honey Cobra commands.
Index ¶
- Constants
- func BannerText() string
- func BuildCommit() string
- func BuildDate() string
- func BuildVersion() string
- func Execute() error
- func GetExecRegistry() hostexec.Registry
- func GetSearchRegistry() *searchrun.Registry
- func InitBuildInfo(version, commit, date string)
- func PrintVersion(w io.Writer)
- func VersionTemplate() string
- type Profiler
Constants ¶
const Tagline = "DevOps tool to help find an instance in sea of clouds"
Tagline is the one-line product description (CLI short help).
Variables ¶
This section is empty.
Functions ¶
func BannerText ¶
func BannerText() string
BannerText is tagline + ASCII logo (no version metadata). Used in usage/--help and --version.
func BuildCommit ¶ added in v0.2.7
func BuildCommit() string
BuildCommit returns the git commit string embedded at link time.
func BuildDate ¶ added in v0.2.7
func BuildDate() string
BuildDate returns the build date string embedded at link time.
func BuildVersion ¶ added in v0.2.7
func BuildVersion() string
BuildVersion returns the binary version (for embedded web UI meta).
func GetExecRegistry ¶ added in v0.3.6
GetExecRegistry returns the host execution registry for SSH/Docker/TrueNAS dispatch.
func GetSearchRegistry ¶ added in v0.3.6
GetSearchRegistry returns the global search registry, initializing it if necessary.
func InitBuildInfo ¶
func InitBuildInfo(version, commit, date string)
InitBuildInfo sets version strings used by --version and the version command.
func PrintVersion ¶
PrintVersion writes the logo, tagline, and build metadata (for version subcommand).
func VersionTemplate ¶
func VersionTemplate() string
VersionTemplate returns the cobra --version template (uses {{.Version}}).
Types ¶
type Profiler ¶ added in v0.3.6
type Profiler struct {
// contains filtered or unexported fields
}
Profiler collects system metrics like CPU, memory, and network usage.
func StartProfiler ¶ added in v0.3.6
func StartProfiler() *Profiler
StartProfiler initializes and starts collecting system metrics in the background.
func (*Profiler) StopAndPrintReport ¶ added in v0.3.6
func (p *Profiler) StopAndPrintReport(targets, steps int, cache *engine.ClientCache)
StopAndPrintReport stops the profiler and prints the collected metrics and SSH cache stats.
Source Files
¶
- alert.go
- alert_serve.go
- app.go
- audit.go
- backends.go
- banner.go
- buildinfo.go
- config.go
- config_utils.go
- cue_exec_check.go
- cue_validate.go
- device.go
- docs.go
- doctor.go
- egress.go
- exec.go
- exec_check.go
- flagdefaults.go
- logs.go
- macros.go
- mcp.go
- plugins.go
- profiler.go
- proxy.go
- pty_proxy.go
- recordings.go
- registry.go
- root.go
- search.go
- search_cue_exec.go
- search_inventory.go
- secrets.go
- version_cmd.go
- web.go
- web_policy.go