Skip to content

Commit

Permalink
Merge pull request #1653 from ovcharenko-di/issue_1593-v2-maint
Browse files Browse the repository at this point in the history
Doc:(issue_1593) Add flag category topic in docs (v2-maint)
  • Loading branch information
dearchap committed Jan 19, 2023
2 parents fc28a1c + 96569e6 commit 52ff0c6
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/v2/examples/flags.md
Expand Up @@ -230,6 +230,57 @@ That flag can then be set with `--lang spanish` or `-l spanish`. Note that
giving two different forms of the same flag in the same command invocation is an
error.

#### Grouping

You can associate a category for each flag to group them together in the help output, e.g:

```go
package main

import (
"log"
"os"

"github.com/urfave/cli/v2"
)

func main() {
app = &cli.App{
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "silent",
Aliases: []string{"s"},
Usage: "no messages",
Category: "Miscellaneous:",
},
&cli.BoolFlag{
Name: "perl-regexp",
Aliases: []string{"P"},
Usage: "PATTERNS are Perl regular expressions",
Category: "Pattern selection:",
},
},
}

if err := app.Run(os.Args); err != nil {
log.Fatal(err)
}
}
```

Will result in help output like:

```
GLOBAL OPTIONS:
Miscellaneous:
--silent, -s no messages (default: false)
Pattern selection:
--perl-regexp, -P PATTERNS are Perl regular expressions (default: false)
```

#### Ordering

Flags for the application and commands are shown in the order they are defined.
Expand Down

0 comments on commit 52ff0c6

Please sign in to comment.