config

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2026 License: GPL-3.0 Imports: 1 Imported by: 0

Documentation

Overview

Package config defines the CLI structure and configuration for VIIPER.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CLI

type CLI struct {
	// Global
	ConfigPath   string       `help:"Path to configuration file (json|yaml|toml)" name:"config" env:"VIIPER_CONFIG"`
	UpdateNotify UpdateNotify `help:"Update notification level: none, stable, prerelease" default:"stable" env:"VIIPER_UPDATE_NOTIFY"`
	Log          `embed:"" prefix:"log."`

	Server cmd.Server `cmd:"" help:"Start the VIIPER USB-IP server"`
	Proxy  cmd.Proxy  `cmd:"" help:"Start the VIIPER USB-IP proxy"`

	Config    cmd.ConfigCommand `cmd:"" help:"Manage configuration files"`
	Codegen   cmd.Codegen       `cmd:"" help:"Generate client libraries from server code"`
	Install   cmd.Install       `cmd:"" help:"Add the current VIIPER executable to system startup and runs it (creates a Systemd service on Linux)"`
	Uninstall cmd.Uninstall     `cmd:"" help:"Remove any VIIPER system startup configuration / Systemd service"`
}

CLI is the root command structure for Kong CLI parsing.

type Log

type Log struct {
	Level   string `help:"Log level: trace, debug, info, warn, error" default:"info" env:"VIIPER_LOG_LEVEL"`
	File    string `help:"Log file path (default: none; logs only to console)" env:"VIIPER_LOG_FILE"`
	RawFile string `help:"Raw packet log file path (default: none)" env:"VIIPER_LOG_RAW_FILE"`
}

type UpdateNotify added in v0.5.0

type UpdateNotify string
const (
	UpdateNotifyNone       UpdateNotify = "none"
	UpdateNotifyStable     UpdateNotify = "stable"
	UpdateNotifyPrerelease UpdateNotify = "prerelease"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL