Arg::display_order

display_order

since 0.1.0

Allows custom ordering of args within the help message.

Example

Spec

TOML

name = "prog"
[args]
boat = { short = 'b', long = "boat", action = "set", display-order = 0, help = "Some help and text" }
airplane = { short = 'a', long = "airplane", action = "set", display-order = 0, help = "I should be first!" }
custom-help = { short = '?', action = "help", display-order = 100, help = "Alt help" }

YAML

name: prog
args:
  boat:
    short: b
    long: boat
    action: set
    display-order: 0
    help: Some help and text
  airplane:
    short: a
    long: airplane
    action: set
    display-order: 0
    help: I should be first!
  custom-help:
    short: '?'
    action: help
    display-order: 100
    help: Alt help

JSON

{
  "name": "prog",
  "args": {
    "boat": {
      "short": "b",
      "long": "boat",
      "action": "set",
      "display-order": 0,
      "help": "Some help and text"
    },
    "airplane": {
      "short": "a",
      "long": "airplane",
      "action": "set",
      "display-order": 0,
      "help": "I should be first!"
    },
    "custom-help": {
      "short": "?",
      "action": "help",
      "display-order": 100,
      "help": "Alt help"
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
  -a, --airplane <airplane>  I should be first!
  -b, --boat <boat>          Some help and text
  -?                         Alt help
  -h, --help                 Print help