cli

Documentation

Overview

Package cli contains various cli utilities that are useful for building cli applications with gobox based applications

Index

• func HookInUrfaveCLI(ctx context.Context, cancel context.CancelFunc, a *cli.App, ...)
• func Run(ctx context.Context, cancel context.CancelFunc, a *cli.App, conf *Config)
• type Config
• type TelemetryConfig
• type TelemetryOtelConfig

Functions

func HookInUrfaveCLI

func HookInUrfaveCLI(ctx context.Context, cancel context.CancelFunc, a *cli.App,
	logger logrus.FieldLogger, honeycombAPIKey, dataset, _ string)

HookInUrfaveCLI sets up an app.Before that automatically traces command runs and automatically updates itself.

TODO(jaredallard): Deprecate this after templates have been updated and released for a few weeks.

func Run

func Run(ctx context.Context, cancel context.CancelFunc, a *cli.App, conf *Config)

Run runs a urface/cli application.

Types

type Config

type Config struct {
	// Telemetry is the configuration for telemetry for the CLI
	Telemetry TelemetryConfig

	// Logger is the logger to use for logging
	Logger logrus.FieldLogger
}

Config configures the CLI integration provided by gobox

type TelemetryConfig

type TelemetryConfig struct {
	// UseDelibird enables the delibird integration, which logs all output to a
	// file as frames (writes to the terminal) as well as records traces.
	//
	// These files will not be automatically uploaded, a daemon must be running on
	// the user's local machine to upload them. For Outreach, this is uploaded by the
	// orc 'delibird' daemon. For other users, these are kept locally.
	UseDelibird bool

	// Otel is the configuration for telemetry when delibird is not in use.
	Otel TelemetryOtelConfig
}

TelemetryConfig is the configuration for telemetry for the CLI

type TelemetryOtelConfig

type TelemetryOtelConfig struct {
	// HoneycombAPIKey is the honeycomb API key to use for telemetry.
	HoneycombAPIKey cfg.SecretData

	// Dataset is the dataset to send telemetry to.
	Dataset string

	// Debug enables debug logging for telemetry.
	Debug bool
}

TelemetryOtelConfig is the configuration for telemetry when delibird is not in use.