config

Documentation

Index

• Variables
• func GenerateMarkdown(filePath string) error
• type Client
  • func NewClient(opts Options) (Client, error)
• type Options

Variables

var (
	NullClient  = Client{}
	NullOptions = Options{}
)

Functions

func GenerateMarkdown

func GenerateMarkdown(filePath string) error

GenerateMarkdown creates a markdown file with documentation for the application

Types

type Client

type Client struct {
	Address string
	Port    int
	// contains filtered or unexported fields
}

Client struct

func NewClient

func NewClient(opts Options) (Client, error)

NewClient returns the Client or error

type Options

type Options struct {
	Version  string
	Revision string
	Created  string
	// DisableExitOnHelp configures if --help should exit or not, used with helpPrinter()
	DisableExitOnHelp bool
}

Options takes the build information and provides the CLI with correct information