urfavecli

Documentation

Overview

Package urfavecli contains utility functions for working with https://github.com/urfave/cli.

Index

• Constants
• func LogFlags(cliContext *cli.Context)

Constants

const MarkdownDocTemplate = `# NAME

{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }}

# SYNOPSIS

{{ .App.Name }}
{{ if .SynopsisArgs }}
` + "```" + `
{{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + `
{{ end }}{{ if .App.UsageText }}
# DESCRIPTION

{{ .App.UsageText }}
{{ end }}
**Usage**:

` + "```" + `
{{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
` + "```" + `
{{ if .GlobalArgs }}
# GLOBAL OPTIONS
{{ range $v := .GlobalArgs }}
{{ $v }}{{ end }}
{{ end }}{{ if .Commands }}
# COMMANDS
{{ range $v := .Commands }}
{{ $v }}{{ end }}{{ end }}`

MarkdownDocTemplate is a common template used to format commands as Markdown.

Functions

func LogFlags

func LogFlags(cliContext *cli.Context)

LogFlags reflects all the flags and their values as Info logs.

Should be called from within the Action of a Command after logging is setup.

Example

&cli.Command{
    Name:        "my-command",
    Action: func(c *cli.Context) error {
        urfavecli.LogFlags(c)
        // Do command stuff.
    },
},