Arg::value_hint

value_hint

since 0.1.0

Provide the shell a hint about how to complete this argument.

Example

Spec

TOML

name = "prog"
[args]
command = { short = 'u', long = 'username', value-hint = "username" }

YAML

name: prog
args:
  command:
    short: u
    long: username
    value-hint: username

JSON

{
  "name": "prog",
  "args": {
    "command": {
      "short": "u",
      "long": "username",
      "value-hint": "username"
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
  -u, --username <command>
  -h, --help                Print help