cli

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

Index

• func FilterTargets(targets []target.Target, arch, plat, targ string) []target.Target
• func SelectTarget(targets []target.Target) (target.Target, error)
• type CliOption
  • func WithDefaultConfigManager(cmd *cobra.Command) CliOption
  • func WithDefaultHTTPClient() CliOption
  • func WithDefaultIOStreams() CliOption
  • func WithDefaultLogger() CliOption
  • func WithDefaultPluginManager() CliOption
  • func WithHTTPClient(httpClient *http.Client) CliOption
• type CliOptions

Functions

func FilterTargets

func FilterTargets(targets []target.Target, arch, plat, targ string) []target.Target

FilterTargets returns a subset of `targets` based in input strings `arch`, `plat` and/or `targ`

func SelectTarget

func SelectTarget(targets []target.Target) (target.Target, error)

SelectTarget is a utility method used in a CLI context to prompt the user for a specific application's target.

Types

type CliOption

type CliOption func(*CliOptions) error

func WithDefaultConfigManager

func WithDefaultConfigManager(cmd *cobra.Command) CliOption

WithDefaultConfigManager instantiates a configuration manager based on default options.

func WithDefaultHTTPClient

func WithDefaultHTTPClient() CliOption

WithDefaultHTTPClient initializes a HTTP client using host-provided configuration.

func WithDefaultIOStreams

func WithDefaultIOStreams() CliOption

WithDefaultIOStreams instantiates ta new IO streams using environmental variables and host-provided configuration.

func WithDefaultLogger

func WithDefaultLogger() CliOption

WithDefaultLogger sets up the built in logger based on provided conifg found from the ConfigManager.

func WithDefaultPluginManager

func WithDefaultPluginManager() CliOption

WithDefaultPluginManager returns an initialized plugin manager using the host-provided configuration plugin path.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) CliOption

WithHTTPClient sets a previously instantiated http.Client to be used within the command.

type CliOptions

type CliOptions struct {
	IOStreams      *iostreams.IOStreams
	Logger         *logrus.Logger
	ConfigManager  *config.ConfigManager[config.KraftKit]
	PackageManager packmanager.PackageManager
	PluginManager  *plugins.PluginManager
	HTTPClient     *http.Client
}