Is a required ArgGroup only for the current SubCommand, or global?

[matthiasbeyer]

This is a bit unclear in the documentation (at least for me):

If I have an ArgGroup which is ::required(true) - does this mean this ArgGroup is required globally and a user must always provide these arguments? Or does it only apply to the SubCommand instance level above the ArgGroup instance?

E.G.:

App::new()
// ... args and subcommands
.subcommand(
    SubCommand::with_name("subcmd")
        .arg(Arg::with_name("foo")) // and more settings
        .arg(Arg::with_name("bar")) // and more settings
        .group(ArgGroup::new("foobar").args(&["foo", "bar"]).required(true))
)

Is "foo" or "bar" now enforced for app <flags>, or only for app subcmd <flags>?

---

If it is enforced globally: Feature request: flag for forcing ArgGroups only for the enclosing SubCommand.

[kbknapp]

@matthiasbeyer Sorry it took me so long to respond!

It means that either foo or bar must be present at runtime. It's a way of making one of the two args, but not both, be present. You can think of it like a "Make this arg required, if none of these other args are present" type setting.

Edit: And it's only for that subcommand instance, not the globally 😉

[matthiasbeyer]

And it's only for that subcommand instance, not the globally

Would be nice to state this explicitely in the docs! 👍

[kbknapp]

I'll mark this a docs update then, thanks for filing! 👍

[matthiasbeyer]

Thanks for your awesome support!