cli

Documentation

Overview

Package cli implements the command-line interface for envprof.

Index

• func Diff(options *Options) *cobra.Command
• func EnvProf(options *Options) (*envprof.EnvProf, error)
• func Exec(options *Options) *cobra.Command
• func Execute(version string) error
• func Export(options *Options) *cobra.Command
• func List(options *Options) *cobra.Command
• func LoadEnvProf(options *Options) (*envprof.EnvProf, error)
• func LoadPlan(options *Options) (profiles.Profiles, string, step.Steps, error)
• func LoadProfile(options *Options) (environment.Environment, error)
• func LoadProfiles(options *Options) (profiles.Profiles, error)
• func Merge(profile, environment env.Env, isolate, path bool, envs []string) env.Env
• func Path(options *Options) *cobra.Command
• func Profiles(options *Options) *cobra.Command
• func Shell(options *Options) *cobra.Command
• func UnknownSubcommandAction(cmd *cobra.Command, args []string) error
• func Write(options *Options) *cobra.Command
• type Options

Functions

func Diff

func Diff(options *Options) *cobra.Command

Diff returns the cobra command for diffing profiles.

func EnvProf

func EnvProf(options *Options) (*envprof.EnvProf, error)

EnvProf returns the envprof instance, resolving only the file path.

func Exec

func Exec(options *Options) *cobra.Command

Exec returns the cobra command for executing a command with the active environment.

func Execute

func Execute(version string) error

Execute runs the root command for the envprof CLI application.

func Export

func Export(options *Options) *cobra.Command

Export defines the command for exporting a profile's variables.

func List

func List(options *Options) *cobra.Command

List returns the cobra command for listing profiles and their variables.

func LoadEnvProf

func LoadEnvProf(options *Options) (*envprof.EnvProf, error)

LoadEnvProf returns the loaded envprof instance.

func LoadPlan

func LoadPlan(options *Options) (profiles.Profiles, string, step.Steps, error)

LoadPlan returns the plan for the specified profile.

func LoadProfile

func LoadProfile(options *Options) (environment.Environment, error)

LoadProfile returns the loaded and resolved profile.

func LoadProfiles

func LoadProfiles(options *Options) (profiles.Profiles, error)

LoadProfiles returns the existing profiles.

func Merge

func Merge(profile, environment env.Env, isolate, path bool, envs []string) env.Env

Merge merges the profile and environment based on isolation settings.

func Path

func Path(options *Options) *cobra.Command

Path returns the cobra command for displaying the path to the configuration file used.

func Profiles

func Profiles(options *Options) *cobra.Command

Profiles returns the cobra command for listing profiles.

func Shell

func Shell(options *Options) *cobra.Command

Shell returns the cobra command for entering a scoped shell with the active environment.

func UnknownSubcommandAction

func UnknownSubcommandAction(cmd *cobra.Command, args []string) error

UnknownSubcommandAction handles unknown cobra subcommands. Implements cobra.Command.RunE to provide helpful error messages and suggestions when an unknown subcommand is used. Required when TraverseChildren is true, as this disables cobra's built-in suggestion system. See: - https://github.com/spf13/cobra/issues/981 - https://github.com/containerd/nerdctl/blob/242e6fc6e861b61b878bd7df8bf25e95674c036d/cmd/nerdctl/main.go#L401-L418

func Write

func Write(options *Options) *cobra.Command

Write defines the command for writing profile variables to one or multiple dotenv files.

Types

type Options

type Options struct {
	// EnvProf is the list of candidate profile files to load.
	EnvProf []string
	// Profile is the selected profile.
	Profile string
	// Verbose enables verbose output.
	Verbose bool
	// Overlay contains the profiles to overlay on top of the current profile.
	Overlay []string
}

Options represents the root level configuration for the CLI application.