args

Documentation

Overview

Package args handles parsing command line arguments.

Index

• func Parse(ctx context.Context) context.Context
• func Usage()
• type ContextCfg
• type Options
  • func GetOptions(ctx context.Context) Options

Functions

func Parse

func Parse(ctx context.Context) context.Context

Parse reads any command line arguments given and acts on them.

func Usage

func Usage()

Usage displays the usage information.

Types

type ContextCfg

type ContextCfg string

ContextCfg is the key used when getting/setting the Options struct from the context object.

type Options

type Options struct {
	// Log defines the logging level that should be used.
	Log string
	// Version displays the version information and exits.
	Version bool
}

Options contains all supported cmd line arguments.

func GetOptions

func GetOptions(ctx context.Context) Options

GetOptions fetches the stored configuration settings from the context.