Arg::requires

requires

since 0.1.0

Sets an argument that is required when this one is present.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", requires = "input", action = "set" }
input = {}

YAML

name: prog
args:
  cfg:
    long: config
    requires: input
    action: set
  input: {}

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "requires": "input",
      "action": "set"
    },
    "input": {}
  }
}

Input

prog

Output

Example 2

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", requires = "input", action = "set" }
input = {}

YAML

name: prog
args:
  cfg:
    long: config
    requires: input
    action: set
  input: {}

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "requires": "input",
      "action": "set"
    },
    "input": {}
  }
}

Input

prog --config file.conf

Output

error: the following required arguments were not provided:
  <input>

Usage: prog --config <cfg> <input>

For more information, try '--help'.