argp – github.com/tdewolff/argp Index | Examples | Files | Directories

package argp

import "github.com/tdewolff/argp"

Index

Examples

Variables 

var ShowUsage error = fmt.Errorf("bad command usage")

ShowUsage can be returned from a command to show the help message.

Functions

func LoadConfigFile 

func LoadConfigFile(dst interface{}, filename string) error

LoadConfigFile loads .cf, .cfg, .toml, and .yaml files.

func TerminalSize 

func TerminalSize() (int, int, error)

func TypeName 

func TypeName(t reflect.Type) string

TypeName returns the type's name.

func UnmarshalConfig 

func UnmarshalConfig(b []byte, dst interface{}) error

UnmarshalConfig parses simple .cf or .cfg files.

Types

type Append 

type Append struct {
	I interface{}
}

Append is an option that appends to a slice, e.g. -a 5 -a 6 sets the value to [5 6]

func (Append) Help 

func (appnd Append) Help() (string, string)

func (Append) Scan 

func (appnd Append) Scan(name string, s []string) (int, error)

type Argp 

type Argp struct {
	Cmd
	Description string

	Error *log.Logger
	// contains filtered or unexported fields
}

Argp is a (sub) command parser

func New 

func New(description string) *Argp

New returns a new command parser that can set options and returns the remaining arguments from `Argp.Parse`.

func NewCmd 

func NewCmd(cmd Cmd, description string) *Argp

NewCmd returns a new command parser that invokes the Run method of the passed command structure. The `Argp.Parse()` function will not return and will call os.Exit() with 0, 1 or 2 as the argument.

func (*Argp) AddArg 

func (argp *Argp) AddArg(dst interface{}, name, description string)

AddArg adds an indexed value

func (*Argp) AddCmd 

func (argp *Argp) AddCmd(cmd Cmd, name, description string) *Argp

AddCmd adds a sub command

func (*Argp) AddOpt 

func (argp *Argp) AddOpt(dst interface{}, short, name string, description string)

AddOpt adds an option

func (*Argp) AddRest 

func (argp *Argp) AddRest(dst interface{}, name, description string)

func (*Argp) IsSet 

func (argp *Argp) IsSet(name string) bool

IsSet returns true if the option is set

func (*Argp) Parse 

func (argp *Argp) Parse()

Parse parses the command line arguments. When the main command was instantiated with `NewCmd`, this command will exit.

func (*Argp) PrintHelp 

func (argp *Argp) PrintHelp()

PrintHelp prints the help overview. This is automatically called when unknown or bad options are passed, but you can call this explicitly in other cases.

type Cmd 

type Cmd interface {
	Run() error
}

Cmd is a command

type Config 

type Config struct {
	Argp     *Argp
	Filename string
}

Config is an option that sets all options from a configuration file.

func (*Config) Help 

func (config *Config) Help() (string, string)

func (*Config) Scan 

func (config *Config) Scan(name string, s []string) (int, error)

type Count 

type Count struct {
	I interface{}
}

Count is a counting option, e.g. -vvv sets count to 3, or -v=3 sets it directly

Example

Code: 

{
	var count int
	argp := New("count variable")
	argp.AddOpt(Count{&count}, "c", "count", "")

	_, _, err := argp.parse([]string{"-ccc"})
	if err != nil {
		panic(err)
	}
	fmt.Println(count)
	// Output: 3
}

Output:

3

func (Count) Help 

func (count Count) Help() (string, string)

func (Count) Scan 

func (count Count) Scan(name string, s []string) (int, error)

type Custom 

type Custom interface {
	Help() (string, string)             // value and type representations for help
	Scan(string, []string) (int, error) // scan values from command line
}
Example

Code: 

{
	custom := CustomVar{}
	argp := New("custom variable")
	argp.AddOpt(&custom, "", "custom", "")

	_, _, err := argp.parse([]string{"--custom", "1", "/", "2"})
	if err != nil {
		panic(err)
	}
	fmt.Println(custom.Num, "/", custom.Div)
	// Output: 1 / 2
}

Output:

1 / 2

type Dict 

type Dict struct {
	DictSource
	Sources map[string]DictSourceFunc
	Values  []string
}

Dict is an option that loads key-value map from a source (such as mysql).

func NewDict 

func NewDict(values []string) *Dict

func (*Dict) AddSource 

func (dict *Dict) AddSource(typ string, f DictSourceFunc)

func (*Dict) Close 

func (dict *Dict) Close() error

