Arg::long

long

since 0.1.0

Sets the long version of the argument without the preceding --.

Examples

Example 1

Spec

TOML

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

YAML

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

JSON

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

Input

prog --config file.toml

Output

claptrap_cfg='file.toml'

Example 2

Spec

TOML

name = "prog"
[args]
mode = { long = "mode", value-name = "MODE", help = "Speed configuration", default-value = "fast", value-parser = [{ name = "fast" }, { name = "slow", help = "slower than fast" }] }

YAML

name: prog
args:
  mode:
    long: mode
    value-name: MODE
    help: Speed configuration
    default-value: fast
    value-parser:
    - name: fast
    - name: slow
      help: slower than fast

JSON

{
  "name": "prog",
  "args": {
    "mode": {
      "long": "mode",
      "value-name": "MODE",
      "help": "Speed configuration",
      "default-value": "fast",
      "value-parser": [
        {
          "name": "fast"
        },
        {
          "name": "slow",
          "help": "slower than fast"
        }
      ]
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
      --mode <MODE>
          Speed configuration

          Possible values:
          - fast
          - slow: slower than fast

          [default: fast]

  -h, --help
          Print help (see a summary with '-h')