cli/command.go at develop · gxlb/cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package cli

// Command is a subcommand for a cli.App.
typeCommandstruct {
// The name of the command
Namestring
// A list of aliases for the command
Aliases []string
// A short description of the usage of this command
Usagestring
// Custom text to show on USAGE section of help
UsageTextstring
// A longer explanation of how the command works
Descriptionstring
// A short description of the arguments of this command
ArgsUsagestring
// The category the command is part of
Categorystring
// The function to call when checking for bash command completions
BashCompleteBashCompleteFunc
// An action to execute before any sub-subcommands are run, but after the context is ready
// If a non-nil error is returned, no sub-subcommands are run
BeforeBeforeFunc
// An action to execute after any subcommands are run, but after the subcommand has finished
// It is run even if Action() panics
AfterAfterFunc
// The function to call when this command is invoked
ActionActionFunc
// Execute this function if a usage error occurs.
OnUsageErrorOnUsageErrorFunc
// List of child commands
Subcommands []*Command
// List of flags to parse
Flags []Flag
// Treat all flags as normal arguments if true
SkipFlagParsingbool
// Boolean to hide built-in help command and help flag
HideHelpbool
// Boolean to hide built-in help command but keep help flag
// Ignored if HideHelp is true.
HideHelpCommandbool
// Boolean to hide this command from help or completion
Hiddenbool
// Boolean to enable short-option handling so user can combine several
// single-character bool arguments into one
// i.e. foobar -o -v -> foobar -ov
UseShortOptionHandlingbool

// Full name of command for help, defaults to full command name, including parent commands.
HelpNamestring
commandNamePath []string

// CustomHelpTemplate the text template for the command help topic.
// cli.go uses text/template to render templates. You can
// render custom help text by setting this variable.
CustomHelpTemplatestring
}