func (*Dict) Help 

func (dict *Dict) Help() (string, string)

func (*Dict) Scan 

func (dict *Dict) Scan(name string, s []string) (int, error)

func (*Dict) Valid 

func (dict *Dict) Valid() bool

type DictSource 

type DictSource interface {
	Has(string) (bool, error)
	Get(string) (string, error)
	Close() error
}

func NewFileDict 

func NewFileDict(s []string) (DictSource, error)

func NewInlineDict 

func NewInlineDict(s []string) (DictSource, error)

func NewStaticDict 

func NewStaticDict(s []string) (DictSource, error)

type DictSourceFunc 

type DictSourceFunc func([]string) (DictSource, error)

type FileDict 

type FileDict struct {
	InlineDict
}

type FileList 

type FileList struct {
	InlineList
}

type InlineDict 

type InlineDict struct {
	// contains filtered or unexported fields
}

func (*InlineDict) Close 

func (t *InlineDict) Close() error

func (*InlineDict) Get 

func (t *InlineDict) Get(key string) (string, error)

func (*InlineDict) Has 

func (t *InlineDict) Has(key string) (bool, error)

type InlineList 

type InlineList struct {
	// contains filtered or unexported fields
}

func (*InlineList) Close 

func (t *InlineList) Close() error

func (*InlineList) Has 

func (t *InlineList) Has(val string) (bool, error)

func (*InlineList) List 

func (t *InlineList) List() ([]string, error)

type List 

type List struct {
	ListSource
	Sources map[string]ListSourceFunc
	Values  []string
}

List is an option that loads a list of values from a source (such as mysql).

func NewList 

func NewList(values []string) *List

func (*List) AddSource 

func (list *List) AddSource(typ string, f ListSourceFunc)

func (*List) Close 

func (list *List) Close() error

func (*List) Help 

func (list *List) Help() (string, string)

func (*List) Scan 

func (list *List) Scan(name string, s []string) (int, error)

func (*List) Valid 

func (list *List) Valid() bool

type ListSource 

type ListSource interface {
	Has(string) (bool, error)
	List() ([]string, error)
	Close() error
}

func NewFileList 

func NewFileList(s []string) (ListSource, error)

func NewInlineList 

func NewInlineList(s []string) (ListSource, error)

type ListSourceFunc 

type ListSourceFunc func([]string) (ListSource, error)

type SQLDict 

type SQLDict struct {
	// contains filtered or unexported fields
}

func NewSQLDict 

func NewSQLDict(db *sqlx.DB, query string) (*SQLDict, error)

func (*SQLDict) Close 

func (t *SQLDict) Close() error

func (*SQLDict) Get 

func (t *SQLDict) Get(key string) (string, error)

func (*SQLDict) Has 

func (t *SQLDict) Has(key string) (bool, error)

type SQLList 

type SQLList struct {
	// contains filtered or unexported fields
}

func NewSQLList 

func NewSQLList(db *sqlx.DB, query, queryHas string, cacheDur time.Duration) (*SQLList, error)

func (*SQLList) Close 

func (t *SQLList) Close() error

func (*SQLList) Has 

func (t *SQLList) Has(val string) (bool, error)

func (*SQLList) List 

func (t *SQLList) List() ([]string, error)

type StaticDict 

type StaticDict struct {
	// contains filtered or unexported fields
}

func (*StaticDict) Close 

func (t *StaticDict) Close() error

func (*StaticDict) Get 

func (t *StaticDict) Get(key string) (string, error)

func (*StaticDict) Has 

func (t *StaticDict) Has(key string) (bool, error)

type Var 

type Var struct {
	Value       reflect.Value
	Name        string
	Short       rune // 0 if not used
	Index       int  // -1 if not used
	Rest        bool
	Default     interface{} // nil is not used
	Description string
	// contains filtered or unexported fields
}

Var is a command option or argument

func (*Var) IsArgument 

func (v *Var) IsArgument() bool

IsArgument returns true for an argument

func (*Var) IsOption 

func (v *Var) IsOption() bool

IsOption returns true for an option

func (*Var) Set 

func (v *Var) Set(i interface{}) bool

Set sets the variable's value

Source Files

argp.go config.go custom.go dict.go list.go term_posix.go util.go

Directories

PathSynopsis
cmd
cmd/test
Version
v0.0.0-20250325153840-ab3be54df185 (latest)
Published
Mar 25, 2025
Platform
js/wasm
Imports
19 packages
Last checked
now –

Tools for package owners.