PossibleValue::hide

hide

since 0.1.0

Hides this value from help and shell completions.

Example

Spec

TOML

name = "prog"
[args]
mode = { long = "mode", action = "set", value-parser = [{ name = "fast", alias = "speedy", help = "speedy" }, { name = "slow", help = "very slow", hide = true }, { name = "express", aliases = ["e", "exp"] }] }

YAML

name: prog
args:
  mode:
    long: mode
    action: set
    value-parser:
    - name: fast
      alias: speedy
      help: speedy
    - name: slow
      help: very slow
      hide: true
    - name: express
      aliases:
      - e
      - exp

JSON

{
  "name": "prog",
  "args": {
    "mode": {
      "long": "mode",
      "action": "set",
      "value-parser": [
        {
          "name": "fast",
          "alias": "speedy",
          "help": "speedy"
        },
        {
          "name": "slow",
          "help": "very slow",
          "hide": true
        },
        {
          "name": "express",
          "aliases": [
            "e",
            "exp"
          ]
        }
      ]
    }
  }
}

Input

prog --help

Output

Usage: prog [OPTIONS]

Options:
      --mode <mode>
          Possible values:
          - fast:    speedy
          - express

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