cli

Documentation

Overview

Package cli is the entrypoint to writing a custom CLI for a service built using the DC/OS SDK. It provides a number of standard subcommands that allow users to interact with their service.

Index

• func GetArguments() []string
• func GetModuleName() (string, error)
• func HandleDefaultSections(app *kingpin.Application)
• func New() *kingpin.Application

Functions

func GetArguments

func GetArguments() []string

GetArguments returns an array of the arguments passed into this CLI.

func GetModuleName

func GetModuleName() (string, error)

GetModuleName returns the module name, if it was passed in, or an error otherwise.

func HandleDefaultSections

func HandleDefaultSections(app *kingpin.Application)

HandleDefaultSections is a utility method to allow applications built around this library to provide all of the standard subcommands of the CLI.

func New

func New() *kingpin.Application

New instantiates a new kingpin.Application and returns a reference to it. This contains basic flags that are universally applicable, e.g. --name.