compflag

package

v2.0.1-alpha.12 Latest Latest Go to latest Published: Nov 27, 2019 License: MIT Imports: 7 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/posener/complete

Links

Open Source Insights

Documentation ¶

Overview ¶

Package compflag provides a handful of standard library-compatible flags with bash complition capabilities.

Usage

import "github.com/posener/complete/v2/compflag"

var (
	// Define flags...
	foo = compflag.String("foo", "", "")
)

func main() {
	compflag.Parse()
	// Main function.
}

Alternatively, the library can just be used with the standard library flag package:

import (
	"flag"
	"github.com/posener/complete/v2/compflag"
)

var (
	// Define flags...
	foo = compflag.String("foo", "", "")
	bar = flag.String("bar", "", "")
)

func main() {
	complete.CommandLine()
	flag.Parse()
	// Main function.
}

Index ¶

Variables
func Bool(name string, value bool, usage string, options ...predict.Option) *bool
func Duration(name string, value time.Duration, usage string, options ...predict.Option) *time.Duration
func Int(name string, value int, usage string, options ...predict.Option) *int
func Parse()
func String(name string, value string, usage string, options ...predict.Option) *string
type FlagSet

Constants ¶

This section is empty.

Variables ¶

View Source

var CommandLine = (*FlagSet)(flag.CommandLine)

Functions ¶

func Bool ¶

func Bool(name string, value bool, usage string, options ...predict.Option) *bool

func Duration ¶

func Duration(name string, value time.Duration, usage string, options ...predict.Option) *time.Duration

func Int ¶

func Int(name string, value int, usage string, options ...predict.Option) *int

func Parse ¶

func Parse()

Parse parses command line arguments. It also performs bash completion when needed.

func String ¶

func String(name string, value string, usage string, options ...predict.Option) *string

Types ¶

type FlagSet ¶

type FlagSet flag.FlagSet

FlagSet is bash completion enabled flag.FlagSet.

func (*FlagSet) Arg ¶

func (fs *FlagSet) Arg(i int) string

func (*FlagSet) Args ¶

func (fs *FlagSet) Args() []string

func (*FlagSet) Bool ¶

func (fs *FlagSet) Bool(name string, value bool, usage string, options ...predict.Option) *bool

func (*FlagSet) Complete ¶

func (fs *FlagSet) Complete()

Complete performs bash completion if needed.

func (*FlagSet) Duration ¶

func (fs *FlagSet) Duration(name string, value time.Duration, usage string, options ...predict.Option) *time.Duration

func (*FlagSet) Int ¶

func (fs *FlagSet) Int(name string, value int, usage string, options ...predict.Option) *int

func (*FlagSet) Lookup ¶

func (fs *FlagSet) Lookup(name string) *flag.Flag

func (*FlagSet) NArg ¶

func (fs *FlagSet) NArg() int

func (*FlagSet) NFlag ¶

func (fs *FlagSet) NFlag() int

func (*FlagSet) Name ¶

func (fs *FlagSet) Name() string

func (*FlagSet) Parse ¶

func (fs *FlagSet) Parse(args []string) error

Parse parses command line arguments.

func (*FlagSet) Parsed ¶

func (fs *FlagSet) Parsed() bool

func (*FlagSet) PrintDefaults ¶

func (fs *FlagSet) PrintDefaults()

func (*FlagSet) String ¶

func (fs *FlagSet) String(name string, value string, usage string, options ...predict.Option) *string

func (*FlagSet) Visit ¶

func (fs *FlagSet) Visit(fn func(*flag.Flag))

func (*FlagSet) VisitAll ¶

func (fs *FlagSet) VisitAll(fn func(*flag.Flag))

Source Files ¶

View all Source files

compflag.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL