glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 22:57:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation for PostTerminatorArgs

Browse source
This commit is contained in:
malko 2023-03-30 02:03:08 +02:00
parent 94b8e4d5df
commit db7f74ab37
1 changed files with 23 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
user_guide.md
View file

@ -410,7 +410,7 @@ var cmd = &cobra.Command{
} }
``` ```
## Example ### Example
In the example below, we have defined three commands. Two are at the top level In the example below, we have defined three commands. Two are at the top level
and one (cmdTimes) is a child of one of the top commands. In this case the root and one (cmdTimes) is a child of one of the top commands. In this case the root
@ -480,6 +480,28 @@ a count and a string.`,
For a more complete example of a larger application, please checkout [Hugo](https://gohugo.io/). For a more complete example of a larger application, please checkout [Hugo](https://gohugo.io/).
### post arg terminator "--" args
By default args passed to the Run method will include arguments passed after
the arg terminator "--". You can change this behavior by setting the field
IgnorePostTerminatorArgs to true. You can retrieve these arguments easily by
calling the PostTerminatorArgs() method of the command. This can be useful when
calling child command from your program.
```go
var cmd = &cobra.Command{
Use: "exec",
IgnorePostTerminatorArgs: true,
Run: func(cmd *cobra.Command, args []string) {
bin := args[0]
//...pass all args after -- to the underlying command
cmd := exec.Command(bin, cmd.PostTerminatorArgs())
},
}
```
## Help Command ## Help Command
Cobra automatically adds a help command to your application when you have subcommands. Cobra automatically adds a help command to your application when you have subcommands.