Arg::required

required

since 0.1.0

Specifies that the argument must be present.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", required = true, action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    required: true
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "required": true,
      "action": "set"
    }
  }
}

Input

prog --config file.conf

Output

claptrap_cfg='file.conf'

Example 2

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", required = true, action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    required: true
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "required": true,
      "action": "set"
    }
  }
}

Input

prog

Output

error: the following required arguments were not provided:
  --config <cfg>

Usage: prog --config <cfg>

For more information, try '--help'.